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.

LoadBalancerNetworkInterface class

The LoadBalancerNetworkInterface class represents the network interface for a load balancer.

LoadBalancerNetworkInterface class APIs

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

Basic APIs

Name

HTTP
method

URI

Description

get

GET

csm/LoadBalancerNetworkInterface/guid

Retrieves a LoadBalancerNetworkInterface object.

search

POST

csm/LoadBalancerNetworkInterface/search

Searches for LoadBalancerNetworkInterface objects.

Operation APIs

The LoadBalancerNetworkInterface class has no operation APIs.

Relationship APIs

Name

HTTP
method

URI

Description

relation

GET

csm/LoadBalancerNetworkInterface/guid/clientLoadBalancer

Retrieves the clientLoadBalancer relationship.

relation

GET

csm/LoadBalancerNetworkInterface/guid/clientLoadBalancerPool

Retrieves the clientLoadBalancerPool relationship.

relation

GET

csm/LoadBalancerNetworkInterface/guid/serverLoadBalancer

Retrieves the serverLoadBalancer relationship.

relation

GET

csm/LoadBalancerNetworkInterface/guid/serverLoadBalancerPool

Retrieves the serverLoadBalancerPool relationship.

relation

GET

csm/LoadBalancerNetworkInterface/guid/computeContainer

Retrieves the computeContainer relationship.

relation

GET

csm/LoadBalancerNetworkInterface/guid/destinationNetworkPath

Retrieves the destinationNetworkPath relationship.

relation

GET

csm/LoadBalancerNetworkInterface/guid/host

Retrieves the host relationship.

relation

GET

csm/LoadBalancerNetworkInterface/guid/ipAddresses

Retrieves the ipAddresses relationship.

relation

GET

csm/LoadBalancerNetworkInterface/guid/network

Retrieves the network relationship.

relation

GET

csm/LoadBalancerNetworkInterface/guid/sourceNetworkPath

Retrieves the sourceNetworkPath relationship.

relation

GET

csm/LoadBalancerNetworkInterface/guid/zone

Retrieves the zone relationship.

relation

GET

csm/LoadBalancerNetworkInterface/guid/computeContainerNetworkInterface

Retrieves the computeContainerNetworkInterface relationship.

relation

GET

csm/LoadBalancerNetworkInterface/guid/loadBalancingServiceNetworkInterface

Retrieves the loadBalancingServiceNetworkInterface relationship.

relation

GET

csm/LoadBalancerNetworkInterface/guid/logicalFirewallInterface

Retrieves the logicalFirewallInterface relationship.

relation

GET

csm/LoadBalancerNetworkInterface/guid/logicalLoadBalancerInterface

Retrieves the logicalLoadBalancerInterface relationship.

relation

GET

csm/LoadBalancerNetworkInterface/guid/resourceNetwork

Retrieves the resourceNetwork relationship.

relation

GET

csm/LoadBalancerNetworkInterface/guid/provider

Retrieves the provider relationship.

relation

GET

csm/LoadBalancerNetworkInterface/guid/tags

Retrieves the tags relationship.

LoadBalancerNetworkInterface class relationships and attributes

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

Relationships

Name

Type

Multi-
plicity

Description

clientLoadBalancer

LoadBalancer

0..1

Associated client load balancer

clientLoadBalancerPool

LoadBalancerPool

0..*

Associated client load balancer pools

serverLoadBalancer

LoadBalancer

0..1

Associated server load balancer

serverLoadBalancerPool

LoadBalancerPool

0..*

Associated server load balancer pools

computeContainer

ComputeContainer

0..1

Associated compute container

destinationNetworkPath

NetworkPath

0..*

Associated destination network path

host

Server

1

Server access via the NIC

ipAddresses

IPAddress

1..*

IP addresses assigned to the NIC

network

Network

1..*

Associated network

sourceNetworkPath

NetworkPath

0..*

Associated source network path

zone

Zone

1

Associated zone

computeContainerNetworkInterface

ComputeContainerNetworkInterface

0..*

Realized compute container network interfaces

loadBalancingServiceNetworkInterface

LoadBalancingServiceNetworkInterface

0..*

Realized load balancing service network interfaces

logicalFirewallInterface

LogicalFirewallInterface

0..1

logicalLoadBalancerInterface

LogicalLoadBalancerInterface

1

resourceNetwork

ResourceNetwork

1..*

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

isTemplate

Boolean

1

Indicates whether the load balancer network interface is a template

isDHCP

Boolean

1

Indicates whether the interface uses DHCP

isPublicIP

Boolean

0..1

lanID

String

1

Local area network identifier

macAddress

String

0..1

MAC Address

networkLabel

String

1

Network label

nicNumber

Integer

1

Network interface card number

switch

String

0..1

Switch

switchPort

String

0..1

Switch port

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

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