drg_route_tables

Creates, updates, deletes, gets or lists a drg_route_tables resource.

Overview

Name	drg_route_tables
Type	Resource
Id	oci.network.drg_route_tables

Fields

The following fields are returned by SELECT queries:

get

The DRG route table was retrieved.

Name	Datatype	Description
id	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table.
compartmentId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment the DRG is in. The DRG route table is always in the same compartment as the DRG.
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
displayName	string	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
drgId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG the DRG that contains this route table.
freeformTags	object	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](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
importDrgRouteDistributionId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the import route distribution used to specify how incoming route advertisements from referenced attachments are inserted into the DRG route table.
isEcmpEnabled	boolean	If you want traffic to be routed using ECMP across your virtual circuits or IPSec tunnels to your on-premises network, enable ECMP on the DRG route table to which these attachments import routes.
lifecycleState	string	The DRG route table's current state. (PROVISIONING, AVAILABLE, TERMINATING, TERMINATED)
timeCreated	string (date-time)	The date and time the DRG route table was created, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z

list

All routing inside the DRG is driven by the contents of DRG route tables.<br />DRG route tables contain rules which route packets to a particular network destination,<br />represented as a DRG attachment.<br />The routing decision for a packet entering a DRG is determined by the rules in the DRG route table<br />assigned to the attachment-of-entry.<br /><br />Each DRG attachment can inject routes in any DRG route table, provided there is a statement corresponding to the attachment in the route table's importDrgRouteDistribution.<br />You can also insert static routes into the DRG route tables.<br /><br />The DRG route table is always in the same compartment as the DRG. There must always be a default<br />DRG route table for each attachment type.<br />

Name	Datatype	Description
id	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table.
compartmentId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment the DRG is in. The DRG route table is always in the same compartment as the DRG.
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}}
displayName	string	A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
drgId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG the DRG that contains this route table.
freeformTags	object	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](/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
importDrgRouteDistributionId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the import route distribution used to specify how incoming route advertisements from referenced attachments are inserted into the DRG route table.
isEcmpEnabled	boolean	If you want traffic to be routed using ECMP across your virtual circuits or IPSec tunnels to your on-premises network, enable ECMP on the DRG route table to which these attachments import routes.
lifecycleState	string	The DRG route table's current state. (PROVISIONING, AVAILABLE, TERMINATING, TERMINATED)
timeCreated	string (date-time)	The date and time the DRG route table was created, in the format defined by [RFC3339](https:​//tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	drgRouteTableId, region		Gets the specified DRG route table's information.
list	select	drgId, region	limit, page, displayName, sortBy, sortOrder, importDrgRouteDistributionId, lifecycleState	Lists the DRG route tables for the specified DRG.<br /><br />Use the ListDrgRouteRules operation to retrieve the route rules in a table.<br />
create	insert	region, drgId	opc-retry-token	Creates a new DRG route table for the specified DRG. Assign the DRG route table to a DRG attachment<br />using the UpdateDrgAttachment or CreateDrgAttachment operations.<br />
update	update	drgRouteTableId, region	if-match	Updates the specified DRG route table.<br />
delete	delete	drgRouteTableId, region	if-match	Deletes the specified DRG route table. There must not be any DRG attachments assigned.<br />
add_drg_route_rules	exec	drgRouteTableId, region	opc-retry-token	Adds one or more static route rules to the specified DRG route table.<br />
remove_drg_route_rules	exec	drgRouteTableId, region		Removes one or more route rules from the specified DRG route table.<br />
remove_import_drg_route_distribution	exec	drgRouteTableId, region	opc-request-id, if-match	Removes the import route distribution from the DRG route table so no routes are imported<br />into it.<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
drgId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG.
drgRouteTableId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table.
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
displayName	string	A filter to return only resources that match the given display name exactly.
if-match	string	For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
importDrgRouteDistributionId	string	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the import route distribution.
lifecycleState	string	A filter that only returns matches for the specified lifecycle state. The value is case insensitive.
limit	integer	For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: 50
opc-request-id	string	Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opc-retry-token	string	A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
page	string	For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
sortBy	string	The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.
sortOrder	string	The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

SELECT examples

get

Gets the specified DRG route table's information.

SELECT
id,
compartmentId,
definedTags,
displayName,
drgId,
freeformTags,
importDrgRouteDistributionId,
isEcmpEnabled,
lifecycleState,
timeCreated
FROM oci.network.drg_route_tables
WHERE drgRouteTableId = '{{ drgRouteTableId }}' -- required
AND region = '{{ region }}' -- required
;

list

Lists the DRG route tables for the specified DRG.<br /><br />Use the ListDrgRouteRules operation to retrieve the route rules in a table.<br />

SELECT
id,
compartmentId,
definedTags,
displayName,
drgId,
freeformTags,
importDrgRouteDistributionId,
isEcmpEnabled,
lifecycleState,
timeCreated
FROM oci.network.drg_route_tables
WHERE drgId = '{{ drgId }}' -- required
AND region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND displayName = '{{ displayName }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND importDrgRouteDistributionId = '{{ importDrgRouteDistributionId }}'
AND lifecycleState = '{{ lifecycleState }}'
;

INSERT examples

create

Creates a new DRG route table for the specified DRG. Assign the DRG route table to a DRG attachment<br />using the UpdateDrgAttachment or CreateDrgAttachment operations.<br />

INSERT INTO oci.network.drg_route_tables (
definedTags,
displayName,
drgId,
freeformTags,
importDrgRouteDistributionId,
isEcmpEnabled,
region,
opc-retry-token
)
SELECT 
'{{ definedTags }}',
'{{ displayName }}',
'{{ drgId }}' /* required */,
'{{ freeformTags }}',
'{{ importDrgRouteDistributionId }}',
{{ isEcmpEnabled }},
'{{ region }}',
'{{ opc-retry-token }}'
RETURNING
id,
compartmentId,
definedTags,
displayName,
drgId,
freeformTags,
importDrgRouteDistributionId,
isEcmpEnabled,
lifecycleState,
timeCreated
;

Manifest

# Description fields are for documentation purposes
- name: drg_route_tables
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the drg_route_tables resource.
  - name: definedTags
    value: "{{ definedTags }}"
    description: |
      Defined tags for this resource. Each key is predefined and scoped to a
      namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
      Example: `{"Operations": {"CostCenter": "42"}}`
  - name: displayName
    value: "{{ displayName }}"
    description: |
      A user-friendly name. Does not have to be unique, and it's changeable.
      Avoid entering confidential information.
  - name: drgId
    value: "{{ drgId }}"
    description: |
      The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG the DRG route table belongs to.
  - name: freeformTags
    value: "{{ freeformTags }}"
    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 [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
      Example: `{"Department": "Finance"}`
  - name: importDrgRouteDistributionId
    value: "{{ importDrgRouteDistributionId }}"
    description: |
      The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the import route distribution used to specify how incoming route advertisements through
      referenced attachments are inserted into the DRG route table.
  - name: isEcmpEnabled
    value: {{ isEcmpEnabled }}
    description: |
      If you want traffic to be routed using ECMP across your virtual circuits or IPSec tunnels to
      your on-premises networks, enable ECMP on the DRG route table.
    default: false
  - name: opc-retry-token
    value: "{{ opc-retry-token }}"
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 

UPDATE examples

update

Updates the specified DRG route table.<br />

UPDATE oci.network.drg_route_tables
SET 
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}',
importDrgRouteDistributionId = '{{ importDrgRouteDistributionId }}',
isEcmpEnabled = {{ isEcmpEnabled }}
WHERE 
drgRouteTableId = '{{ drgRouteTableId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
RETURNING
id,
compartmentId,
definedTags,
displayName,
drgId,
freeformTags,
importDrgRouteDistributionId,
isEcmpEnabled,
lifecycleState,
timeCreated;

DELETE examples

delete

Deletes the specified DRG route table. There must not be any DRG attachments assigned.<br />

DELETE FROM oci.network.drg_route_tables
WHERE drgRouteTableId = '{{ drgRouteTableId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
;

Lifecycle Methods

add_drg_route_rules

Adds one or more static route rules to the specified DRG route table.<br />

EXEC oci.network.drg_route_tables.add_drg_route_rules 
@drgRouteTableId='{{ drgRouteTableId }}' --required, 
@region='{{ region }}' --required, 
@opc-retry-token='{{ opc-retry-token }}' 
@@json=
'{
"routeRules": "{{ routeRules }}"
}'
;

remove_drg_route_rules

Removes one or more route rules from the specified DRG route table.<br />

EXEC oci.network.drg_route_tables.remove_drg_route_rules 
@drgRouteTableId='{{ drgRouteTableId }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"routeRuleIds": "{{ routeRuleIds }}"
}'
;

remove_import_drg_route_distribution

Removes the import route distribution from the DRG route table so no routes are imported<br />into it.<br />

EXEC oci.network.drg_route_tables.remove_import_drg_route_distribution 
@drgRouteTableId='{{ drgRouteTableId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}', 
@if-match='{{ if-match }}'
;