Class: BigIpGtm

BigIpGtm(bigIpCore, optionsopt)

Provides GTM functionality to a base BigIp object

Constructor

new BigIpGtm(bigIpCore, optionsopt)

GTM constructor

Parameters:
Name Type Attributes Description
bigIpCore Object

Base BigIp object.
options Object <optional>

Optional parameters.

Properties
Name Type Attributes Description
logger Object <optional>

Logger to use. Or, pass loggerOptions to get your own logger.
loggerOptions Object <optional>

Options for the logger. See module:logger.getLogger for details.

Methods

setPartition(partition)

Sets the partition to use for future requests on this instance

Parameters:
Name Type Description
partition String

The partition to use

updatePool(poolName, serverName, virtualSservers, optionsopt) → {Promise}

Updates the A record for a GTM pool with the list of virtual servers

Parameters:
Name Type Attributes Description
poolName String

Name of pool to update
serverName String

Name of the server to update
virtualSservers Array.<Object>

Array of virtual servers to set for the pool

{
    name: <name>
}
options Object <optional>

Optional parameters

Properties
Name Type Attributes Description
monitor String <optional>

Full path to monitor for pool
loadBalancingMode String <optional>

Load balancing mode for pool
Returns:

A promise which is resolved if succssful or rejected if an error occurs

Type
Promise

updateServer(serverName, virtualSservers, optionsopt) → {Promise}

Updates a GTM server

Parameters:
Name Type Attributes Description
serverName String

Name of the server to update
virtualSservers Array.<Object>

Array of virtual servers to set for the server

{
    name: <name>
    ip: <ip_address>
    port: <port>
}
options Object <optional>

Optional parameters

Properties
Name Type Attributes Description
datacenter String <optional>

Datacenter for server
monitor String <optional>

Full path to monitor for server
Returns:

A promise which is resolved if succssful or rejected if an error occurs

Type
Promise