Try SpotterFetches details about one or multiple DrgRouteRules resources 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 one or multiple DrgRouteRules resources in Oracle Cloud Infrastructure
Lists the route rules in the specified DRG route table.
- name: List drg_route_rules
oci_network_drg_route_rules_facts:
# required
drg_route_table_id: "ocid1.drgroutetable.oc1..xxxxxxEXAMPLExxxxxx"
# optional
route_type: STATIC
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
route_type:
choices:
- STATIC
- DYNAMIC
description:
- Static routes are specified through the DRG route table API. Dynamic routes are
learned by the DRG from the DRG attachments through various routing protocols.
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
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
drg_route_table_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the DRG route table.
required: true
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
drg_route_rules:
contains:
attributes:
description:
- Additional properties for the route, computed by the service.
returned: on success
sample: {}
type: dict
destination:
description:
- Represents the range of IP addresses to match against when routing traffic.
- 'Potential values: * An IP address range (IPv4 or IPv6) in CIDR notation.
For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`. * When you''re
setting up a security rule for traffic destined for a particular `Service`
through a service gateway, this is the `cidrBlock` value associated with that
L(Service,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/iaas/20160918/Service/).
For example: `oci-phx-objectstorage`.'
returned: on success
sample: destination_example
type: str
destination_type:
description:
- The type of destination for the rule.
- 'Allowed values:'
- ' * `CIDR_BLOCK`: If the rule''s `destination` is an IP address range in CIDR
notation. * `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/)
(the rule is for traffic destined for a particular `Service` through a service
gateway).'
returned: on success
sample: CIDR_BLOCK
type: str
id:
description:
- The Oracle-assigned ID of the DRG route rule.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
is_blackhole:
description:
- Indicates that if the next hop attachment does not exist, so traffic for this
route is discarded without notification.
returned: on success
sample: true
type: bool
is_conflict:
description:
- Indicates that the route was not imported due to a conflict between route
rules.
returned: on success
sample: true
type: bool
next_hop_drg_attachment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the next hop DRG attachment responsible for reaching the network destination.
- A value of `BLACKHOLE` means traffic for this route is discarded without notification.
returned: on success
sample: ocid1.nexthopdrgattachment.oc1..xxxxxxEXAMPLExxxxxx
type: str
route_provenance:
description:
- The earliest origin of a route. If a route is advertised to a DRG through
an IPsec tunnel attachment, and is propagated to peered DRGs via RPC attachments,
the route's provenance in the peered DRGs remains `IPSEC_TUNNEL`, because
that is the earliest origin.
- No routes with a provenance `IPSEC_TUNNEL` or `VIRTUAL_CIRCUIT` will be exported
to IPsec tunnel or virtual circuit attachments, regardless of the attachment's
export distribution.
returned: on success
sample: STATIC
type: str
route_type:
description:
- You can specify static routes for the DRG route table using the API. The DRG
learns dynamic routes from the DRG attachments using various routing protocols.
returned: on success
sample: STATIC
type: str
description:
- List of DrgRouteRules resources
returned: on success
sample:
- attributes: {}
destination: destination_example
destination_type: CIDR_BLOCK
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
is_blackhole: true
is_conflict: true
next_hop_drg_attachment_id: ocid1.nexthopdrgattachment.oc1..xxxxxxEXAMPLExxxxxx
route_provenance: STATIC
route_type: STATIC
type: complex