oracle.oci.oci_vn_monitoring_path_analyzer_test – Manage a PathAnalyzerTest resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_vn_monitoring_path_analyzer_test.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a PathAnalyzerTest resource in Oracle Cloud Infrastructure

  • For state=present, creates a new PathAnalyzerTest resource.

  • This resource has the following action operations in the oracle.oci.oci_vn_monitoring_path_analyzer_test_actions module: change_compartment.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
string
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 config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
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 config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
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 config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in 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 config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see 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 auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle
string
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.
compartment_id
string
The OCID for the `PathAnalyzerTest` resource's compartment.
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
config_file_location
string
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.
config_profile_name
string
The profile to load from the config file referenced by 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 config_file_location.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
destination_endpoint
dictionary
Required for create using state=present.
This parameter is updatable.
address
string
The IPv4 address of the COMPUTE_INSTANCE-type `Endpoint` object.
Required when type is one of ['SUBNET', 'COMPUTE_INSTANCE', 'VNIC', 'IP_ADDRESS', 'VLAN']
instance_id
string
The OCID of the compute instance.
Required when type is 'COMPUTE_INSTANCE'
listener_id
string
The OCID of the network load balancer listener.
Required when type is one of ['NETWORK_LOAD_BALANCER_LISTENER', 'LOAD_BALANCER_LISTENER']
load_balancer_id
string
The OCID of the load balancer.
Required when type is one of ['LOAD_BALANCER', 'LOAD_BALANCER_LISTENER']
network_load_balancer_id
string
The OCID of the listener's network load balancer.
Required when type is one of ['NETWORK_LOAD_BALANCER_LISTENER', 'NETWORK_LOAD_BALANCER']
subnet_id
string
The OCID of the subnet containing the IP address. This can be used to disambiguate which subnet is intended, in case the IP address is used in more than one subnet (when there are subnets with overlapping IP ranges).
Required when type is 'SUBNET'
type
string / required
    Choices:
  • NETWORK_LOAD_BALANCER_LISTENER
  • COMPUTE_INSTANCE
  • NETWORK_LOAD_BALANCER
  • LOAD_BALANCER
  • VNIC
  • IP_ADDRESS
  • VLAN
  • SUBNET
  • LOAD_BALANCER_LISTENER
The type of the `Endpoint`.
vlan_id
string
The OCID of the VLAN containing the IP address. This can be used to disambiguate which VLAN is queried, in case the endpoint IP address belongs to more than one VLAN (when there are VLANs with overlapping IP ranges).
Required when type is 'VLAN'
vnic_id
string
The OCID of the VNIC attached to the compute instance.
Required when type is one of ['COMPUTE_INSTANCE', 'VNIC']
display_name
string
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Required for create, update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: name
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags
dictionary
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
This parameter is updatable.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
path_analyzer_test_id
string
The OCID of the `PathAnalyzerTest` resource.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
protocol
integer
The IP protocol to use in the `PathAnalyzerTest` resource.
Required for create using state=present.
This parameter is updatable.
protocol_parameters
dictionary
This parameter is updatable.
destination_port
integer
The destination port to use in a `PathAnalyzerTest` resource.
Required when type is one of ['UDP', 'TCP']
icmp_code
integer
The ICMP code.
Applicable when type is 'ICMP'
icmp_type
integer
The ICMP type.
Required when type is 'ICMP'
source_port
integer
The source port to use in a `PathAnalyzerTest` resource.
Applicable when type is one of ['UDP', 'TCP']
type
string / required
    Choices:
  • UDP
  • TCP
  • ICMP
The type of the `ProtocolParameters` object.
query_options
dictionary
This parameter is updatable.
is_bi_directional_analysis
boolean
    Choices:
  • no
  • yes
If true, a path analysis is done for both the forward and reverse routes.
region
string
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 config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
source_endpoint
dictionary
Required for create using state=present.
This parameter is updatable.
address
string
The IPv4 address of the COMPUTE_INSTANCE-type `Endpoint` object.
Required when type is one of ['SUBNET', 'COMPUTE_INSTANCE', 'VNIC', 'IP_ADDRESS', 'VLAN']
instance_id
string
The OCID of the compute instance.
Required when type is 'COMPUTE_INSTANCE'
listener_id
string
The OCID of the network load balancer listener.
Required when type is one of ['NETWORK_LOAD_BALANCER_LISTENER', 'LOAD_BALANCER_LISTENER']
load_balancer_id
string
The OCID of the load balancer.
Required when type is one of ['LOAD_BALANCER', 'LOAD_BALANCER_LISTENER']
network_load_balancer_id
string
The OCID of the listener's network load balancer.
Required when type is one of ['NETWORK_LOAD_BALANCER_LISTENER', 'NETWORK_LOAD_BALANCER']
subnet_id
string
The OCID of the subnet containing the IP address. This can be used to disambiguate which subnet is intended, in case the IP address is used in more than one subnet (when there are subnets with overlapping IP ranges).
Required when type is 'SUBNET'
type
string / required
    Choices:
  • NETWORK_LOAD_BALANCER_LISTENER
  • COMPUTE_INSTANCE
  • NETWORK_LOAD_BALANCER
  • LOAD_BALANCER
  • VNIC
  • IP_ADDRESS
  • VLAN
  • SUBNET
  • LOAD_BALANCER_LISTENER
