- orphan
Note
This plugin is part of the oracle.oci collection (version 4.13.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_route_table
.
2.9.0 of oracle.oci
- This module allows the user to create, update and delete a RouteTable resource in Oracle Cloud Infrastructure
- For state=present, creates a new route table for the specified VCN. In the request you must also include at least one route rule for the new route table. For information on the number of rules you can have in a route table, see Service Limits. For general information about route tables in your VCN and the types of targets you can use in route rules, see Route Tables.
- For the purposes of access control, you must provide the OCID of the compartment where you want the route table to reside. Notice that the route table doesn't have to be in the same compartment as the VCN, subnets, or other Networking Service components. If you're not sure which compartment to use, put the route table in the same compartment as the VCN. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.
- You may optionally specify a display name for the route table, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.
- This resource has the following action operations in the
oracle.oci.oci_network_route_table_actions <ansible_collections.oracle.oci.oci_network_route_table_actions_module>
module: change_compartment.
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
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 ). |
||
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 to contain the route table.
Required for create using state=present.
Required for update when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.Required for delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set. |
||
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 . |
||
defined_tags
dictionary
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
|
||
delete_route_rules
boolean
|
"false"
|
Delete route rules from existing route table which are present in the route rules provided by route_rules. If delete_route_rules=yes, route rules provided by route_rules would be deleted, if they are part of existing route table. If they are not part of existing route table, they will be ignored. purge_route_rules and delete_route_rules are mutually exclusive.
This parameter is updatable.
|
|
display_name
string
|
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Required for create, update, delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.This parameter is updatable when
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: name |
||
force_create
boolean
|
|
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
|
|
freeform_tags
dictionary
|
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"}`
This parameter is updatable.
|
||
key_by
list
/ elements=string
|
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
|
||
purge_route_rules
boolean
|
"true"
|
Purge route rules from route table which are not present in the provided route table. If purge_route_rules=no, provided route rules would be appended to existing route rules. purge_route_rules and delete_route_rules are mutually exclusive.
This parameter is updatable.
|
|
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_rules
list
/ elements=dictionary
|
The collection of rules used for routing destination IPs to network devices.
Required for create using state=present.
This parameter is updatable.
|
||
cidr_block
string
|
Deprecated. Instead use `destination` and `destinationType`. Requests that include both `cidrBlock` and `destination` will be rejected.
A destination IP address range in CIDR notation. Matching packets will be routed to the indicated network entity (the target).
Cannot be an IPv6 CIDR.
Example: `0.0.0.0/0`
|
||
description
string
|
An optional description of your choice for the rule.
|
||
destination
string
|
Conceptually, this is the range of IP addresses used for matching when routing traffic. Required if you provide a `destinationType`.
Allowed values:
* IP address range in CIDR notation. Can be an IPv4 or IPv6 CIDR. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`. If you set this to an IPv6 CIDR, the route rule's target can only be a DRG or internet gateway. IPv6 addressing is supported for all commercial and government regions. See IPv6 Addresses.
* The `cidrBlock` value for a Service, if you're setting up a route rule for traffic destined for a particular `Service` through a service gateway. For example: `oci-phx-objectstorage`.
|
||
destination_type
string
|
|
Type of destination for the rule. Required if you provide a `destination`.
* `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).
|
|
network_entity_id
string
/ required
|
The OCID for the route rule's target. For information about the type of targets you can specify, see Route Tables.
|
||
route_type
string
|
|
A route rule can be STATIC if manually added to the route table, LOCAL if added by OCI to the route table.
|
|
rt_id
string
|
The OCID of the route table.
Required for update using state=present when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.Required for delete using state=absent when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: id |
||
state
string
|
|
The state of the RouteTable.
Use state=present to create or update a RouteTable.
Use state=absent to delete a RouteTable.
|
|
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 the route table belongs to.
Required for create using state=present.
|
||
wait
boolean
|
|
Whether to wait for create or delete operation to complete.
|
|
wait_timeout
integer
|
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.
|
Note
- For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
- name: Create route_table
oci_network_route_table:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
vcn_id: "ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx"
route_rules:
- # required
network_entity_id: "ocid1.networkentity.oc1..xxxxxxEXAMPLExxxxxx"
# optional
cidr_block: cidr_block_example
destination: destination_example
destination_type: CIDR_BLOCK
description: description_example
route_type: STATIC
# optional
defined_tags: {'Operations': {'CostCenter': 'US'}}
display_name: display_name_example
freeform_tags: {'Department': 'Finance'}
- name: Update route_table
oci_network_route_table:
# required
rt_id: "ocid1.rt.oc1..xxxxxxEXAMPLExxxxxx"
# optional
purge_route_rules: false
delete_route_rules: true
defined_tags: {'Operations': {'CostCenter': 'US'}}
display_name: display_name_example
freeform_tags: {'Department': 'Finance'}
route_rules:
- # required
network_entity_id: "ocid1.networkentity.oc1..xxxxxxEXAMPLExxxxxx"
# optional
cidr_block: cidr_block_example
destination: destination_example
destination_type: CIDR_BLOCK
description: description_example
route_type: STATIC
- name: Update route_table using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_network_route_table:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
# optional
purge_route_rules: false
delete_route_rules: true
defined_tags: {'Operations': {'CostCenter': 'US'}}
freeform_tags: {'Department': 'Finance'}
route_rules:
- # required
network_entity_id: "ocid1.networkentity.oc1..xxxxxxEXAMPLExxxxxx"
# optional
cidr_block: cidr_block_example
destination: destination_example
destination_type: CIDR_BLOCK
description: description_example
route_type: STATIC
- name: Delete route_table
oci_network_route_table:
# required
rt_id: "ocid1.rt.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete route_table using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_network_route_table:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
state: absent
Common return values are documented here <common_return_values>
, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
route_table
complex
|
on success |
Details of the RouteTable resource acted upon by the current operation
Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'PROVISIONING', 'route_rules': [{'cidr_block': 'cidr_block_example', 'description': 'description_example', 'destination': 'destination_example', 'destination_type': 'CIDR_BLOCK', 'network_entity_id': 'ocid1.networkentity.oc1..xxxxxxEXAMPLExxxxxx', 'route_type': 'STATIC'}], '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 route table.
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
|
||
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 route table's Oracle ID (OCID).
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
lifecycle_state
string
|
on success |
The route table's current state.
Sample:
PROVISIONING
|
||
route_rules
complex
|
on success |
The collection of rules for routing destination IPs to network devices.
|
||
cidr_block
string
|
on success |
Deprecated. Instead use `destination` and `destinationType`. Requests that include both `cidrBlock` and `destination` will be rejected.
A destination IP address range in CIDR notation. Matching packets will be routed to the indicated network entity (the target).
Cannot be an IPv6 CIDR.
Example: `0.0.0.0/0`
Sample:
cidr_block_example
|
||
description
string
|
on success |
An optional description of your choice for the rule.
Sample:
description_example
|
||
destination
string
|
on success |
Conceptually, this is the range of IP addresses used for matching when routing traffic. Required if you provide a `destinationType`.
Allowed values:
* IP address range in CIDR notation. Can be an IPv4 or IPv6 CIDR. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`. If you set this to an IPv6 CIDR, the route rule's target can only be a DRG or internet gateway. IPv6 addressing is supported for all commercial and government regions. See IPv6 Addresses.
* The `cidrBlock` value for a Service, if you're setting up a route rule for traffic destined for a particular `Service` through a service gateway. For example: `oci-phx-objectstorage`.
Sample:
destination_example
|
||
destination_type
string
|
on success |
Type of destination for the rule. Required if you provide a `destination`.
* `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
|
||
network_entity_id
string
|
on success |
The OCID for the route rule's target. For information about the type of targets you can specify, see Route Tables.
Sample:
ocid1.networkentity.oc1..xxxxxxEXAMPLExxxxxx
|
||
route_type
string
|
on success |
A route rule can be STATIC if manually added to the route table, LOCAL if added by OCI to the route table.
Sample:
STATIC
|
||
time_created
string
|
on success |
The date and time the route table 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 the route table list belongs to.
Sample:
ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx
|
- Oracle (@oracle)