OCI CLI Command Reference
3.43.1
  • Oracle Cloud Infrastructure (oci)
  • Access Governance (access-governance-cp)
  • Analytics (analytics)
  • Announcements Service (announce)
  • Anomaly Detection (anomaly-detection)
  • API Gateway (api-gateway)
  • Application Dependency Management (adm)
  • Application Performance Monitoring Configuration (apm-config)
  • Application Performance Monitoring Control Plane (apm-control-plane)
  • Application Performance Monitoring Synthetic Monitoring (apm-synthetics)
  • Application Performance Monitoring Trace Explorer (apm-traces)
  • Artifacts and Container Images (artifacts)
  • Audit (audit)
  • Autoscaling (autoscaling)
  • Bastion (bastion)
  • Big Data Service (bds)
  • Block Volume Service (bv)
  • Blockchain Platform Control Plane (blockchain)
  • Budgets (budgets)
  • Certificates Service Management (certs-mgmt)
  • Certificates Service Retrieval (certificates)
  • Cloud Advisor (optimizer)
  • Cloud Guard and Security Zones (cloud-guard)
  • Cluster Placement Groups (cpg)
  • Compute Cloud@Customer (ccc)
  • Compute Instance Agent Service (instance-agent)
  • Compute Management Service (compute-management)
  • Compute Service (compute)
    • Description
    • Available Commands
      • boot-volume-attachment
      • capacity-reservation
      • capacity-topology
      • compute-capacity-report
      • compute-cluster
      • console-history
      • dedicated-vm-host
      • dedicated-vm-host-instance
      • device
      • global-image-capability-schema
      • global-image-capability-schema-version
      • image
      • image-capability-schema
      • image-shape-compatibility-entry
      • instance
      • instance-console-connection
        • Description
        • Available Commands
      • instance-maintenance-reboot
      • measured-boot-report
      • pic
      • shape
      • vnic-attachment
      • volume-attachment
  • Connector Hub (sch)
  • Container Engine for Kubernetes (ce)
  • Container Instance (container-instances)
  • Dashboards (dashboard-service)
  • Data Catalog (data-catalog)
  • Data Flow (data-flow)
  • Data Integration (data-integration)
  • Data Labeling (data-labeling-service-dataplane)
  • Data Labeling Management (data-labeling-service)
  • Data Safe (data-safe)
  • Data Science (data-science)
  • Data Transfer Service (dts)
  • Database Management (database-management)
  • Database Migration (database-migration)
  • Database Service (db)
  • Database Tools (dbtools)
  • DevOps (devops)
  • Digital Assistant Service Instance (oda)
  • DNS (dns)
  • Document Understanding (ai-document)
  • EM Warehouse (em-warehouse)
  • Email Delivery (email)
  • Email Delivery Submission (email-data-plane)
  • Events (events)
  • Exadata Fleet Update service (fleet-software-update)
  • File Storage (fs)
  • Full Stack Disaster Recovery (disaster-recovery)
  • Functions Service (fn)
  • Fusion Applications Environment Management (fusion-apps)
  • Generative AI Service Inference (generative-ai-inference)
  • Generative AI Service Management (generative-ai)
  • Globally Distributed Database (gdd)
  • GoldenGate (goldengate)
  • GovernanceRulesControlPlane (governance-rules-control-plane)
  • Health Checks (health-checks)
  • Identity and Access Management Service (iam)
  • Identity Domains (identity-domains)
  • Java Management Service (jms)
  • Java Management Service Download (jms-java-downloads)
  • Key Management (kms)
  • Language (ai)
  • License Manager (license-manager)
  • Load Balancing (lb)
  • LogAnalytics (log-analytics)
  • Logging Ingestion (logging-ingestion)
  • Logging Management (logging)
  • Logging Search (logging-search)
  • Makes a raw request against an OCI service (raw-request)
  • Managed Access (oma)
  • Management Agent (management-agent)
  • ManagementDashboard (management-dashboard)
  • Marketplace Service (marketplace)
  • MarketplacePrivateOffer (marketplace-private-offer)
  • MarketplacePublisherService (marketplace-publisher)
  • Media Services (media-services)
  • Monitoring (monitoring)
  • MySQL Database Service (mysql)
  • Network Firewall (network-firewall)
  • Network Monitoring (vn-monitoring)
  • Networking Service (network)
  • NetworkLoadBalancer (nlb)
  • None (session)
  • None (setup)
  • NoSQL Database (nosql)
  • Notifications (ons)
  • Object Storage Service (os)
  • OCI Control Center (occ)
  • OCI Control Center Demand Signal (demand-signal)
  • OciControlCenterCp (capacity-management)
  • OneSubscription Billing Schedule (osub-billing-schedule)
  • OneSubscription Subscription, Commitment and and Rate Card Details (osub-subscription)
  • OneSubscription Usage Computation (osub-usage)
  • OneSubscription (onesubscription)
  • OneSubscription Gateway Organization's Subscription (osub-organization-subscription)
  • OpenSearch Service (opensearch)
  • Operations Insights (opsi)
  • OperatorAccessControl (opctl)
  • Oracle Cloud Bridge (cloud-bridge)
  • Oracle Cloud Migrations (cloud-migrations)
  • Oracle Cloud VMware Solution (ocvs)
  • Oracle Content and Experience (oce)
  • Oracle Database Autonomous Recovery Service (recovery)
  • Oracle Integration (integration)
  • Organizations (organizations)
  • OS Management (os-management)
  • OS Management Hub (os-management-hub)
  • OSP Gateway (osp-gateway)
  • PGSQL Control Plane (psql)
  • Process Automation (opa)
  • Queue (queue)
  • Redis Service (redis)
  • Resource Discovery and Monitoring Control (appmgmt-control)
  • Resource Manager (resource-manager)
  • Resource Scheduler (resource-scheduler)
  • RoverCloudService (rover)
  • Scanning (vulnerability-scanning)
  • Search Service (search)
  • Secure Desktops (desktops)
  • Service Catalog (service-catalog)
  • Service Limits (limits)
  • Service Manager Proxy (service-manager-proxy)
  • Service Mesh (service-mesh)
  • Speech (speech)
  • Stack Monitoring (stack-monitoring)
  • Streaming (streaming)
  • Support Management (support)
  • Threat Intelligence (threat-intelligence)
  • Usage (usage-api)
  • Usage Proxy (usage)
  • Vault Secret Management (vault)
  • Vault Secret Retrieval (secrets)
  • VB Studio Controlplane Instance API (vbstudio)
  • Vision (ai-vision)
  • Visual Builder (visual-builder)
  • Web Application Acceleration (WAA) (waa)
  • Web Application Acceleration and Security Services (waas)
  • Web Application Firewall (WAF) (waf)
  • Work Requests (work-requests)
