oracle / oracle.oci / 4.43.0 / module / oci_network_vtap_facts Fetches details about one or multiple Vtap resources in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_network_vtap_facts (4.43.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.43.0
collections: - name: oracle.oci version: 4.43.0
Fetches details about one or multiple Vtap resources in Oracle Cloud Infrastructure
Lists the virtual test access points (VTAPs) in the specified compartment.
If I(vtap_id) is specified, the details of a single Vtap will be returned.
- name: Get a specific vtap oci_network_vtap_facts: # required vtap_id: "ocid1.vtap.oc1..xxxxxxEXAMPLExxxxxx"
- name: List vtaps oci_network_vtap_facts: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" # optional vcn_id: "ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx" source: source_example target_id: "ocid1.target.oc1..xxxxxxEXAMPLExxxxxx" target_ip: target_ip_example is_vtap_enabled: true sort_by: TIMECREATED sort_order: ASC display_name: display_name_example lifecycle_state: PROVISIONING
region: description: - The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See C(config_file_location)). Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm) for more information on OCI regions. type: str source: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VTAP source. type: str vcn_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN. type: str sort_by: choices: - TIMECREATED - DISPLAYNAME description: - 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.' type: str tenancy: description: - OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See C(config_file_location)). To get the tenancy OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm) type: str vtap_id: aliases: - id description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VTAP. - Required to get a specific vtap. type: str api_user: description: - The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See C(config_file_location)). To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal - security_token default: api_key description: - The type of authentication to use for making API requests. By default C(auth_type="api_key") based authentication is performed and the API key (see I(api_user_key_file)) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use C(auth_type="instance_principal") to use instance principal based authentication when running ansible playbooks within an OCI compute instance. type: str target_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VTAP target. type: str target_ip: description: - The IP address of the VTAP target. type: str sort_order: choices: - ASC - DESC description: - The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. type: str cert_bundle: description: - The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used. type: str auth_purpose: choices: - service_principal description: - The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None. type: str display_name: aliases: - name description: - A filter to return only resources that match the given display name exactly. type: str compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. - Required to list multiple vtaps. type: str is_vtap_enabled: description: - 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`).' type: bool lifecycle_state: choices: - PROVISIONING - AVAILABLE - UPDATING - TERMINATING - TERMINATED description: - A filter to return only resources that match the given VTAP administrative lifecycle state. The state value is case-insensitive. type: str api_user_key_file: description: - Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See C(config_file_location)). If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option must also be provided. type: str config_profile_name: description: - The profile to load from the config file referenced by C(config_file_location). If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in C(config_file_location). type: str api_user_fingerprint: description: - Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See C(config_file_location)). To get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str config_file_location: description: - Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config. type: str api_user_key_pass_phrase: description: - Passphrase used by the key referenced in C(api_user_key_file), if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See C(config_file_location)). type: str realm_specific_endpoint_template_enabled: description: - Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used. type: bool
vtaps: contains: capture_filter_id: description: - The capture filter's Oracle ID (L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)). returned: on success sample: ocid1.capturefilter.oc1..xxxxxxEXAMPLExxxxxx type: str compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the `Vtap` resource. returned: on success sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx type: str defined_tags: description: - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). - 'Example: `{"Operations": {"CostCenter": "42"}}`' returned: on success sample: Operations: CostCenter: US type: dict display_name: description: - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. returned: on success sample: display_name_example type: str encapsulation_protocol: description: - Defines an encapsulation header type for the VTAP's mirrored traffic. returned: on success sample: VXLAN type: str freeform_tags: description: - 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 L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). - 'Example: `{"Department": "Finance"}`' returned: on success sample: Department: Finance type: dict id: description: - The VTAP's Oracle ID (L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)). returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str is_vtap_enabled: description: - 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.' returned: on success sample: true type: bool lifecycle_state: description: - The VTAP's administrative lifecycle state. returned: on success sample: PROVISIONING type: str lifecycle_state_details: description: - The VTAP's current running state. returned: on success sample: RUNNING type: str max_packet_size: description: - The maximum size of the packets to be included in the filter. returned: on success sample: 56 type: int source_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the source point where packets are captured. returned: on success sample: ocid1.source.oc1..xxxxxxEXAMPLExxxxxx type: str source_private_endpoint_ip: description: - The IP Address of the source private endpoint. returned: on success sample: source_private_endpoint_ip_example type: str source_private_endpoint_subnet_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet that source private endpoint belongs to. returned: on success sample: ocid1.sourceprivateendpointsubnet.oc1..xxxxxxEXAMPLExxxxxx type: str source_type: description: - The source type for the VTAP. returned: on success sample: VNIC type: str target_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the destination resource where mirrored packets are sent. returned: on success sample: ocid1.target.oc1..xxxxxxEXAMPLExxxxxx type: str target_ip: description: - The IP address of the destination resource where mirrored packets are sent. returned: on success sample: target_ip_example type: str target_type: description: - The target type for the VTAP. returned: on success sample: VNIC type: str time_created: description: - The date and time the VTAP was created, in the format defined by L(RFC3339,https://tools.ietf.org/html/rfc3339). - 'Example: `2020-08-25T21:10:29.600Z`' returned: on success sample: '2013-10-20T19:20:30+01:00' type: str traffic_mode: description: - Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT returned: on success sample: DEFAULT type: str vcn_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN containing the `Vtap` resource. returned: on success sample: ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx type: str vxlan_network_identifier: description: - The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN. returned: on success sample: 56 type: int description: - List of Vtap resources returned: on success sample: - capture_filter_id: ocid1.capturefilter.oc1..xxxxxxEXAMPLExxxxxx compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx defined_tags: Operations: CostCenter: US display_name: display_name_example encapsulation_protocol: VXLAN freeform_tags: Department: Finance id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx is_vtap_enabled: true lifecycle_state: PROVISIONING lifecycle_state_details: RUNNING max_packet_size: 56 source_id: ocid1.source.oc1..xxxxxxEXAMPLExxxxxx source_private_endpoint_ip: source_private_endpoint_ip_example source_private_endpoint_subnet_id: ocid1.sourceprivateendpointsubnet.oc1..xxxxxxEXAMPLExxxxxx source_type: VNIC target_id: ocid1.target.oc1..xxxxxxEXAMPLExxxxxx target_ip: target_ip_example target_type: VNIC time_created: '2013-10-20T19:20:30+01:00' traffic_mode: DEFAULT vcn_id: ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx vxlan_network_identifier: 56 type: complex