create

Description

Creates a virtual test access point (VTAP) in the specified compartment.

For the purposes of access control, you must provide the OCID of the compartment that contains the VTAP. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.

You may optionally specify a display name for the VTAP, otherwise a default is provided. It does not have to be unique, and you can change it.

Usage

oci network vtap create [OPTIONS]

Required Parameters

--capture-filter-id [text]

The capture filter’s Oracle ID (OCID).

--compartment-id, -c [text]

The OCID of the compartment containing the Vtap resource.

--source-id [text]

The OCID of the source point where packets are captured.

--vcn-id [text]

The OCID of the VCN containing the Vtap resource.

Optional Parameters

--defined-tags [complex type]

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example:

{"Operations": {"CostCenter": "42"}}

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.

--display-name [text]

A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

--encapsulation-protocol [text]

Defines an encapsulation header type for the VTAP’s mirrored traffic.

Accepted values are:

VXLAN

--freeform-tags [complex type]

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example:

{"Department": "Finance"}

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.

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

--is-vtap-enabled [boolean]

Used to start or stop a Vtap resource.

• TRUE directs the VTAP to start mirroring traffic. * FALSE (Default) directs the VTAP to stop mirroring traffic.

--max-packet-size [integer]

The maximum size of the packets to be included in the filter.

--max-wait-seconds [integer]

The maximum time to wait for the resource to reach the lifecycle state defined by --wait-for-state. Defaults to 1200 seconds.

--source-private-endpoint-ip [text]

The IP Address of the source private endpoint.

--source-private-endpoint-subnet-id [text]

The OCID of the subnet that source private endpoint belongs to.

--source-type [text]

The source type for the VTAP.

Accepted values are:

AUTONOMOUS_DATA_WAREHOUSE, DB_SYSTEM, EXADATA_VM_CLUSTER, LOAD_BALANCER, SUBNET, VNIC

--target-id [text]

The OCID of the destination resource where mirrored packets are sent.

--target-ip [text]

The IP address of the destination resource where mirrored packets are sent.

--target-type [text]

The target type for the VTAP.

Accepted values are:

IP_ADDRESS, NETWORK_LOAD_BALANCER, VNIC

--traffic-mode [text]

Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT

Accepted values are:

DEFAULT, PRIORITY

--vxlan-network-identifier [integer]

The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN.

--wait-for-state [text]

This operation creates, modifies or deletes a resource that has a defined lifecycle state. Specify this option to perform the action and then wait until the resource reaches a given lifecycle state. Multiple states can be specified, returning on the first state. For example, --wait-for-state SUCCEEDED --wait-for-state FAILED would return on whichever lifecycle state is reached first. If timeout is reached, a return code of 2 is returned. For any other error, a return code of 1 is returned.

Accepted values are:

AVAILABLE, PROVISIONING, TERMINATED, TERMINATING, UPDATING

--wait-interval-seconds [integer]

Check every --wait-interval-seconds to see whether the resource has reached the lifecycle state defined by --wait-for-state. Defaults to 30 seconds.

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 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 filter_type=<substitute-value-of-filter_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/network/capture-filter/create.html#cmdoption-filter-type
    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 source_id=<substitute-value-of-source_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/network/vtap/create.html#cmdoption-source-id

    capture_filter_id=$(oci network capture-filter create --compartment-id $compartment_id --filter-type $filter_type --query data.id --raw-output)

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

    oci network vtap create --capture-filter-id $capture_filter_id --compartment-id $compartment_id --source-id $source_id --vcn-id $vcn_id