oracle.oci.oci_network_drg_attachment_facts – Fetches details about one or multiple DrgAttachment resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.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_drg_attachment_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple DrgAttachment resources in Oracle Cloud Infrastructure
Lists the DrgAttachment resource for the specified compartment. You can filter the results by DRG, attached network, attachment type, DRG route table or VCN route table.
The LIST API lists DRG attachments by attachment type. It will default to list VCN attachments, but you may request to list ALL attachments of ALL types.
If drg_attachment_id is specified, the details of a single DrgAttachment will be returned.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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 ). |
|
attachment_type
string
|
|
The type for the network resource attached to the DRG.
|
auth_purpose
string
|
|
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
|
|
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 of the compartment.
Required to list multiple drg_attachments.
|
|
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 . |
|
display_name
string
|
A filter to return only resources that match the given display name exactly.
aliases: name |
|
drg_attachment_id
string
|
The OCID of the DRG attachment.
Required to get a specific drg_attachment.
aliases: id |
|
drg_id
string
|
The OCID of the DRG.
|
|
drg_route_table_id
string
|
The OCID of the DRG route table assigned to the DRG attachment.
|
|
lifecycle_state
string
|
|
A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
|
network_id
string
|
The OCID of the resource (virtual circuit, VCN, IPSec tunnel, or remote peering connection) attached to the DRG.
|
|
realm_specific_endpoint_template_enabled
boolean
|
|
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.
|
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. |
|
sort_by
string
|
|
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.
|
sort_order
string
|
|
The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive.
|
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
|
The OCID of the VCN.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific drg_attachment
oci_network_drg_attachment_facts:
# required
drg_attachment_id: "ocid1.drgattachment.oc1..xxxxxxEXAMPLExxxxxx"
- name: List drg_attachments
oci_network_drg_attachment_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
vcn_id: "ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx"
drg_id: "ocid1.drg.oc1..xxxxxxEXAMPLExxxxxx"
network_id: "ocid1.network.oc1..xxxxxxEXAMPLExxxxxx"
attachment_type: VCN
drg_route_table_id: "ocid1.drgroutetable.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
sort_by: TIMECREATED
sort_order: ASC
lifecycle_state: ATTACHING
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
drg_attachments
complex
|
on success |
List of DrgAttachment resources
Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'drg_id': 'ocid1.drg.oc1..xxxxxxEXAMPLExxxxxx', 'drg_route_table_id': 'ocid1.drgroutetable.oc1..xxxxxxEXAMPLExxxxxx', 'export_drg_route_distribution_id': 'ocid1.exportdrgroutedistribution.oc1..xxxxxxEXAMPLExxxxxx', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_cross_tenancy': True, 'lifecycle_state': 'ATTACHING', 'network_details': {'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'ipsec_connection_id': 'ocid1.ipsecconnection.oc1..xxxxxxEXAMPLExxxxxx', 'route_table_id': 'ocid1.routetable.oc1..xxxxxxEXAMPLExxxxxx', 'type': 'VCN', 'vcn_route_type': 'VCN_CIDRS'}, 'route_table_id': 'ocid1.routetable.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00', 'vcn_id': 'ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx'}]
|
||
compartment_id
string
|
on success |
The OCID of the compartment containing the DRG attachment.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
defined_tags
dictionary
|
on success |
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||
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
|
||
drg_id
string
|
on success |
The OCID of the DRG.
Sample:
ocid1.drg.oc1..xxxxxxEXAMPLExxxxxx
|
||
drg_route_table_id
string
|
on success |
The OCID of the DRG route table that is assigned to this attachment.
The DRG route table manages traffic inside the DRG.
Sample:
ocid1.drgroutetable.oc1..xxxxxxEXAMPLExxxxxx
|
||
export_drg_route_distribution_id
string
|
on success |
The OCID of the export route distribution used to specify how routes in the assigned DRG route table are advertised to the attachment. If this value is null, no routes are advertised through this attachment.
Sample:
ocid1.exportdrgroutedistribution.oc1..xxxxxxEXAMPLExxxxxx
|
||
freeform_tags
dictionary
|
on success |
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 Resource Tags.
Example: `{"Department": "Finance"}`
Sample:
{'Department': 'Finance'}
|
||
id
string
|
on success |
The DRG attachment's Oracle ID (OCID).
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
is_cross_tenancy
boolean
|
on success |
Indicates whether the DRG attachment and attached network live in a different tenancy than the DRG.
Example: `false`
Sample:
True
|
||
lifecycle_state
string
|
on success |
The DRG attachment's current state.
Sample:
ATTACHING
|
||
network_details
complex
|
on success |
|
||
id
string
|
on success |
The OCID of the network attached to the DRG.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
ipsec_connection_id
string
|
on success |
The IPSec connection that contains the attached IPSec tunnel.
Sample:
ocid1.ipsecconnection.oc1..xxxxxxEXAMPLExxxxxx
|
||
route_table_id
string
|
on success |
The OCID of the route table the DRG attachment is using.
For information about why you would associate a route table with a DRG attachment, see:
* Transit Routing: Access to Multiple VCNs in Same Region * Transit Routing: Private Access to Oracle Services
Sample:
ocid1.routetable.oc1..xxxxxxEXAMPLExxxxxx
|
||
type
string
|
on success |
Sample:
VCN
|
||
vcn_route_type
string
|
on success |
Indicates whether the VCN CIDRs or the individual subnet CIDRs are imported from the attachment. Routes from the VCN ingress route table are always imported.
Sample:
VCN_CIDRS
|
||
route_table_id
string
|
on success |
The OCID of the route table the DRG attachment is using.
For information about why you would associate a route table with a DRG attachment, see:
* Transit Routing: Access to Multiple VCNs in Same Region * Transit Routing: Private Access to Oracle Services
This field is deprecated. Instead, use the `networkDetails` field to view the OCID of the attached resource.
Sample:
ocid1.routetable.oc1..xxxxxxEXAMPLExxxxxx
|
||
time_created
string
|
on success |
The date and time the DRG attachment was created, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`
Sample:
2013-10-20T19:20:30+01:00
|
||
vcn_id
string
|
on success |
The OCID of the VCN. This field is deprecated. Instead, use the `networkDetails` field to view the OCID of the attached resource.
Sample:
ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx
|
Authors¶
Oracle (@oracle)