bulk-add

Description

Adds one or more customer public IP prefixes to the specified public virtual circuit. Use this operation (and not UpdateVirtualCircuit) to add prefixes to the virtual circuit. Oracle must verify the customer’s ownership of each prefix before traffic for that prefix will flow across the virtual circuit.

Usage

oci network virtual-circuit-public-prefix bulk-add [OPTIONS]

Required Parameters

--public-prefixes [complex type]

The public IP prefixes (CIDRs) to add to the public virtual circuit. This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--virtual-circuit-id [text]

The OCID of the virtual circuit.

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

Examples

Copy and paste the following example into a JSON file, replacing the example parameters with your own.

    oci network virtual-circuit-public-prefix bulk-add --generate-param-json-input public-prefixes > public-prefixes.json

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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/network/virtual-circuit/create.html#cmdoption-compartment-id
    export type=<substitute-value-of-type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/network/virtual-circuit/create.html#cmdoption-type

    virtual_circuit_id=$(oci network virtual-circuit create --compartment-id $compartment_id --type $type --query data.id --raw-output)

    oci network virtual-circuit-public-prefix bulk-add --public-prefixes file://public-prefixes.json --virtual-circuit-id $virtual_circuit_id