oracle / oracle.oci / 2.38.0 / module / oci_network_drg_route_distribution_statements_actions Perform actions on a DrgRouteDistributionStatements resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_network_drg_route_distribution_statements_actions (2.38.0) — module
Install with ansible-galaxy collection install oracle.oci:==2.38.0
collections: - name: oracle.oci version: 2.38.0
Perform actions on a DrgRouteDistributionStatements resource in Oracle Cloud Infrastructure
For I(action=add), adds one or more route distribution statements to the specified route distribution.
For I(action=remove), removes one or more route distribution statements from the specified route distribution's map.
For I(action=update), updates one or more route distribution statements in the specified route distribution.
- 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 match_criteria: - # required match_type: DRG_ATTACHMENT_ID drg_attachment_id: "ocid1.drgattachment.oc1..xxxxxxEXAMPLExxxxxx" action: ACCEPT priority: 56 id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx" 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 match_criteria: - # required match_type: DRG_ATTACHMENT_ID drg_attachment_id: "ocid1.drgattachment.oc1..xxxxxxEXAMPLExxxxxx" action: ACCEPT priority: 56 id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx" action: update
action: choices: - add - remove - update description: - The action to perform on the DrgRouteDistributionStatements. required: true type: str 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 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 statements: description: - The collection of route distribution statements to insert into the route distribution. - Required for I(action=add), I(action=update). elements: dict suboptions: action: choices: - ACCEPT description: - 'Accept: import/export the route "as is"' type: str id: description: - The Oracle-assigned ID of each route distribution statement to be updated. type: str match_criteria: description: - The action is applied only if all of the match criteria is met. If there are no match criteria in a statement, match ALL is implied. elements: dict suboptions: attachment_type: choices: - VCN - VIRTUAL_CIRCUIT - REMOTE_PEERING_CONNECTION - IPSEC_TUNNEL description: - 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' type: str drg_attachment_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment. - Required when match_type is 'DRG_ATTACHMENT_ID' type: str match_type: choices: - DRG_ATTACHMENT_ID - DRG_ATTACHMENT_TYPE description: - The type of the match criteria for a route distribution statement. required: true type: str type: list priority: description: - 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. type: int type: list statement_ids: description: - The Oracle-assigned ID of each route distribution to remove. - Applicable only for I(action=remove). elements: str type: list 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 drg_route_distribution_id: aliases: - id description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route distribution. required: true type: str
drg_route_distribution_statements: contains: action: description: - '`ACCEPT` indicates the route should be imported or exported as-is.' returned: on success sample: ACCEPT type: str id: description: - The Oracle-assigned ID of the route distribution statement. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str match_criteria: contains: attachment_type: description: - 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. returned: on success sample: VCN type: str drg_attachment_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment. returned: on success sample: ocid1.drgattachment.oc1..xxxxxxEXAMPLExxxxxx type: str match_type: description: - The type of the match criteria for a route distribution statement. returned: on success sample: DRG_ATTACHMENT_TYPE type: str description: - 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. returned: on success type: complex priority: description: - 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. returned: on success sample: 56 type: int description: - Details of the DrgRouteDistributionStatements resource acted upon by the current operation returned: on success 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 type: complex