LTM Application Server Node¶
Overview¶
API used to create/manage LTM application server nodes allowing for distribution into pools.
REST Endpoint: /mgmt/cm/adc-core/working-config/ltm/node¶
Requests¶
POST /mgmt/cm/adc-core/working-config/ltm/node¶
Create a LTM application server node.
Request Parameters¶
Name | Type | Description |
---|---|---|
objectId | string(UUID) | Unique id assigned to application server node object. required |
Json string request body. | object | Input parameter list in json format. post_application_node_body required |
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Add an item to the properties_collection representing a BIGIP LTM application server nodes.
Name | Type | Description |
---|---|---|
generation | integer(int64) | A integer that will track change made to a node collection object. generation. optional, read-only |
items | < object > array | A collection of application server nodes. Properties defining items. optional |
kind | string | Type information for this node collection object - cm:adc-core:working-config:ltm:node:adcnodecollectionstate. optional, read-only |
lastUpdateMicros | integer(int64) | Update time (micros) for last change made to an node collection object. time. optional, read-only |
selfLink | string | A reference link URI to the application server node collection object. optional, read-only |
HTTP/1.1 400 Bad Request
Error response “Bad Request”
Name | Type | Description |
---|---|---|
errorStack | string | Error stack trace returned by java. optional, read-only |
items | < object > array | Collection of application server nodes. Errored response from server. optional |
kind | string | Type information for LTM application server nodes - errors – cm:adc-core:working-config:ltm:node:adcnodecollectionstate. optional, read-only |
message | string | Error message returned from server. optional, read-only |
requestBody | string | The data in the request body. GET (None) optional, read-only |
requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
HTTP/1.1 404 Bad Request
Error response “Public URI path not registered.”
Name | Type | Description |
---|---|---|
errorStack | string | Error stack trace returned by java. optional, read-only |
items | < object > array | Collection of application server nodes. Errored response from server. optional |
kind | string | Type information for node - cm:adc-core:working-config:ltm:node:adcnodecollectionstate. optional, read-only |
message | string | Error message returned from server. optional, read-only |
requestBody | string | The data in the request body. GET (None) optional, read-only |
requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
Permissions¶
Role | Allow |
---|---|
Local Traffic & Network Manager | Yes |
GET /mgmt/cm/adc-core/working-config/ltm/node¶
List all application server nodes.
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Retrieve the properties_collection representing all nodes.
Name | Type | Description |
---|---|---|
generation | integer(int64) | A integer that will track change made to a node collection object. generation. optional, read-only |
items | < object > array | A collection of application server nodes. Properties defining items. optional |
kind | string | Type information for this node collection object - cm:adc-core:working-config:ltm:node:adcnodecollectionstate. optional, read-only |
lastUpdateMicros | integer(int64) | Update time (micros) for last change made to an node collection object. time. optional, read-only |
selfLink | string | A reference link URI to the application server node collection object. optional, read-only |
HTTP/1.1 400 Bad Request
Error response “Bad Request”
Name | Type | Description |
---|---|---|
errorStack | string | Error stack trace returned by java. optional, read-only |
items | < object > array | Collection of application server nodes. Errored response from server. optional |
kind | string | Type information for LTM application server nodes - errors – cm:adc-core:working-config:ltm:node:adcnodecollectionstate. optional, read-only |
message | string | Error message returned from server. optional, read-only |
requestBody | string | The data in the request body. GET (None) optional, read-only |
requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
HTTP/1.1 404 Bad Request
Error response “Public URI path not registered.”
Name | Type | Description |
---|---|---|
errorStack | string | Error stack trace returned by java. optional, read-only |
items | < object > array | Collection of application server nodes. Errored response from server. optional |
kind | string | Type information for node - cm:adc-core:working-config:ltm:node:adcnodecollectionstate. optional, read-only |
message | string | Error message returned from server. optional, read-only |
requestBody | string | The data in the request body. GET (None) optional, read-only |
requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
Permissions¶
Role | Allow |
---|---|
Local Traffic & Network Manager | Yes |
GET /mgmt/cm/adc-core/working-config/ltm/node/{objectId}¶
Retrieve a single application server node object identified by id for an endpoint URI.
Request Parameters¶
None
Query Parameters¶
Name | Type | Description |
---|---|---|
objectId | string(UUID) | Unique id assigned to a application server node. required |
Response¶
HTTP/1.1 200 OK
Retrieve the properties_node representing the application server node.
Name | Type | Description |
---|---|---|
address | string | Network address for application server used for node object. optional |
connectionLimit | integer | Specifies the maximum number of connections allowed for the node or node address. optional |
deviceReference | object | Reference link to BIGIP device associated to application server node. optional |
id | string | Unique id assigned to a device referenced by this object. optional |
kind | string | Type information for device. shared:resolver:device-groups:restdeviceresolverdevicestate optional |
link | string | Reference link to adc-core-allbigipDevices in shared resolver device-groups. optional |
machineId | string | Unique id assigned to the hardware device. If virtual could be the same as id object. optional |
name | string | A name used to identify this device. optional |
fqdn | object | Specifies the node’s fully qualified domain name (FQDN) attributes. optional |
addressFamily | string | Specifies the node’s address family. The default is ‘unspecified’, or IP-agnostic optional |
downInterval | integer | Specifies the number of attempts to resolve a domain name. The default is 5. optional |
interval | string | Specifies the amount of time before sending the next DNS query. optional |
isAutoPolulate | boolean | Specifies whether the node should scale to the IP address set returned by DNS. optional |
generation | integer(int64) | A integer that will track change made to a LTM application server node object. - generation. optional, read-only |
id | string | Unique id assigned to a virtual server object. optional, read-only |
isEphemeral | boolean | Is this node short lived when forwarding application traffic. optional |
kind | string | Type information for this application server node object. - cm:adc-core:working-config:ltm:node:adcnodestate optional |
lastUpdateMicros | integer(int64) | Update time (micros) for last change made to an LTN application server node object - time. optional, read-only |
name | string | Name of LTM application server node. optional |
partition | string | Displays the administrative partition within which this node resides. optional |
rateLimit | string | Specifies the maximum number of connections per second allowed for a node or node address. The default value is ‘disabled’. optional |
ratio | string | Specifies the fixed ratio value used for a node during ratio load balancing. optional |
selfLink | string | A reference link URI to the LTM application server node object. optional, read-only |
sessionConfig | string | Enables or disables the node for new sessions. The default value is user-enabled. optional |
stateConfig | string | Marks the node up or down. The default value is user-up. optional |
HTTP/1.1 400 Bad Request
Error response “Bad Request”
Name | Type | Description |
---|---|---|
errorStack | string | Error stack trace returned by java. optional, read-only |
items | < object > array | Collection of application server nodes. Errored response from server. optional |
kind | string | Type information for LTM application server nodes - errors – cm:adc-core:working-config:ltm:node:adcnodecollectionstate. optional, read-only |
message | string | Error message returned from server. optional, read-only |
requestBody | string | The data in the request body. GET (None) optional, read-only |
requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
HTTP/1.1 404 Bad Request
Error response “Public URI path not registered.”
Name | Type | Description |
---|---|---|
errorStack | string | Error stack trace returned by java. optional, read-only |
items | < object > array | Collection of application server nodes. Errored response from server. optional |
kind | string | Type information for node - cm:adc-core:working-config:ltm:node:adcnodecollectionstate. optional, read-only |
message | string | Error message returned from server. optional, read-only |
requestBody | string | The data in the request body. GET (None) optional, read-only |
requestOperationId | integer(int64) | Unique id assigned to rest operation. optional, read-only |
Permissions¶
Role | Allow |
---|---|
Local Traffic & Network Manager | Yes |
Examples¶
None