The type of the `Endpoint`.
vlan_id
string
The OCID of the VLAN containing the IP address. This can be used to disambiguate which VLAN is queried, in case the endpoint IP address belongs to more than one VLAN (when there are VLANs with overlapping IP ranges).
Required when type is 'VLAN'
vnic_id
string
The OCID of the VNIC attached to the compute instance.
Required when type is one of ['COMPUTE_INSTANCE', 'VNIC']
state
string
    Choices:
  • present ←
  • absent
The state of the PathAnalyzerTest.
Use state=present to create or update a PathAnalyzerTest.
Use state=absent to delete a PathAnalyzerTest.
tenancy
string
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 config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create path_analyzer_test
  oci_vn_monitoring_path_analyzer_test:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    protocol: 56
    source_endpoint:
      # required
      network_load_balancer_id: "ocid1.networkloadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
      type: NETWORK_LOAD_BALANCER_LISTENER
      listener_id: "ocid1.listener.oc1..xxxxxxEXAMPLExxxxxx"
    destination_endpoint:
      # required
      network_load_balancer_id: "ocid1.networkloadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
      type: NETWORK_LOAD_BALANCER_LISTENER
      listener_id: "ocid1.listener.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    protocol_parameters:
      # required
      destination_port: 56
      type: UDP

      # optional
      source_port: 56
    query_options:
      # optional
      is_bi_directional_analysis: true
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update path_analyzer_test
  oci_vn_monitoring_path_analyzer_test:
    # required
    path_analyzer_test_id: "ocid1.pathanalyzertest.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    protocol: 56
    source_endpoint:
      # required
      network_load_balancer_id: "ocid1.networkloadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
      type: NETWORK_LOAD_BALANCER_LISTENER
      listener_id: "ocid1.listener.oc1..xxxxxxEXAMPLExxxxxx"
    destination_endpoint:
      # required
      network_load_balancer_id: "ocid1.networkloadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
      type: NETWORK_LOAD_BALANCER_LISTENER
      listener_id: "ocid1.listener.oc1..xxxxxxEXAMPLExxxxxx"
    protocol_parameters:
      # required
      destination_port: 56
      type: UDP

      # optional
      source_port: 56
    query_options:
      # optional
      is_bi_directional_analysis: true
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update path_analyzer_test using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_vn_monitoring_path_analyzer_test:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    protocol: 56
    source_endpoint:
      # required
      network_load_balancer_id: "ocid1.networkloadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
      type: NETWORK_LOAD_BALANCER_LISTENER
      listener_id: "ocid1.listener.oc1..xxxxxxEXAMPLExxxxxx"
    destination_endpoint:
      # required
      network_load_balancer_id: "ocid1.networkloadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
      type: NETWORK_LOAD_BALANCER_LISTENER
      listener_id: "ocid1.listener.oc1..xxxxxxEXAMPLExxxxxx"
    protocol_parameters:
      # required
      destination_port: 56
      type: UDP

      # optional
      source_port: 56
    query_options:
      # optional
      is_bi_directional_analysis: true
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete path_analyzer_test
  oci_vn_monitoring_path_analyzer_test:
    # required
    path_analyzer_test_id: "ocid1.pathanalyzertest.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete path_analyzer_test using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_vn_monitoring_path_analyzer_test:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
path_analyzer_test
complex
on success
Details of the PathAnalyzerTest resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'destination_endpoint': {'address': 'address_example', 'instance_id': 'ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx', 'listener_id': 'ocid1.listener.oc1..xxxxxxEXAMPLExxxxxx', 'load_balancer_id': 'ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx', 'network_load_balancer_id': 'ocid1.networkloadbalancer.oc1..xxxxxxEXAMPLExxxxxx', 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'type': 'IP_ADDRESS', 'vlan_id': 'ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx', 'vnic_id': 'ocid1.vnic.oc1..xxxxxxEXAMPLExxxxxx'}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'ACTIVE', 'protocol': 56, 'protocol_parameters': {'destination_port': 56, 'icmp_code': 56, 'icmp_type': 56, 'source_port': 56, 'type': 'TCP'}, 'query_options': {'is_bi_directional_analysis': True}, 'source_endpoint': {'address': 'address_example', 'instance_id': 'ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx', 'listener_id': 'ocid1.listener.oc1..xxxxxxEXAMPLExxxxxx', 'load_balancer_id': 'ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx', 'network_load_balancer_id': 'ocid1.networkloadbalancer.oc1..xxxxxxEXAMPLExxxxxx', 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'type': 'IP_ADDRESS', 'vlan_id': 'ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx', 'vnic_id': 'ocid1.vnic.oc1..xxxxxxEXAMPLExxxxxx'}, 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00'}
 
