Try SpotterManage a RouteTable resource in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0This module allows the user to create, update and delete a RouteTable resource in Oracle Cloud Infrastructure
For I(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 L(Service Limits,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/servicelimits.htm). For general information about route tables in your VCN and the types of targets you can use in route rules, see L(Route Tables,https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm).
For the purposes of access control, you must provide the L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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 L(Overview of the IAM Service,https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see L(Resource Identifiers,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
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 M(oracle.oci.oci_network_route_table_actions) module: change_compartment.
- 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
wait:
default: true
description: Whether to wait for create or delete operation to complete.
type: bool
rt_id:
aliases:
- id
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the route table.
- Required for update using I(state=present) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER)
is not set.
- Required for delete using I(state=absent) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER)
is not set.
type: str
state:
choices:
- present
- absent
default: present
description:
- The state of the RouteTable.
- Use I(state=present) to create or update a RouteTable.
- Use I(state=absent) to delete a RouteTable.
required: false
type: str
key_by:
description: 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.
elements: str
type: list
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
vcn_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the VCN the route table belongs to.
- Required for create using I(state=present).
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
- security_token
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
cert_bundle:
description:
- 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.
type: str
route_rules:
description:
- The collection of rules used for routing destination IPs to network devices.
- Required for create using I(state=present).
- This parameter is updatable.
elements: dict
suboptions:
cidr_block:
description:
- 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 prefix.
- 'Example: `0.0.0.0/0`'
type: str
description:
description:
- An optional description of your choice for the rule.
type: str
destination:
description:
- 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 CIDR block or IPv6 prefix.
For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`. If you set this to
an IPv6 prefix, the route rule''s target can only be a DRG or internet gateway.
IPv6 addressing is supported for all commercial and government regions. See
L(IPv6 Addresses,https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).'
- ' * The `cidrBlock` value for a L(Service,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/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`.'
type: str
destination_type:
choices:
- CIDR_BLOCK
- SERVICE_CIDR_BLOCK
description:
- 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 L(Service,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Service/)
(the rule is for traffic destined for a particular `Service` through a service
gateway).'
type: str
network_entity_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
for the route rule's target. For information about the type of targets you can
specify, see L(Route Tables,https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm).
required: true
type: str
route_type:
choices:
- STATIC
- LOCAL
description:
- A route rule can be STATIC if manually added to the route table, LOCAL if added
by OCI to the route table.
type: str
type: list
auth_purpose:
choices:
- service_principal
description:
- The auth purpose which can be used in conjunction with 'auth_type=instance_principal'.
The default auth_purpose for instance_principal is None.
type: str
defined_tags:
description:
- Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Operations": {"CostCenter": "42"}}`'
- This parameter is updatable.
type: dict
display_name:
aliases:
- name
description:
- 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 C(OCI_USE_NAME_AS_IDENTIFIER)
is set.
- This parameter is updatable when C(OCI_USE_NAME_AS_IDENTIFIER) is not set.
type: str
force_create:
default: false
description: 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 I(key_by).
type: bool
wait_timeout:
description: Time, in seconds, to wait when I(wait=yes). Defaults to 1200 for most
of the services but some services might have a longer wait timeout.
type: int
freeform_tags:
description:
- 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 L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
- This parameter is updatable.
type: dict
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the compartment to contain the route table.
- Required for create using I(state=present).
- Required for update when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set.
- Required for delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set.
type: str
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
purge_route_rules:
default: 'true'
description:
- Purge route rules from route table which are not present in the provided route table.
If I(purge_route_rules=no), provided route rules would be appended to existing route
rules. I(purge_route_rules) and I(delete_route_rules) are mutually exclusive.
- This parameter is updatable.
type: bool
delete_route_rules:
default: 'false'
description:
- Delete route rules from existing route table which are present in the route rules
provided by I(route_rules). If I(delete_route_rules=yes), route rules provided by
I(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. I(purge_route_rules)
and I(delete_route_rules) are mutually exclusive.
- This parameter is updatable.
type: bool
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
realm_specific_endpoint_template_enabled:
description:
- Enable/Disable realm specific endpoint template for service client. By Default,
realm specific endpoint template is disabled. If not set, then the value of the
OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
type: bool
route_table:
contains:
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the compartment containing the route table.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
defined_tags:
description:
- Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Operations": {"CostCenter": "42"}}`'
returned: on success
sample:
Operations:
CostCenter: US
type: dict
display_name:
description:
- A user-friendly name. Does not have to be unique, and it's changeable. Avoid
entering confidential information.
returned: on success
sample: display_name_example
type: str
freeform_tags:
description:
- 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 L(Resource
Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
returned: on success
sample:
Department: Finance
type: dict
id:
description:
- The route table's Oracle ID (L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
lifecycle_state:
description:
- The route table's current state.
returned: on success
sample: PROVISIONING
type: str
route_rules:
contains:
cidr_block:
description:
- 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 prefix.
- 'Example: `0.0.0.0/0`'
returned: on success
sample: cidr_block_example
type: str
description:
description:
- An optional description of your choice for the rule.
returned: on success
sample: description_example
type: str
destination:
description:
- 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 CIDR block or IPv6
prefix. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`. If
you set this to an IPv6 prefix, the route rule''s target can only be a
DRG or internet gateway. IPv6 addressing is supported for all commercial
and government regions. See L(IPv6 Addresses,https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).'
- ' * The `cidrBlock` value for a L(Service,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/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`.'
returned: on success
sample: destination_example
type: str
destination_type:
description:
- 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 L(Service,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Service/)
(the rule is for traffic destined for a particular `Service` through a
service gateway).'
returned: on success
sample: CIDR_BLOCK
type: str
network_entity_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
for the route rule's target. For information about the type of targets
you can specify, see L(Route Tables,https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm).
returned: on success
sample: ocid1.networkentity.oc1..xxxxxxEXAMPLExxxxxx
type: str
route_type:
description:
- A route rule can be STATIC if manually added to the route table, LOCAL
if added by OCI to the route table.
returned: on success
sample: STATIC
type: str
description:
- The collection of rules for routing destination IPs to network devices.
returned: on success
type: complex
time_created:
description:
- The date and time the route table was created, in the format defined by L(RFC3339,https://tools.ietf.org/html/rfc3339).
- 'Example: `2016-08-25T21:10:29.600Z`'
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
vcn_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the VCN the route table list belongs to.
returned: on success
sample: ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx
type: str
description:
- Details of the RouteTable resource acted upon by the current operation
returned: on success
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
type: complex