public_ip_pools

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

Overview

Name	`public_ip_pools`
Type	Resource
Id	`oci.network.public_ip_pools`

Fields

The following fields are returned by SELECT queries:

get
list

The PublicIpPool object was retrieved.

Name	Datatype	Description
`id`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool.
`cidrBlocks`	`array`	The CIDR blocks added to this pool. This could be all or a portion of a BYOIP CIDR block.
`compartmentId`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing this pool.
`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.
`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"}`
`lifecycleState`	`string`	The public IP pool's current state. (INACTIVE, UPDATING, ACTIVE, DELETING, DELETED)
`timeCreated`	`string (date-time)`	The date and time the public IP pool was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`

The list is being retrieved.

Name	Datatype	Description
`id`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool.
`compartmentId`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the public IP pool.
`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.
`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"}`
`lifecycleState`	`string`	The public IP pool's current state. (x-obmcs-enumref: #/definitions/PublicIpPool/lifecycleState)
`timeCreated`	`string (date-time)`	The date and time the public IP pool 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`	`publicIpPoolId`, `region`	`opc-request-id`	Gets the specified `PublicIpPool` object. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).<br />
`list`	`select`	`compartmentId`, `region`	`opc-request-id`, `limit`, `page`, `displayName`, `byoipRangeId`, `sortBy`, `sortOrder`	Lists the public IP pools in the specified compartment.<br />You can filter the list using query parameters.<br />
`create`	`insert`	`region`, `compartmentId`	`opc-request-id`, `opc-retry-token`	Creates a public IP pool.<br />
`update`	`update`	`publicIpPoolId`, `region`	`opc-request-id`, `if-match`	Updates the specified public IP pool.<br />
`delete`	`delete`	`publicIpPoolId`, `region`	`opc-request-id`, `if-match`	Deletes the specified public IP pool.<br />To delete a public IP pool it must not have any active IP address allocations.<br />You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm) when deleting an IP pool.<br />
`add_public_ip_pool_capacity`	`exec`	`publicIpPoolId`, `region`, `byoipRangeId`, `cidrBlock`	`opc-request-id`, `opc-retry-token`	Adds some or all of a CIDR block to a public IP pool.<br /><br />The CIDR block (or subrange) must not overlap with any other CIDR block already added to this or any other public IP pool.<br />
`change_compartment`	`exec`	`publicIpPoolId`, `region`, `compartmentId`	`opc-request-id`, `opc-retry-token`	Moves a public IP pool to a different compartment. For information<br />about moving resources between compartments, see<br />[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).<br />
`remove_public_ip_pool_capacity`	`exec`	`publicIpPoolId`, `region`, `cidrBlock`	`opc-request-id`, `opc-retry-token`	Removes a CIDR block from the referenced public IP pool.<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
`compartmentId`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
`publicIpPoolId`	`string`	The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool.
`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)
`byoipRangeId`	`string`	A filter to return only resources that match the given BYOIP CIDR block.
`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.
`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
list

Gets the specified PublicIpPool object. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).

SELECT
id,
cidrBlocks,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleState,
timeCreated
FROM oci.network.public_ip_pools
WHERE publicIpPoolId = '{{ publicIpPoolId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

Lists the public IP pools in the specified compartment. You can filter the list using query parameters.

SELECT
id,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleState,
timeCreated
FROM oci.network.public_ip_pools
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND displayName = '{{ displayName }}'
AND byoipRangeId = '{{ byoipRangeId }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
;

`INSERT` examples

create
Manifest

Creates a public IP pool.

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

# Description fields are for documentation purposes
- name: public_ip_pools
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the public_ip_pools resource.
  - name: compartmentId
    value: "{{ compartmentId }}"
    description: |
      The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the public IP pool.
  - 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: 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: opc-request-id
    value: "{{ opc-request-id }}"
    description: Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 
    description: Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 
  - 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 public IP pool.

UPDATE oci.network.public_ip_pools
SET 
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}'
WHERE 
publicIpPoolId = '{{ publicIpPoolId }}' --required
AND region = '{{ region }}' --required
AND opc-request-id = '{{ opc-request-id}}'
AND if-match = '{{ if-match}}'
RETURNING
id,
cidrBlocks,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleState,
timeCreated;

`DELETE` examples

delete

Deletes the specified public IP pool. To delete a public IP pool it must not have any active IP address allocations. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm) when deleting an IP pool.

DELETE FROM oci.network.public_ip_pools
WHERE publicIpPoolId = '{{ publicIpPoolId }}' --required
AND region = '{{ region }}' --required
AND opc-request-id = '{{ opc-request-id }}'
AND if-match = '{{ if-match }}'
;

Lifecycle Methods

add_public_ip_pool_capacity
change_compartment
remove_public_ip_pool_capacity

Adds some or all of a CIDR block to a public IP pool. The CIDR block (or subrange) must not overlap with any other CIDR block already added to this or any other public IP pool.

EXEC oci.network.public_ip_pools.add_public_ip_pool_capacity 
@publicIpPoolId='{{ publicIpPoolId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}' 
@@json=
'{
"byoipRangeId": "{{ byoipRangeId }}", 
"cidrBlock": "{{ cidrBlock }}"
}'
;

Moves a public IP pool to a different compartment. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

EXEC oci.network.public_ip_pools.change_compartment 
@publicIpPoolId='{{ publicIpPoolId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;

Removes a CIDR block from the referenced public IP pool.

EXEC oci.network.public_ip_pools.remove_public_ip_pool_capacity 
@publicIpPoolId='{{ publicIpPoolId }}' --required, 
@region='{{ region }}' --required, 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}' 
@@json=
'{
"cidrBlock": "{{ cidrBlock }}"
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​