NETWORK_FAST-CONNECT-PROVIDER-SERVICE-KEY(1)

NAME
network_fast-connect-provider-service-key -

DESCRIPTION

A provider service key and its details. A provider service key is an identifier for a provider’s virtual circuit.

AVAILABLE COMMANDS

•   get

  get

•   Description

•   Usage

•   Required Parameters

•   Optional Parameters

•   Global Parameters

•   Examples

  Description

Gets the specified provider service key’s information. Use this operation to validate a provider service key. An invalid key returns a 404 error.

  Usage

oci network fast-connect-provider-service-key get [OPTIONS]

  Required Parameters

--provider-service-id [text]

    The OCID <https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm> of the provider service.

--provider-service-key-name [text]

    The provider service key that the provider gives you when you set up a virtual circuit connection from the provider to Oracle Cloud Infrastructure. You can set up that connection and get your provider service key at the provider’s website or portal. For the portal location, see the description attribute of the FastConnectProviderService <https://docs.cloud.oracle.com/api/#/en/iaas/latest/FastConnectProviderService/>.

  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

  Global Parameters

Use oci --help for help on global parameters.

--auth-purpose, --auth, --cert-bundle, --cli-rc-file, --config-file, --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, --query, --raw-output, --region, --release-info, --request-id, --version, -?, -d, -h, -v

  Examples

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 <https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm#configfile> and appropriate security policies <https://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/policygetstarted.htm> before trying the examples.

    export provider_service_id=<substitute-value-of-provider_service_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/network/fast-connect-provider-service-key/get.html#cmdoption-provider-service-id
    export provider_service_key_name=<substitute-value-of-provider_service_key_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/network/fast-connect-provider-service-key/get.html#cmdoption-provider-service-key-name
    oci network fast-connect-provider-service-key get --provider-service-id $provider_service_id --provider-service-key-name $provider_service_key_name

AUTHOR
Oracle

COPYRIGHT
2016, 2021, Oracle