Try SpotterFetches details about a SubnetTopology resource in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0Fetches details about a SubnetTopology resource in Oracle Cloud Infrastructure
Gets a topology for a given subnet.
- name: Get a specific subnet_topology
oci_network_subnet_topology_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
# optional
access_level: ANY
query_compartment_subtree: true
cache_control: cache_control_example
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
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
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
subnet_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the subnet.
required: true
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
access_level:
choices:
- ANY
- ACCESSIBLE
description:
- 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.
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
cache_control:
description:
- The Cache-Control HTTP header holds directives (instructions) for caching in both
requests and responses.
type: str
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the compartment.
required: true
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
query_compartment_subtree:
description:
- 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.
type: bool
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
subnet_topology:
contains:
entities:
description:
- Lists entities comprising the virtual network topology.
returned: on success
sample: []
type: list
limited_entities:
description:
- 'Lists entities that are limited during ingestion. The values for the items
in the list are the entity type names of the limitedEntities. Example: `vcn`'
returned: on success
sample: []
type: list
relationships:
contains:
associated_with_details:
contains:
via:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
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.
returned: on success
sample: []
type: list
description:
- ''
returned: on success
type: complex
id1:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the first entity in the relationship.
returned: on success
sample: id1_example
type: str
id2:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the second entity in the relationship.
returned: on success
sample: id2_example
type: str
route_rule_details:
contains:
destination:
description:
- An IP address range in CIDR notation or the `cidrBlock` value for
a L(Service,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/iaas/latest/Service/).
returned: on success
sample: destination_example
type: str
destination_type:
description:
- '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 L(Service,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Service/).'
returned: on success
sample: destination_type_example
type: str
route_table_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the routing table that contains the route rule.
returned: on success
sample: ocid1.routetable.oc1..xxxxxxEXAMPLExxxxxx
type: str
route_type:
description:
- A route rule can be `STATIC` if manually added to the route table
or `DYNAMIC` if imported from another route table.
returned: on success
sample: STATIC
type: str
description:
- ''
returned: on success
type: complex
type:
description:
- The type of relationship between the entities.
returned: on success
sample: CONTAINS
type: str
description:
- Lists relationships between entities in the virtual network topology.
returned: on success
type: complex
subnet_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the subnet for which the visualization is generated.
returned: on success
sample: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
type: str
time_created:
description:
- Records when the virtual network topology was created, in L(RFC3339,https://tools.ietf.org/html/rfc3339)
format for date and time.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
type:
description:
- Type of the topology object.
returned: on success
sample: NETWORKING
type: str
description:
- SubnetTopology resource
returned: on success
sample:
entities: []
limited_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
subnet_id: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
time_created: '2013-10-20T19:20:30+01:00'
type: NETWORKING
type: complex