APIRef_tm_gtm_datacenter¶
mgmt/tm/gtm/datacenter
Data center configuration
REST Endpoints
- Collection URI
/mgmt/tm/gtm/datacenter- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/gtm/datacenter/~resource id- Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST- Resource Natural Key
name, subPath
Properties
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
appService |
string | optional | read/write | The application service that the object belongs to. | |
contact |
string | optional | read/write | Specifies the name of the administrator or the name of the department that manages the data center. | |
description |
string | optional | read/write | User defined description. | |
disabled |
boolean | true | optional | read/write | Specifies that the data center and its resources are not available for load balancing. |
enabled |
boolean | true | optional | read/write | Specifies that the data center and its resources are available for load balancing. |
location |
string | optional | read/write | Specifies the physical location of the data center. | |
proberFallback |
string | any-available | optional | read/write | Specifies the type of prober to use for monitoring servers in the data center when the preferred type is not available. |
proberPool |
string | optional | read/write | Optional prober pool used to monitor the data center’s virtual servers. | |
proberPreference |
string | inside-datacenter | optional | read/write | Specifies the type of prober to use for monitoring servers in the data center. |
Array Structures
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
/metadata |
array_structure | optional | read/write | User defined generic data for the data center. It is a name and value pair. | |
/metadata/app-service |
string | optional | read/write | The application service that the object belongs to. | |
/metadata/persist |
string | true | optional | read/write | Specifies whether the command “tmsh save sys config” will save the metadata entry to the configuration files. |
/metadata/value |
string | optional | read/write | Value of the data center metadata |
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.
The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.