compartment_id
string
on success
The OCID of the `PathAnalyzerTest` resource's compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
destination_endpoint
complex
on success

   
address
string
on success
The IPv4 address of the COMPUTE_INSTANCE-type `Endpoint` object.

Sample:
address_example
   
instance_id
string
on success
The OCID of the compute instance.

Sample:
ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx
   
listener_id
string
on success
The OCID of the load balancer listener.

Sample:
ocid1.listener.oc1..xxxxxxEXAMPLExxxxxx
   
load_balancer_id
string
on success
The OCID of the load balancer.

Sample:
ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx
   
network_load_balancer_id
string
on success
The OCID of the network load balancer.

Sample:
ocid1.networkloadbalancer.oc1..xxxxxxEXAMPLExxxxxx
   
subnet_id
string
on success
The OCID of the subnet containing the IP address. This can be used to disambiguate which subnet is intended, in case the IP address is used in more than one subnet (when there are subnets with overlapping IP ranges).

Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
   
type
string
on success
The type of the `Endpoint`.

Sample:
IP_ADDRESS
   
vlan_id
string
on success
The OCID of the VLAN containing the IP address. This can be used to disambiguate which VLAN is queried, in case the endpoint IP address belongs to more than one VLAN (when there are VLANs with overlapping IP ranges).

Sample:
ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx
   
vnic_id
string
on success
The OCID of the VNIC attached to the compute instance.

Sample:
ocid1.vnic.oc1..xxxxxxEXAMPLExxxxxx
 
display_name
string
on success
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
A unique identifier established when the resource is created. The identifier can't be changed later.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The current state of the `PathAnalyzerTest` resource.

Sample:
ACTIVE
 
protocol
integer
on success
The IP protocol to use for the `PathAnalyzerTest` resource.

Sample:
56
 
protocol_parameters
complex
on success

   
destination_port
integer
on success
The destination port to use in a `PathAnalyzerTest` resource.

Sample:
56
   
icmp_code
integer
on success
The ICMP code.

Sample:
56
   
icmp_type
integer
on success
The ICMP type.

Sample:
56
   
source_port
integer
on success
The source port to use in a `PathAnalyzerTest` resource.

Sample:
56
   
type
string
on success
The type of the `ProtocolParameters` object.

Sample:
TCP
 
query_options
complex
on success

   
is_bi_directional_analysis
boolean
on success
If true, a path analysis is done for both the forward and reverse routes.

Sample:
True
 
source_endpoint
complex
on success

   
address
string
on success
The IPv4 address of the COMPUTE_INSTANCE-type `Endpoint` object.

Sample:
address_example
   
instance_id
string
on success
The OCID of the compute instance.

Sample:
ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx
   
listener_id
string
on success
The OCID of the load balancer listener.

Sample:
ocid1.listener.oc1..xxxxxxEXAMPLExxxxxx
   
load_balancer_id
string
on success
The OCID of the load balancer.

Sample:
ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx
   
network_load_balancer_id
string
on success
The OCID of the network load balancer.

Sample:
ocid1.networkloadbalancer.oc1..xxxxxxEXAMPLExxxxxx
   
subnet_id
string
on success
The OCID of the subnet containing the IP address. This can be used to disambiguate which subnet is intended, in case the IP address is used in more than one subnet (when there are subnets with overlapping IP ranges).

Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
   
type
string
on success
The type of the `Endpoint`.

Sample:
IP_ADDRESS
   
vlan_id
string
on success
The OCID of the VLAN containing the IP address. This can be used to disambiguate which VLAN is queried, in case the endpoint IP address belongs to more than one VLAN (when there are VLANs with overlapping IP ranges).

Sample:
ocid1.vlan.oc1..xxxxxxEXAMPLExxxxxx
   
vnic_id
string
on success
The OCID of the VNIC attached to the compute instance.

Sample:
ocid1.vnic.oc1..xxxxxxEXAMPLExxxxxx
 
system_tags
dictionary
on success
Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

 
time_created
string
on success
The date and time the `PathAnalyzerTest` resource was created, in the format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The date and time the `PathAnalyzerTest` resource was last updated, in the format defined by RFC3339.

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)