NAME

network_tunnel-route -

DESCRIPTION

A summary of the routes advertised to and received from the on-premises network.

AVAILABLE COMMANDS

•: list-ip-sec-connection

list-ip-sec-connection

Description
Usage
Required Parameters
Optional Parameters
Global Parameters
Examples

Description

The routes advertised to the on-premises network and the routes received from the on-premises network.

Usage

oci network tunnel-route list-ip-sec-connection [OPTIONS]

Required Parameters

--ipsc-id [text]

The OCID <https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm> of the IPSec connection.

--tunnel-id [text]

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

Optional Parameters

--advertiser [text]

Specifies the advertiser of the routes. If set to ORACLE, this returns only the routes advertised by Oracle. When set to CUSTOMER, this returns only the routes advertised by the CPE.

Accepted values are:

CUSTOMER, ORACLE

--all

Fetches all pages of results. If you provide this option, then you cannot provide the --limit option.

--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

--limit [integer]

For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination <https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine>.

Example:

--page [text]

For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination <https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine>.

--page-size [integer]

When fetching results, the number of results to fetch per call. Only valid when used with --all or --limit, and ignored otherwise.

Global Parameters

Use oci --help for help on global parameters.

--auth-purpose, --auth, --cert-bundle, --cli-auto-prompt, --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, -i, -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 ipsc_id=<substitute-value-of-ipsc_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/network/tunnel-route/list-ip-sec-connection.html#cmdoption-ipsc-id
    export tunnel_id=<substitute-value-of-tunnel_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/network/tunnel-route/list-ip-sec-connection.html#cmdoption-tunnel-id
    oci network tunnel-route list-ip-sec-connection --ipsc-id $ipsc_id --tunnel-id $tunnel_id

AUTHOR

Oracle

COPYRIGHT

2016, 2022, Oracle