Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace LocalPeeringGateway

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](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).

Properties

compartmentId

compartmentId: string

The OCID of the compartment containing the LPG.

Optional definedTags

definedTags: undefined | object

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

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

displayName

displayName: string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Optional freeformTags

freeformTags: undefined | 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.

Example: {@code {\"Department\": \"Finance\"}}

id

id: string

The LPG's Oracle ID (OCID).

isCrossTenancyPeering

isCrossTenancyPeering: boolean

Whether the VCN at the other end of the peering is in a different tenancy.

Example: {@code false}

lifecycleState

lifecycleState: LifecycleState

The LPG's current lifecycle state.

Optional peerAdvertisedCidr

peerAdvertisedCidr: undefined | string

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 {@code peerAdvertisedCidrDetails} for the individual CIDRs. The value is {@code null} if the LPG is not peered.

Example: {@code 192.168.0.0/16}, or if aggregated with {@code 172.16.0.0/24} then {@code 128.0.0.0/1}

Optional peerAdvertisedCidrDetails

peerAdvertisedCidrDetails: Array<string>

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 {@code 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: [{@code 192.168.0.0/16}, {@code 172.16.0.0/24}]

peerId

peerId: string

The OCID of the peered LPG.

peeringStatus

peeringStatus: PeeringStatus

Whether the LPG is peered with another LPG. {@code NEW} means the LPG has not yet been peered. {@code PENDING} means the peering is being established. {@code REVOKED} means the LPG at the other end of the peering has been deleted.

Optional peeringStatusDetails

peeringStatusDetails: undefined | string

Additional information regarding the peering status, if applicable.

Optional routeTableId

routeTableId: undefined | string

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](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/transitrouting.htm).

timeCreated

timeCreated: Date

The date and time the LPG was created, in the format defined by RFC3339.

Example: {@code 2016-08-25T21:10:29.600Z}

vcnId

vcnId: string

The OCID of the VCN that uses the LPG.

Functions

getDeserializedJsonObj

getJsonObj