oracle.oci.oci_network_drg_route_rules_actions – Perform actions on a DrgRouteRules 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_drg_route_rules_actions.

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a DrgRouteRules resource in Oracle Cloud Infrastructure

  • For action=add, adds one or more static route rules to the specified DRG route table.

  • For action=remove, removes one or more route rules from the specified DRG route table.

  • For action=update, updates one or more route rules in the specified DRG route table.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • add
  • remove
  • update
The action to perform on the DrgRouteRules.
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.
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.
drg_route_table_id
string / required
The OCID of the DRG route table.

aliases: id
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.
route_rule_ids
list / elements=string
The Oracle-assigned ID of each DRG route rule to be deleted.
Applicable only for action=remove.
route_rules
list / elements=dictionary
The collection of static rules used to insert routes into the DRG route table.
Applicable only for action=addaction=update.
destination
string
This is the range of IP addresses used for matching when routing traffic. Only CIDR_BLOCK values are allowed.
Potential values: * IP address range in CIDR notation. This can be an IPv4 or IPv6 CIDR. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`.
destination_type
string
    Choices:
  • CIDR_BLOCK
Type of destination for the rule. Required if `direction` = `EGRESS`. Allowed values: * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation.
id
string
The Oracle-assigned ID of each DRG route rule to update.
next_hop_drg_attachment_id
string
The OCID of the next hop DRG attachment. The next hop DRG attachment is responsible for reaching the network destination.
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

Examples

- name: Perform action add on drg_route_rules
  oci_network_drg_route_rules_actions:
    # required
    drg_route_table_id: "ocid1.drgroutetable.oc1..xxxxxxEXAMPLExxxxxx"
    action: add

    # optional
    route_rules:
    - # optional
      id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
      destination: destination_example
      destination_type: CIDR_BLOCK
      next_hop_drg_attachment_id: "ocid1.nexthopdrgattachment.oc1..xxxxxxEXAMPLExxxxxx"

- name: Perform action remove on drg_route_rules
  oci_network_drg_route_rules_actions:
    # required
    drg_route_table_id: "ocid1.drgroutetable.oc1..xxxxxxEXAMPLExxxxxx"
    action: remove

    # optional
    route_rule_ids: [ "route_rule_ids_example" ]

- name: Perform action update on drg_route_rules
  oci_network_drg_route_rules_actions:
    # required
    drg_route_table_id: "ocid1.drgroutetable.oc1..xxxxxxEXAMPLExxxxxx"
    action: update

    # optional
    route_rules:
    - # optional
      id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
      destination: destination_example
      destination_type: CIDR_BLOCK
      next_hop_drg_attachment_id: "ocid1.nexthopdrgattachment.oc1..xxxxxxEXAMPLExxxxxx"

Return Values

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

Key Returned Description
drg_route_rules
complex
on success
Details of the DrgRouteRules resource acted upon by the current operation

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'}
 
attributes
dictionary
on success
Additional properties for the route, computed by the service.

 
destination
string
on success
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 Service. For example: `oci-phx-objectstorage`.

Sample:
destination_example
 
destination_type
string
on success
The type of destination for the rule. the type is required if `direction` = `EGRESS`.
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 Service (the rule is for traffic destined for a particular `Service` through a service gateway).

Sample:
CIDR_BLOCK
 
id
string
on success
The Oracle-assigned ID of the DRG route rule.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_blackhole
boolean
on success
Indicates that if the next hop attachment does not exist, so traffic for this route is discarded without notification.

Sample:
True
 
is_conflict
boolean
on success
Indicates that the route was not imported due to a conflict between route rules.

Sample:
True
 
next_hop_drg_attachment_id
string
on success
The OCID 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.

Sample:
ocid1.nexthopdrgattachment.oc1..xxxxxxEXAMPLExxxxxx
 
route_provenance
string
on success
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.

Sample:
STATIC
 
route_type
string
on success
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.

Sample:
STATIC


Authors

  • Oracle (@oracle)