Methods
checkTask(taskPath, taskIdToCheck, optionsopt) → {Promise}
Checks status of iControl REST task
Parameters:
| Name | Type | Attributes | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
taskPath |
String | URL that created the task |
|||||||||
taskIdToCheck |
String | ID of task as returned by create |
|||||||||
options |
Object |
<optional> |
Options for parsing task response Properties
|
Returns:
A promise which is resolved with true if the task completes successfully, resolved with false if task goes to error state or rejected if some other error occurs.
- Type
- Promise
forceResetUserPassword(user) → {Promise}
Force resets a user's password, even if the oldPassword is not known.
Parameters:
| Name | Type | Description |
|---|---|---|
user |
String | user to reset |
Returns:
A promise which is resolved when the operation is complete or rejected if an error occurs.
- Type
- Promise
getDataFromPropPath(pathArray, obj) → {*}
Gets the value from an Object's property using a provided Object property path. An empty property name in the path fetches all keys in the current Object.
Parameters:
| Name | Type | Description |
|---|---|---|
pathArray |
Array.<String> | Array of properties to traverse through. |
obj |
Object | Object to traverse. |
Returns:
Data that was fetched from the property.
- Type
- *
getLicenseProvider(poolName, options)
Gets a license provider based on api type or version
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
poolName |
String | The name of the license pool |
||||||||||||
options |
Object | Options Properties
|