LocalPeeringGateway

class oci.core.models.LocalPeeringGateway(**kwargs)

Bases: object

A local peering gateway (LPG) is an object on a VCN that lets that VCN peer with another VCN in the same region. Peering means that the two VCNs can communicate using private IP addresses, but without the traffic traversing the internet or routing through your on-premises network. For more information, see VCN Peering.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'

A constant which can be used with the lifecycle_state property of a LocalPeeringGateway. This constant has a value of "AVAILABLE"

LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'

A constant which can be used with the lifecycle_state property of a LocalPeeringGateway. This constant has a value of "PROVISIONING"

LIFECYCLE_STATE_TERMINATED = 'TERMINATED'

A constant which can be used with the lifecycle_state property of a LocalPeeringGateway. This constant has a value of "TERMINATED"

LIFECYCLE_STATE_TERMINATING = 'TERMINATING'

A constant which can be used with the lifecycle_state property of a LocalPeeringGateway. This constant has a value of "TERMINATING"

PEERING_STATUS_INVALID = 'INVALID'

A constant which can be used with the peering_status property of a LocalPeeringGateway. This constant has a value of "INVALID"

PEERING_STATUS_NEW = 'NEW'

A constant which can be used with the peering_status property of a LocalPeeringGateway. This constant has a value of "NEW"

PEERING_STATUS_PEERED = 'PEERED'

A constant which can be used with the peering_status property of a LocalPeeringGateway. This constant has a value of "PEERED"

PEERING_STATUS_PENDING = 'PENDING'

A constant which can be used with the peering_status property of a LocalPeeringGateway. This constant has a value of "PENDING"

PEERING_STATUS_REVOKED = 'REVOKED'

A constant which can be used with the peering_status property of a LocalPeeringGateway. This constant has a value of "REVOKED"

__init__(**kwargs)

Initializes a new LocalPeeringGateway object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • compartment_id (str) -- The value to assign to the compartment_id property of this LocalPeeringGateway.
  • defined_tags (dict(str, dict(str, object))) -- The value to assign to the defined_tags property of this LocalPeeringGateway.
  • display_name (str) -- The value to assign to the display_name property of this LocalPeeringGateway.
  • freeform_tags (dict(str, str)) -- The value to assign to the freeform_tags property of this LocalPeeringGateway.
  • id (str) -- The value to assign to the id property of this LocalPeeringGateway.
  • is_cross_tenancy_peering (bool) -- The value to assign to the is_cross_tenancy_peering property of this LocalPeeringGateway.
  • lifecycle_state (str) -- The value to assign to the lifecycle_state property of this LocalPeeringGateway. Allowed values for this property are: "PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
  • peer_advertised_cidr (str) -- The value to assign to the peer_advertised_cidr property of this LocalPeeringGateway.
  • peer_advertised_cidr_details (list[str]) -- The value to assign to the peer_advertised_cidr_details property of this LocalPeeringGateway.
  • peering_status (str) -- The value to assign to the peering_status property of this LocalPeeringGateway. Allowed values for this property are: "INVALID", "NEW", "PEERED", "PENDING", "REVOKED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
  • peering_status_details (str) -- The value to assign to the peering_status_details property of this LocalPeeringGateway.
  • route_table_id (str) -- The value to assign to the route_table_id property of this LocalPeeringGateway.
  • time_created (datetime) -- The value to assign to the time_created property of this LocalPeeringGateway.
  • vcn_id (str) -- The value to assign to the vcn_id property of this LocalPeeringGateway.
compartment_id

[Required] Gets the compartment_id of this LocalPeeringGateway. The OCID of the compartment containing the LPG.

Returns:The compartment_id of this LocalPeeringGateway.
Return type:str
defined_tags

Gets the defined_tags of this LocalPeeringGateway. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {"Operations": {"CostCenter": "42"}}

Returns:The defined_tags of this LocalPeeringGateway.
Return type:dict(str, dict(str, object))
display_name

[Required] Gets the display_name of this LocalPeeringGateway. A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:The display_name of this LocalPeeringGateway.
Return type:str
freeform_tags

Gets the freeform_tags of this LocalPeeringGateway. 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"}

Returns:The freeform_tags of this LocalPeeringGateway.
Return type:dict(str, str)
id

[Required] Gets the id of this LocalPeeringGateway. The LPG's Oracle ID (OCID).

Returns:The id of this LocalPeeringGateway.
Return type:str
is_cross_tenancy_peering

[Required] Gets the is_cross_tenancy_peering of this LocalPeeringGateway. Whether the VCN at the other end of the peering is in a different tenancy.

Example: false

Returns:The is_cross_tenancy_peering of this LocalPeeringGateway.
Return type:bool
lifecycle_state

[Required] Gets the lifecycle_state of this LocalPeeringGateway. The LPG's current lifecycle state.

Allowed values for this property are: "PROVISIONING", "AVAILABLE", "TERMINATING", "TERMINATED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.

Returns:The lifecycle_state of this LocalPeeringGateway.
Return type:str
peer_advertised_cidr

Gets the peer_advertised_cidr of this LocalPeeringGateway. The smallest aggregate CIDR that contains all the CIDR routes advertised by the VCN at the other end of the peering from this LPG. See peerAdvertisedCidrDetails for the individual CIDRs. The value is null if the LPG is not peered.

Example: 192.168.0.0/16, or if aggregated with 172.16.0.0/24 then 128.0.0.0/1

Returns:The peer_advertised_cidr of this LocalPeeringGateway.
Return type:str
peer_advertised_cidr_details

Gets the peer_advertised_cidr_details of this LocalPeeringGateway. The specific ranges of IP addresses available on or via the VCN at the other end of the peering from this LPG. The value is null if the LPG is not peered. You can use these as destination CIDRs for route rules to route a subnet's traffic to this LPG.

Example: [192.168.0.0/16, 172.16.0.0/24]

Returns:The peer_advertised_cidr_details of this LocalPeeringGateway.
Return type:list[str]
peering_status

[Required] Gets the peering_status of this LocalPeeringGateway. Whether the LPG is peered with another LPG. NEW means the LPG has not yet been peered. PENDING means the peering is being established. REVOKED means the LPG at the other end of the peering has been deleted.

Allowed values for this property are: "INVALID", "NEW", "PEERED", "PENDING", "REVOKED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.

Returns:The peering_status of this LocalPeeringGateway.
Return type:str
peering_status_details

Gets the peering_status_details of this LocalPeeringGateway. Additional information regarding the peering status, if applicable.

Returns:The peering_status_details of this LocalPeeringGateway.
Return type:str
route_table_id

Gets the route_table_id of this LocalPeeringGateway. The OCID of the route table the LPG is using.

For information about why you would associate a route table with an LPG, see Transit Routing: Access to Multiple VCNs in Same Region.

Returns:The route_table_id of this LocalPeeringGateway.
Return type:str
time_created

[Required] Gets the time_created of this LocalPeeringGateway. The date and time the LPG was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:The time_created of this LocalPeeringGateway.
Return type:datetime
vcn_id

[Required] Gets the vcn_id of this LocalPeeringGateway. The OCID of the VCN the LPG belongs to.

Returns:The vcn_id of this LocalPeeringGateway.
Return type:str