Functions that only pertain to BIG-IQ clustering, not BIG-IP
Methods
(static) addSecondary(failoverPeerIp, failoverPeerUsername, failoverPeerPassword, rootPassword, testOptsopt) → {Promise}
Configures the specified failover peer as a secondary in a BIQ-IQ High Availability configuration
Parameters:
| Name | Type | Attributes | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
failoverPeerIp |
String | IP address of the failover peer |
|||||||||
failoverPeerUsername |
String | Username of the admin user on the failover peer |
|||||||||
failoverPeerPassword |
String | Password of the admin user on the failover peer |
|||||||||
rootPassword |
String | Password of the root user on the failover peer |
|||||||||
testOpts |
Object |
<optional> |
testOpts - Options used during testing Properties
|
Returns:
A Promise which is resolved with the status of the BIG-IQ peering task
- Type
- Promise
(static) waitForPeered(task, retryOptionsopt) → {Promise}
Polls the status of a BIG-IQ high-availability peering task.
Parameters:
| Name | Type | Attributes | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
task |
String | Task ID value from BIG-IQ add-peer-task call |
|||||||||||||
retryOptions |
Object |
<optional> |
Options for retrying the request. Properties
|
Returns:
A Promise which is resolved with the peering task response or a peering task failure message
- Type
- Promise
(static) waitForPeerReady(remoteBigIp, failoverPeerIp, failoverPeerUsername, failoverPeerPassword) → {Promise}
Polls the failover peer BIG-IQ in a high-availabilty configuration to see if the failover peer is ready to accept a peering task request.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
remoteBigIp |
Object | BIG-IQ instance for the failover peer BIG-IQ |
|
failoverPeerIp |
String | IP address of the failover peer |
|
failoverPeerUsername |
String | Username of the admin user on the failover peer |
|
failoverPeerPassword |
String | Password of the admin user on the failover peer |
|
retryOptions.maxRetries |
Integer |
<optional> |
Number of times to retry if first |
retryOptions.retryIntervalMs |
Integer |
<optional> |
Milliseconds between retries. |
Returns:
A Promise which is resolved when the failover peer BIG-IQ is ready, or an error if the BIG-IQ is not ready within the retry period
- Type
- Promise