OCI CLI Command Reference
  • Docs »
  • compute »
  • instance-console-connection »
  • get-plink-connection-string
  • View page source

get-plink-connection-string¶

  • Description

  • Usage

  • Required Parameters

  • Optional Parameters

  • Global Parameters

  • Example using required parameter

Description¶

Gets the plink command for starting an SSH tunnel on Windows which will allow VNC connections to the instance. Once you have started the tunnel, you can point your VNC client to localhost:{–local-vnc-port} to connect to the instance (default –local-vnc-port is 5900).

Usage¶

oci compute instance-console-connection get-plink-connection-string [OPTIONS]

Required Parameters¶

--instance-console-connection-id [text]¶

The OCID of the intance console connection

--private-key-file [text]¶

The path to the private key to be used for authentication. This is inserted into the generated connection string.

Optional Parameters¶

--from-json [text]¶

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--local-vnc-port [text]¶

This is the local port that you will point your VNC client at. This will be forwarded to the SSH tunnel created by executing the PowerShell command in the output. Default is 5900.

--ssh-proxy-port [text]¶

This is the local and remote port for the SSH tunnel. This may be any open port on your local machine. Default is 5905.

Global Parameters¶

Use oci --help for help on global parameters.

--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --cli-rc-file, --config-file, --connection-timeout, --debug, --defaults-file, --endpoint, --generate-full-command-json-input, --generate-param-json-input, --help, --latest-version, --max-retries, --no-retry, --opc-client-request-id, --opc-request-id, --output, --profile, --proxy, --query, --raw-output, --read-timeout, --realm-specific-endpoint, --region, --release-info, --request-id, --version, -?, -d, -h, -i, -v

Example using required parameter¶

Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.

    export cidr_block=<substitute-value-of-cidr_block> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/network/vcn/create.html#cmdoption-cidr-block
    export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/network/vcn/create.html#cmdoption-compartment-id
    export availability_domain=<substitute-value-of-availability_domain> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/compute/instance/launch.html#cmdoption-availability-domain
    export image_id=<substitute-value-of-image_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/compute/instance/launch.html#cmdoption-image-id
    export ssh_public_key_file=<substitute-value-of-ssh_public_key_file> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/compute/instance-console-connection/create.html#cmdoption-ssh-public-key-file
    export private_key_file=<substitute-value-of-private_key_file> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/compute/instance-console-connection/get-plink-connection-string.html#cmdoption-private-key-file

    vcn_id=$(oci network vcn create --cidr-block $cidr_block --compartment-id $compartment_id --query data.id --raw-output)

    subnet_id=$(oci network subnet create --cidr-block $cidr_block --compartment-id $compartment_id --vcn-id $vcn_id --query data.id --raw-output)

    instance_id=$(oci compute instance launch --availability-domain $availability_domain --compartment-id $compartment_id --image-id $image_id --subnet-id $subnet_id --query data.id --raw-output)

    instance_console_connection_id=$(oci compute instance-console-connection create --instance-id $instance_id --ssh-public-key-file $ssh_public_key_file --query data.id --raw-output)

    oci compute instance-console-connection get-plink-connection-string --instance-console-connection-id $instance_console_connection_id --private-key-file $private_key_file
Next Previous

© Copyright 2016, 2024, Oracle

Built with Sphinx using a theme provided by Read the Docs.