list

Description

Lists the virtual test access points (VTAPs) in the specified compartment.

Usage

oci network vtap list [OPTIONS]

Required Parameters

--compartment-id, -c [text]

The OCID of the compartment.

Optional Parameters

--all

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

--display-name [text]

A filter to return only resources that match the given display name exactly.

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

Indicates whether to list all VTAPs or only running VTAPs.

  • When FALSE, lists ALL running and stopped VTAPs. * When TRUE, lists only running VTAPs (VTAPs where isVtapEnabled = TRUE).

--lifecycle-state [text]

A filter to return only resources that match the given VTAP administrative lifecycle state. The state value is case-insensitive.

Accepted values are:

AVAILABLE, PROVISIONING, TERMINATED, TERMINATING, UPDATING
--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.

Example:

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

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

--sort-by [text]

The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

Accepted values are:

DISPLAYNAME, TIMECREATED
--sort-order [text]

The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

Accepted values are:

ASC, DESC
--source [text]

The OCID of the VTAP source.

--target-id [text]

The OCID of the VTAP target.

--target-ip [text]

The IP address of the VTAP target.

--vcn-id [text]

The OCID of the VCN.

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/vtap/list.html#cmdoption-compartment-id

    oci network vtap list --compartment-id $compartment_id