oracle.oci.oci_network_vcn_topology_facts – Fetches details about a VcnTopology resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.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_network_vcn_topology_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about a VcnTopology resource in Oracle Cloud Infrastructure

  • Gets a virtual network topology for a given VCN.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
access_level
string
    Choices:
  • ANY
  • ACCESSIBLE
Valid values are `ANY` and `ACCESSIBLE`. The default is `ANY`. Setting this to `ACCESSIBLE` returns only compartments for which a user has INSPECT permissions, either directly or indirectly (permissions can be on a resource in a subcompartment). A restricted set of fields is returned for compartments in which a user has indirect INSPECT permissions.
When set to `ANY` permissions are not checked.
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.
cache_control
string
The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses.
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 / required
The OCID of the compartment.
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.
query_compartment_subtree
boolean
    Choices:
  • no
  • yes
When set to true, the hierarchy of compartments is traversed and the specified compartment and its subcompartments are inspected depending on the the setting of `accessLevel`. Default is false.
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.
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
vcn_id
string / required
The OCID of the VCN.

Examples

- name: Get a specific vcn_topology
  oci_network_vcn_topology_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    vcn_id: "ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    access_level: ANY
    query_compartment_subtree: true
    cache_control: cache_control_example

Return Values

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

Key Returned Description
vcn_topology
complex
on success
VcnTopology resource

Sample:
{'entities': [], 'relationships': [{'associated_with_details': {'via': []}, 'id1': 'id1_example', 'id2': 'id2_example', 'route_rule_details': {'destination': 'destination_example', 'destination_type': 'destination_type_example', 'route_table_id': 'ocid1.routetable.oc1..xxxxxxEXAMPLExxxxxx', 'route_type': 'STATIC'}, 'type': 'CONTAINS'}], 'time_created': '2013-10-20T19:20:30+01:00', 'type': 'NETWORKING', 'vcn_id': 'ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx'}
 
entities
list / elements=string
on success
Lists entities comprising the virtual network topology.

 
relationships
complex
on success
Lists relationships between entities in the virtual network topology.

   
associated_with_details
complex
on success

     
via
list / elements=string
on success
The OCID of the entities via which the relationship is created. For example an instance is associated with a network security group via the VNIC attachment and the VNIC.

   
id1
string
on success
The OCID of the first entity in the relationship.

Sample:
id1_example
   
id2
string
on success
The OCID of the second entity in the relationship.

Sample:
id2_example
   
route_rule_details
complex
on success

     
destination
string
on success
An IP address range in CIDR notation or the `cidrBlock` value for a Service.

Sample:
destination_example
     
destination_type
string
on success
The destinationType can be set to one of two values:
* Use `CIDR_BLOCK` if the rule's `destination` is an IP address range in CIDR notation.
* Use `SERVICE_CIDR_BLOCK` if the rule's `destination` is the `cidrBlock` value for a Service.

Sample:
destination_type_example
     
route_table_id
string
on success
The OCID of the routing table that contains the route rule.

Sample:
ocid1.routetable.oc1..xxxxxxEXAMPLExxxxxx
     
route_type
string
on success
A route rule can be `STATIC` if manually added to the route table or `DYNAMIC` if imported from another route table.

Sample:
STATIC
   
type
string
on success
The type of relationship between the entities.

Sample:
CONTAINS
 
time_created
string
on success
Records when the virtual network topology was created, in RFC3339 format for date and time.

Sample:
2013-10-20T19:20:30+01:00
 
type
string
on success
Type of the topology object.

Sample:
NETWORKING
 
vcn_id
string
on success
The OCID of the VCN for which the topology is generated.

Sample:
ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx


Authors

  • Oracle (@oracle)