NSX-T Data Center REST API
Create or update a SHA monitor profile
Create or update a SHA monitor profile.Request:
Method:
PUT
URI Path(s):
/policy/api/v1/infra/sha/monitors/{monitor-id}/profiles/{monitor-profile-id}
Request Headers:
n/a
Query Parameters:
ShaMonitorProfileUpdateParameters+
ShaMonitorProfileUpdateParameters (schema)
| Name | Description | Type | Notes |
|---|---|---|---|
| force | If true, delete protected configurations | boolean |
Request Body:
ShaMonitorProfile+
ShaMonitorProfile (schema)
| Name | Description | Type | Notes |
|---|---|---|---|
| _create_time | Timestamp of resource creation | EpochMsTimestamp | Readonly Sortable |
| _create_user | ID of the user who created this resource | string | Readonly |
| _last_modified_time | Timestamp of last modification | EpochMsTimestamp | Readonly Sortable |
| _last_modified_user | ID of the user who last modified this resource | string | Readonly |
| _links | References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink | Readonly |
| _protection | Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. |
string | Readonly |
| _revision | Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. |
int | |
| _schema | Schema for this resource | string | Readonly |
| _self | Link to this resource | SelfResourceLink | Readonly |
| _system_owned | Indicates system owned resource | boolean | Readonly |
| applied_to_group_paths | Binding Policy group paths The Policy group path list to apply the profile on Sha monitor. |
array of string | |
| applied_to_ua | Switch to control profile application on UA cluster nodes The on-off switch to control whether this profile should be applied to unified appliance cluster nodes. If not provided, profile won't be applied to UA node. |
boolean | |
| children | Subtree for this type within policy tree Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only. |
array of ChildPolicyConfigResource Children are not allowed for this type |
|
| configs | SHA monitor common configurations For the monitor with sub-monitors, these configurations will also be applied to the sub-monitors. |
ShaMonitorConfig (Abstract type: pass one of the following concrete types) ShaEdgeVodap20secMonitorConfig ShaEdgeVodap5minMonitorConfig ShaEdgeVodapAdvancedMetricsMonitorConfig ShaEsxDatapathMonitorConfig ShaEsxHealthMonitorConfig ShaEsxObsrvAlarmsMonitorConfig ShaEsxObsrvSegmentStatsFileDumpMonitorConfig ShaEsxObsrvStatsManagementConfig ShaEsxObsrvStatsMonitorConfig ShaEsxObsrvTnStatsFileDumpMonitorConfig ShaEsxResourceMonitorConfig ShaEsxTnMetricsMonitorConfig ShaEsxTnPnicMetricsMonitorConfig ShaEsxTnTopologyMetricsMonitorConfig ShaEsxTnVmknicMetricsMonitorConfig ShaEsxTnVnicMetricsMonitorConfig ShaHardwareUsageMonitorConfig ShaUaMetricMonitorConfig ShaVodapAlarmMonitorConfig |
Required |
| depend_on_monitor_configs | The configuration of depend on monitors It includes all the detail configurations of the depend on monitors. To make sure the monitor profile works as expected, it aslo needs to check the depend config on each monitor. |
array of ShaMonitorDependOnConfig | Readonly |
| description | Description of this resource | string | Maximum length: 1024 Sortable |
| display_name | Identifier to use when displaying entity in logs or GUI Defaults to ID if not set |
string | Maximum length: 255 Sortable |
| id | Unique identifier of this resource | string | Sortable |
| impact_monitors | The list of impacted monitors It includes all the impacted monitors for this profile. |
array of string | Readonly |
| is_default | Flag to indicate this is a default profile or not Flag to indicate this is a default profile or not |
boolean | Readonly |
| marked_for_delete | Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object get deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. |
boolean | Readonly Default: "False" |
| origin_site_id | A unique identifier assigned by the system for knowing which site owns an object This is a UUID generated by the system for knowing which site owns an object. This is used in NSX+. |
string | Readonly |
| overridden | Indicates whether this object is the overridden intent object Global intent objects cannot be modified locally by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties. |
boolean | Readonly Default: "False" |
| owner_id | A unique identifier assigned by the system for the ownership of an object This is a UUID generated by the system for knowing who owns this object. This is used in NSX+. |
string | Readonly |
| parent_path | Path of its parent Path of its parent |
string | Readonly |
| path | Absolute path of this object Absolute path of this object |
string | Readonly |
| realization_id | A unique identifier assigned by the system for realizing intent This is a UUID generated by the system for realizing the entity object. In most cases this should be same as 'unique_id' of the entity. However, in some cases this can be different because of entities have migrated their unique identifier to NSX Policy intent objects later in the timeline and did not use unique_id for realization. Realization id is helpful for users to debug data path to correlate the configuration with corresponding intent. |
string | Readonly |
| relative_path | Relative path of this object Path relative from its parent |
string | Readonly |
| remote_path | Path of the object on the remote end. This path is populated only in case of multi-site scenario. Currently it is supported only for LM objects. When LM is onboarded to multi-site platform like NAPP or GM, remote_path will be set to the globally unique path across multi-site topology . It is generated based on local site-name and uses /org tree namespace. Note: It is populated only for LM objects. Not supported on the GM. |
string | Readonly |
| resource_type | Must be set to the value ShaMonitorProfile | string | |
| sub_monitor_configs | SHA sub-monitor configurations Users can overwrite the configurations in the 'config' field by specifying the corresponding resource of ShaSubMonitorConfig and populate the specific configurations for sub-monitor if necessary. |
array of ShaSubMonitorConfig (Abstract type: pass one of the following concrete types) ShaEsxObsrvDatapathTrafficStatsMonitorConfig ShaEsxObsrvInfraStatsMonitorConfig |
|
| tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |
| unique_id | A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites. |
string | Readonly |
Example Request:
PUT https://<policy-mgr>/policy/api/v1/infra/sha/monitors/esx-obsrv-stats-monitor/profiles/p1 { "is_default": false, "applied_to_group_paths": [ "/infra/domains/default/groups/esxi-node-group" ], "configs": { "check_interval": 301, "resource_type": "ShaEsxObsrvStatsMonitorConfig", "enable": true }, "sub_monitor_configs": [ { "resource_type": "ShaEsxObsrvDatapathTrafficStatsMonitorConfig", "enable": false } ], "_revision": 0 }Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ShaMonitorProfile+
ShaMonitorProfile (schema)
| Name | Description | Type | Notes |
|---|---|---|---|
| _create_time | Timestamp of resource creation | EpochMsTimestamp | Readonly Sortable |
| _create_user | ID of the user who created this resource | string | Readonly |
| _last_modified_time | Timestamp of last modification | EpochMsTimestamp | Readonly Sortable |
| _last_modified_user | ID of the user who last modified this resource | string | Readonly |
| _links | References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink | Readonly |
| _protection | Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. |
string | Readonly |
| _revision | Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. |
int | |
| _schema | Schema for this resource | string | Readonly |
| _self | Link to this resource | SelfResourceLink | Readonly |
| _system_owned | Indicates system owned resource | boolean | Readonly |
| applied_to_group_paths | Binding Policy group paths The Policy group path list to apply the profile on Sha monitor. |
array of string | |
| applied_to_ua | Switch to control profile application on UA cluster nodes The on-off switch to control whether this profile should be applied to unified appliance cluster nodes. If not provided, profile won't be applied to UA node. |
boolean | |
| children | Subtree for this type within policy tree Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only. |
array of ChildPolicyConfigResource Children are not allowed for this type |
|
| configs | SHA monitor common configurations For the monitor with sub-monitors, these configurations will also be applied to the sub-monitors. |
ShaMonitorConfig (Abstract type: pass one of the following concrete types) ShaEdgeVodap20secMonitorConfig ShaEdgeVodap5minMonitorConfig ShaEdgeVodapAdvancedMetricsMonitorConfig ShaEsxDatapathMonitorConfig ShaEsxHealthMonitorConfig ShaEsxObsrvAlarmsMonitorConfig ShaEsxObsrvSegmentStatsFileDumpMonitorConfig ShaEsxObsrvStatsManagementConfig ShaEsxObsrvStatsMonitorConfig ShaEsxObsrvTnStatsFileDumpMonitorConfig ShaEsxResourceMonitorConfig ShaEsxTnMetricsMonitorConfig ShaEsxTnPnicMetricsMonitorConfig ShaEsxTnTopologyMetricsMonitorConfig ShaEsxTnVmknicMetricsMonitorConfig ShaEsxTnVnicMetricsMonitorConfig ShaHardwareUsageMonitorConfig ShaUaMetricMonitorConfig ShaVodapAlarmMonitorConfig |
Required |
| depend_on_monitor_configs | The configuration of depend on monitors It includes all the detail configurations of the depend on monitors. To make sure the monitor profile works as expected, it aslo needs to check the depend config on each monitor. |
array of ShaMonitorDependOnConfig | Readonly |
| description | Description of this resource | string | Maximum length: 1024 Sortable |
| display_name | Identifier to use when displaying entity in logs or GUI Defaults to ID if not set |
string | Maximum length: 255 Sortable |
| id | Unique identifier of this resource | string | Sortable |
| impact_monitors | The list of impacted monitors It includes all the impacted monitors for this profile. |
array of string | Readonly |
| is_default | Flag to indicate this is a default profile or not Flag to indicate this is a default profile or not |
boolean | Readonly |
| marked_for_delete | Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object get deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. |
boolean | Readonly Default: "False" |
| origin_site_id | A unique identifier assigned by the system for knowing which site owns an object This is a UUID generated by the system for knowing which site owns an object. This is used in NSX+. |
string | Readonly |
| overridden | Indicates whether this object is the overridden intent object Global intent objects cannot be modified locally by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties. |
boolean | Readonly Default: "False" |
| owner_id | A unique identifier assigned by the system for the ownership of an object This is a UUID generated by the system for knowing who owns this object. This is used in NSX+. |
string | Readonly |
| parent_path | Path of its parent Path of its parent |
string | Readonly |
| path | Absolute path of this object Absolute path of this object |
string | Readonly |
| realization_id | A unique identifier assigned by the system for realizing intent This is a UUID generated by the system for realizing the entity object. In most cases this should be same as 'unique_id' of the entity. However, in some cases this can be different because of entities have migrated their unique identifier to NSX Policy intent objects later in the timeline and did not use unique_id for realization. Realization id is helpful for users to debug data path to correlate the configuration with corresponding intent. |
string | Readonly |
| relative_path | Relative path of this object Path relative from its parent |
string | Readonly |
| remote_path | Path of the object on the remote end. This path is populated only in case of multi-site scenario. Currently it is supported only for LM objects. When LM is onboarded to multi-site platform like NAPP or GM, remote_path will be set to the globally unique path across multi-site topology . It is generated based on local site-name and uses /org tree namespace. Note: It is populated only for LM objects. Not supported on the GM. |
string | Readonly |
| resource_type | Must be set to the value ShaMonitorProfile | string | |
| sub_monitor_configs | SHA sub-monitor configurations Users can overwrite the configurations in the 'config' field by specifying the corresponding resource of ShaSubMonitorConfig and populate the specific configurations for sub-monitor if necessary. |
array of ShaSubMonitorConfig (Abstract type: pass one of the following concrete types) ShaEsxObsrvDatapathTrafficStatsMonitorConfig ShaEsxObsrvInfraStatsMonitorConfig |
|
| tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |
| unique_id | A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites. |
string | Readonly |