oci_route_table – Create,update and delete OCI Route Table

New in version 2.5.

Synopsis

  • Creates OCI Route Table
  • Update OCI Route Table, if present, with a new display name
  • Update OCI Route Table, if present, by appending new Route Rules to existing Route Rules
  • Update OCI Route Table, if present, by purging existing Route Rules and replacing them with specified ones
  • Delete OCI Route Table, if present.

Requirements

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

Parameters

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_OCID 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_type
string
    Choices:
  • api_key ←
  • instance_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.
compartment_id
-
Identifier of the compartment under which this Route Table would be created. Mandatory for create operation.Optional for delete and update. Mutually exclusive with rt_id.
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 https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
delete_route_rules
boolean
    Choices:
  • no ←
  • yes
Delete route rules in existing Route Table which are present in the provided Route Rules. If delete_route_rules=yes, route rules provided by route_rules would be deleted from existing route rules, if they are part of existing route rules. If they are not part of existing route rules, they will be ignored. delete_route_rules and purge_route_rules are mutually exclusive.
display_name
-
Name of the Route Table. A user friendly name. Does not have to be unique, and could be changed. If not specified, a default name would be provided.

aliases: name
force_create
boolean
    Choices:
  • no ←
  • yes
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 https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
key_by
list
The list of comma-separated attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource except freeform_tags are used to uniquely identify a resource.
purge_route_rules
boolean
    Choices:
  • no
  • yes ←
Purge route rules in existing Route Table which are not present in the provided Route Rules. 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.
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 containing dictionaries describing a route rule. Suboptions should be the CIDR block which is destination ip address in CIDR notation and the identifier of the target entity such as Internet Getway.
cidr_block
-
A destination IP address range in CIDR notation. Matching packets will be routed to the indicated network entity (the target). This option is deprecated, use destination and destination_type instead.
destination
-
Conceptually, this is the range of IP addresses used for matching when routing traffic. Required if you provide a destination_type. Allowed values are, IP address range in CIDR notation (For example, 192.168.1.0/24) or The cidr_block 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
-
    Choices:
  • CIDR_BLOCK
  • SERVICE_CIDR_BLOCK
Type of destination for the rule. Required if you provide a destination. If the rule's destination is an IP address range in CIDR notation, the value should be CIDR_BLOCK.If the rule's destination is the cidr_block value for a service, the value should be SERVICE_CIDR_BLOCK.
network_entity_id
- / required
The identifier for the target of route rules, such as identifier of the Internet Gateway or Service Gateway.
rt_id
-
Identifier of the Route Table. Mandatory for delete and update, if compartment_id and vcn_id is not specified. Mutually exclusive with compartment_id and vcn_id.

aliases: id
state
-
    Choices:
  • present ←
  • absent
Create,update or delete Route Table. For state=present, if it does not exist, it gets created. If it exists, it gets updated.
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
-
Identifier of the Virtual Cloud Network to which the Route Table should be attached. Mandatory for create operation. Optional for delete and update. Mutually exclusive with rt_id.
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Default:
1200
Time, in seconds, to wait when wait=yes.
wait_until
string
The lifecycle state to wait for the resource to transition into when wait=yes. By default, when wait=yes, we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING applicable lifecycle state during create operation & to get into DELETED/DETACHED/ TERMINATED lifecycle state during delete operation.

Examples

# Note: These examples do not set authentication details.
# Create/update Route Table
- name: Create a Route Table with a route rule
  oci_route_table:
    compartment_id: 'ocid1.compartment..xxxxxEXAMPLExxxxx'
    vcn_id: 'ocid1.vcn..xxxxxEXAMPLExxxxx'
    name: 'ansible_route_table'
    route_rules:
        - cidr_block: '10.0.0.0/8'
          network_entity_id: 'ocid1.internetgateway..xxxxxEXAMPLExxxxx'
        - destination: 'oci-phx-objectstorage'
          destination_type: 'SERVICE_CIDR_BLOCK'
          network_entity_id: 'ocid1.servicegateway..xxxxxEXAMPLExxxxx'
    freeform_tags:
        region: 'east'
    defined_tags:
        features:
           capacity: 'medium'
    state: 'present'

