IPAddressPool class

The IPAddressPool class represents a collection of IP address resources made available to the cloud.

IPAddressPool class APIs

The following tables list the basic APIs, operation APIs, and relationship APIs for the IPAddressPool class.

Basic APIs

Name

HTTP
method

URI

Description

get

GET

csm/IPAddressPool/guid

Retrieves a IPAddressPool object.

search

POST

csm/IPAddressPool/search

Searches for IPAddressPool objects.

Operation APIs

The IPAddressPool class has no operation APIs.

Relationship APIs

Name

HTTP
method

URI

Description

relation

GET

csm/IPAddressPool/guid/networkContainer

Retrieves the networkContainer relationship.

relation

GET

csm/IPAddressPool/guid/pod

Retrieves the pod relationship.

relation

GET

csm/IPAddressPool/guid/logicalAddressPool

Retrieves the logicalAddressPool relationship.

relation

GET

csm/IPAddressPool/guid/tickets

Retrieves the tickets relationship.

relation

GET

csm/IPAddressPool/guid/provider

Retrieves the provider relationship.

relation

GET

csm/IPAddressPool/guid/tags

Retrieves the tags relationship.

IPAddressPool class relationships and attributes

The following tables list the relationships and attributes of the IPAddressPool class.

Relationships

Name

Type

Multi-
plicity

Description

networkContainer

NetworkContainer

0..1

Network container the IP address pool is assigned to

pod

Pod

0..1

Pod the IP address is associated with

logicalAddressPool

LogicalAddressPool

1

tickets

Ticket

0..*

cloudClass

CloudClass

1

Fully-qualified name of the class to which the object belongs

provider

Provider

1

Provider that created the object

tags

Tag

0..*

Tags associated with the object

Attributes

Name

Type

Multi-
plicity

Description

isNat

Boolean

1

poolSize

Integer

1

addressType

AddressType

1

defaultGateway

String

0..1

networkAddress

String

1

subnetMask

String

1

isOnboarded

Boolean

1

Indicates whether the object is onboarded

externalID

String

0..1

Identifier used for the object by an external provider

owner

String

0..1

Name of the owner of the object

reconciliationID

String

0..1

Reconciliation identity value for the object from the BMC Atrium CMDB

tokenID

String

0..1

Token identifier

description

String

0..1

Text that describes the object

guid

String

1

Globally unique identifier for the object

labels

String

0..*

modifiedDate

Date

0..1

Date the Cloudobject was modified

name

String

1

Human-readable name of the object

Was this page helpful? Yes No Submitting... Thank you

Comments