3.1.5.15 servers

The servers resource represents a physical server that is being controlled by the Network Controller. The network controller controls all the physical servers that the client adds to the network.

It is invoked through the following URI.

 https://<url>/networking/v1/servers/{resourceId}

url: The address or name of the REST server of the Network Controller.

resourceId: the identifier for the specific resource within the resource type. See section 2.2.3.4 for more details.

Note  The server MAY support additional versions, besides v1 in the URI.

The following HTTP methods can be performed on this resource.

HTTP method

Section

Description

PUT

3.1.5.15.1.1

Create a new servers resource or update an existing servers resource.

GET

3.1.5.15.1.2

Get one servers resource.

GET ALL

3.1.5.15.1.3

List all servers resources in the Network Controller.

DELETE

3.1.5.15.1.4

Deletes a servers resource.

The following property elements are valid.

Element name

Type

Description

etag

Read-only

Specified in Common JSON Elements, section 2.2.2.

provisioningState

Read-only

Specified in Common JSON Elements, section 2.2.2.

connections

Indicates an array of connections that specifies the information needed to connect to the specific device for the purposes of managing and controlling the device.

connections.credential

Reference to a credentials resource that can be used to connect to the device for management purposes.

connections.credentialType

See credentials resource, section 3.1.5.2.

connections.managementAddresses

The management address used to connect to the server.  This can be in the form of an IPv4 IP address, an IPv6 IP address, or a DNS name.

model

Optional

Model number of the server.

networkInterfaces

Optional

An array of network interfaces this server has.  See networkInterfaces resource, section 3.1.5.15.2, for more details. These networkInterfaces resources will be automatically created based on the physical network interface cards the server has.  They cannot be created or deleted but can have their properties updated.

os

Optional

Identifies the operating system running on the server.

rackSlot

Optional

Indicates the slot in the rack in which the server has been plugged.

serial

Optional

Indicates the serial number of the server. 

vendor

Optional

Indicates the name of the server's vendor.

certificate

The encoded representation of the certificate that the Network Controller accepts when the server (host) represented by this REST resource connects to the controller.

configurationState

Optional
Read-only

Indicates the configuration state for the server (host). See definition in section 2.2.4.
The values are the same as for network interfaces and load Balancer MUX.

VirtualNetworkInterfaces

Optional
Read-only

Indicates an array of references to the virtual network interfaces that are hosted on this server.

This property supported with URI version v2 and later.

auditingEnabled

Optional

A string array that is a list of a combination of the following strings: Disabled, or Firewall.

If both Firewall and Disabled are present, the state is disabled. Firewall is the only kind of auditing currently supported.

This property is supported with URI version v3 and later.