Health

You can use REST API calls to perform a status change about the health of your network segmentation groups.
new for 5.11. Will provide example later.

The following table lists the properties that can be used in the body of a health-related request and/or are provided in the response body. (In the "Optional" column, if a default value is applicable, it is listed in angle brackets (< >).)

Resource: Health

Property Name Type Editable Sort/Filter Optional in Request/Response Body? Description
groupCount number no None No The number of network segmentation groups
consolidatedStatus String <Enum> Yes None No

The current status of the groups as a whole: ACTIVE, OUT_OF_SYNC, CONNECTION_ERROR, SYNCHRONIZING, SYNCHRONIZED

If the "status" is "OUT_OF_SYNC", or "ACTIVE", a state change to "SYNCHRONIZED" is allowed on the PUT. This will trigger the synchronize state change on all groups that are not "connection_error" or "synchronizing" status.

Properties URIs and Actions

The following table indicates the URIs that you can append to the root URI, along with the actions you can take, and possible return codes you can receive.

Property URIs and Actions

URI Action Description Return Codes
/networkSegmentationGroups/health PUT Allows a state change on the overall health of the groups to "synchronized". See "consolidated status" above for the behavior.

200- OK

401 - Unauthorized
Parent topic: Network Segmentation Groups