Unsupported content

 

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

IPAddress class

The IPAddress class represents an IP address.

IPAddress class APIs

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

Basic APIs

Name

HTTP
method

URI

Description

get

GET

csm/IPAddress/guid

Retrieves a IPAddress object.

search

POST

csm/IPAddress/search

Searches for IPAddress objects.

Operation APIs

The IPAddress class has no operation APIs.

Relationship APIs

Name

HTTP
method

URI

Description

relation

GET

csm/IPAddress/guid/nic

Retrieves the nic relationship.

relation

GET

csm/IPAddress/guid/resourceSet

Retrieves the resourceSet relationship.

relation

GET

csm/IPAddress/guid/provider

Retrieves the provider relationship.

relation

GET

csm/IPAddress/guid/tags

Retrieves the tags relationship.

IPAddress class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

nic

NetworkInterface

1

Network interface to which the IP address is assigned

resourceSet

ResourceSet

0..1

Associated network resource set

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

addressType

String

0..1

Corresponds to ProtocolType in CDM, which can be IPv4, IPv6 or other

defaultGateway

String

0..1

Default gateway

domainOrder

String

0..1

domainSuffix

String

0..1

ipAddress

String

1

IP address

isPublic

Boolean

1

Indicates whether the IP address is public

primaryDNS

String

0..1

secondaryDNS

String

0..1

subnet

String

1

IP subnet

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

name

String

1

Human-readable name of the object

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Comments