# Update Route Table with rt id
- name: Update the display name of a Route Table
  oci_route_table:
    rt_id: 'ocid1.routetable..xxxxxEXAMPLExxxxx'
    display_name: 'ansible_route_table_updated'
    state: 'present'

# Update a route table with a new set of route rules,
# and purge any existing route rules that is not in the
# specified set of route rules.
- name: Update a Route Table with purge route rules
  oci_route_table:
    rt_id: 'ocid1.routetable..xxxxxEXAMPLExxxxx'
    purge_route_rules: 'yes'
    route_rules:
        - cidr_block: '10.0.0.0/12'
          network_entity_id: 'ocid1.internetgateway..abcd'
    state: 'present'

- name: Update a Route Table by deleting route rules
  oci_route_table:
    rt_id: 'ocid1.routetable..xxxxxEXAMPLExxxxx'
    delete_route_rules: 'yes'
    route_rules:
        - cidr_block: '10.0.0.0/12'
          network_entity_id: 'ocid1.internetgateway..abcd'
    state: 'present'

# Delete Route Table
- name: Delete Route Table
  oci_route_table:
    rt_id: 'ocid1.routetable..xxxxxEXAMPLExxxxx'
    state: 'absent'

Return Values

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

Key Returned Description
route_table
complex
success
Attributes of the created/updated Route Table. For delete, deleted Route Table description will be returned.

Sample:
{'lifecycle_state': 'AVAILABLE', 'display_name': 'ansible_route_table', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'vcn_id': 'ocid1.vcn.oc1.phx.xxxxxEXAMPLExxxxx', 'route_rules': [{'cidr_block': '0.0.0.0/0', 'destination': '0.0.0.0', 'network_entity_id': 'ocid1.internetgateway.oc1.phx.xxxxxEXAMPLExxxxx', 'destination_type': 'CIDR_BLOCK'}, {'cidr_block': None, 'destination': 'oci-phx-objectstorage', 'network_entity_id': 'ocid1.servicegateway.oc1.phx.xxxxxEXAMPLExxxxx', 'destination_type': 'SERVICE_CIDR_BLOCK'}], 'defined_tags': {'features': {'capacity': 'medium'}}, 'freeform_tags': {'region': 'east'}, 'time_created': '2017-11-17T17:39:33.190000+00:00', 'id': 'ocid1.routetable.oc1.phx.xxxxxEXAMPLExxxxx'}
  compartment_id
string
always
The identifier of the compartment containing the Route Table

Sample:
ocid1.compartment.oc1.xzvf..oifds
  display_name
string
always
Name assigned to the Route Table during creation

Sample:
ansible_route_table
  id
string
always
Identifier of the Route Table

Sample:
ocid1.routetable.oc1.axdf
  lifecycle_state
string
always
The current state of the Route Table

Sample:
AVAILABLE
  route_rules
string
always
The collection of rules for routing destination IPs to network devices.

Sample:
[{'cidr_block': '0.0.0.0/0', 'destination': '0.0.0.0', 'network_entity_id': 'ocid1.internetgateway.xxxxxEXAMPLExxxxx', 'destination_type': 'CIDR_BLOCK'}]
  time_created
datetime
always
Date and time when the Route Table was created, in the format defined by RFC3339

Sample:
2016-08-25 21:10:29.600000
  vcn_id
string
always
Identifier of the Virtual Cloud Network to which the Route Table is attached.

Sample:
ocid1.vcn..ixcd


Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]
  • This module is maintained by the Ansible Community. [community]

Authors

  • Debayan Gupta(@debayan_gupta)

Hint

If you notice any issues in this documentation you can edit this document to improve it.