oracle.oci.oci_network_drg_route_distribution_statements_actions – Perform actions on a DrgRouteDistributionStatements resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a DrgRouteDistributionStatements resource in Oracle Cloud Infrastructure

  • For action=add, adds one or more route distribution statements to the specified route distribution.

  • For action=remove, removes one or more route distribution statements from the specified route distribution’s map.

  • For action=update, updates one or more route distribution statements in the specified route distribution.

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 DrgRouteDistributionStatements.
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_distribution_id
string / required
The OCID of the route distribution.

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.
statement_ids
list / elements=string
The Oracle-assigned ID of each route distribution to remove.
Applicable only for action=remove.
statements
list / elements=dictionary
The collection of route distribution statements to insert into the route distribution.
Required for action=add, action=update.
action
string
    Choices:
  • ACCEPT
Accept: import/export the route "as is"
id
string
The Oracle-assigned ID of each route distribution statement to be updated.
match_criteria
list / elements=dictionary
The action is applied only if all of the match criteria is met.
attachment_type
string
    Choices:
  • VCN
  • VIRTUAL_CIRCUIT
  • REMOTE_PEERING_CONNECTION
  • IPSEC_TUNNEL
The type of the network resource to be included in this match. A match for a network type implies that all DRG attachments of that type insert routes into the table.
Required when match_type is 'DRG_ATTACHMENT_TYPE'
drg_attachment_id
string
The OCID of the DRG attachment.
Required when match_type is 'DRG_ATTACHMENT_ID'
match_type
string / required
    Choices:
  • DRG_ATTACHMENT_ID
  • DRG_ATTACHMENT_TYPE
  • MATCH_ALL
The type of the match criteria for a route distribution statement.
priority
integer
This field is used to specify the priority of each statement in a route distribution. The priority will be represented as a number between 0 and 65535 where a lower number indicates a higher priority. When a route is processed, statements are applied in the order defined by their priority. The first matching rule dictates the action that will be taken on the route.
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_distribution_statements
  oci_network_drg_route_distribution_statements_actions:
    # required
    drg_route_distribution_id: "ocid1.drgroutedistribution.oc1..xxxxxxEXAMPLExxxxxx"
    statements:
    - # optional
      action: ACCEPT
      id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
      match_criteria:
      - # required
        drg_attachment_id: "ocid1.drgattachment.oc1..xxxxxxEXAMPLExxxxxx"
        match_type: DRG_ATTACHMENT_ID
      priority: 56
    action: add

- name: Perform action remove on drg_route_distribution_statements
  oci_network_drg_route_distribution_statements_actions:
    # required
    drg_route_distribution_id: "ocid1.drgroutedistribution.oc1..xxxxxxEXAMPLExxxxxx"
    action: remove

    # optional
    statement_ids: [ "statement_ids_example" ]

- name: Perform action update on drg_route_distribution_statements
  oci_network_drg_route_distribution_statements_actions:
    # required
    drg_route_distribution_id: "ocid1.drgroutedistribution.oc1..xxxxxxEXAMPLExxxxxx"
    statements:
    - # optional
      action: ACCEPT
      id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
      match_criteria:
      - # required
        drg_attachment_id: "ocid1.drgattachment.oc1..xxxxxxEXAMPLExxxxxx"
        match_type: DRG_ATTACHMENT_ID
      priority: 56
    action: update

Return Values

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

Key Returned Description
drg_route_distribution_statements
complex
on success
Details of the DrgRouteDistributionStatements resource acted upon by the current operation

Sample:
{'action': 'ACCEPT', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'match_criteria': [{'attachment_type': 'VCN', 'drg_attachment_id': 'ocid1.drgattachment.oc1..xxxxxxEXAMPLExxxxxx', 'match_type': 'DRG_ATTACHMENT_TYPE'}], 'priority': 56}
 
action
string
on success
`ACCEPT` indicates the route should be imported or exported as-is.

Sample:
ACCEPT
 
id
string
on success
The Oracle-assigned ID of the route distribution statement.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
match_criteria
complex
on success
The action is applied only if all of the match criteria is met. If there are no match criteria in a statement, any input is considered a match and the action is applied.

   
attachment_type
string
on success
The type of the network resource to be included in this match. A match for a network type implies that all DRG attachments of that type insert routes into the table.

Sample:
VCN
   
drg_attachment_id
string
on success
The OCID of the DRG attachment.

Sample:
ocid1.drgattachment.oc1..xxxxxxEXAMPLExxxxxx
   
match_type
string
on success
The type of the match criteria for a route distribution statement.

Sample:
DRG_ATTACHMENT_TYPE
 
priority
integer
on success
This field specifies the priority of each statement in a route distribution. Priorities must be unique within a particular route distribution. The priority will be represented as a number between 0 and 65535 where a lower number indicates a higher priority. When a route is processed, statements are applied in the order defined by their priority. The first matching rule dictates the action that will be taken on the route.

Sample:
56


Authors

  • Oracle (@oracle)