HighAvailability

[tags: INTERNAL]

Resource Root

https://localhost:8443/api/rest//high-availability

Summary

Resources	Methods
https://localhost:8443/api/rest//high-availability	GET Retrieves the current high availability configuration from the server. PUT Updates the settings for high availability .
https://localhost:8443/api/rest//high-availability/component-state	POST .
https://localhost:8443/api/rest//high-availability/status	GET . PUT .
https://localhost:8443/api/rest//high-availability/config-partner	POST .
https://localhost:8443/api/rest//high-availability/arping-timeout	PUT .
https://localhost:8443/api/rest//high-availability/{host-identifier}/release-resources	POST .
https://localhost:8443/api/rest//high-availability/release-resources	POST .
https://localhost:8443/api/rest//high-availability/cancel-release-resources	POST .

Resources

https://localhost:8443/api/rest//high-availability

Methods

GET

Retrieves the current high availability configuration from the server

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-high-availability-config+xml application/vnd.plcm.plcm-high-availability-config+json	Request for High Availability configuration was successful
304		The high availability configuration has not changed. Note: The API client must provide the "plcm-high-availability-config" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical search in the "If-None-Match" header, then the HTTP response will contain the search results in the message body. The "plcm-high-availability-config" ETag can be accessed from the initial search result's HTTP response header. Also, subsequent searches require the identical search filter to ensure an equivalent ETag value. This also assumes no other client made changes to the active call on the server.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid credentials.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. Retrieving high availability config requires administrator role.

PUT

Updates the settings for high availability

Request

Representations

application/vnd.plcm.plcm-high-availability-config+xml

application/vnd.plcm.plcm-high-availability-config+json

Response

Status	Representation	Description
204		High availability settings were applied successfully
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Bad request. One or more fields have violated a constraint. The request should not be resubmitted without correcting the field(s).
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid credentials.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. Updating high availability config requires administrator role.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	group-password field cannot be null or empty
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	local-node is read-only and does not match the server's value.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Node list cannot be empty.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	cidr-mask field is read-only and cannot be modified -- this is only validated from the HA Agent
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	gateway field is read-only and cannot be modified -- this is only validated from the HA Agent
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	associated-device-name field is not a recognized device or order of interfaces has changed.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	physical-address mismatch. physical-address field is read-only.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Crossover link cannot have a virtual address or virtual hostname.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	No peer address specified for HA link.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Peer address specified for HA link is not within the same subnet as the paired physical address.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	virtual-address must be on the same subnet as the physical-address
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	virtual-hostname was not a valid hostname.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	An invalid or empty virtual-address was specified on an interface that did not have an HA link specified.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Configuration must contain at least one HA link and one virtual address to be valid.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Configuration must contain at least one HA link and one virtual address to be valid.
412	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The high availability config resource has changed on the server. Note: The response will contain the ETag value and link that reflects the server's user resource in the HTTP response header. The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-high-availability-config.xsd" for details. If the message body does not contain the ETag value, the server will look for the ETag in the "If-Match" header.
428	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-high-availability-config.xsd" for details. If the message body does not contain the ETag value, the server will look for the ETag in the "If-Match" header.

https://localhost:8443/api/rest//high-availability/component-state

Methods

POST

Request

Query Parameters

Name	Type	Description
component	xs:string	The component parameter represents the component for which the method is being called. For example, a monitor process could potentially POST to an application server that the high availability agent service is DOWN. See the following for the allowed values: plcm-high-availability-component-state-types.yang, or plcm-high-availability-component-state-types.xsd, or PlcmHighAvailabilityComponent.java
state	xs:string	The state parameter represents the current state of the component for which the method is being called. For example, a monitor process could potentially POST to an application server that the high availability agent service is DOWN. See the following for the allowed values: plcm-high-availability-component-state-types.yang, or plcm-high-availability-component-state-types.xsd, or PlcmHighAvailabilityComponentState.java

Response

Status	Representation	Description
204		The response from this action only indicates the command was received successfully but does not block waiting for the event to be fully processed.
401		Invalid credentials.
409		The state parameter was not a recognized state.

https://localhost:8443/api/rest//high-availability/status

Methods

GET

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-high-availability-status+xml application/vnd.plcm.plcm-high-availability-status+json	Status successfully returned.
304		The high availability status has not changed. Note: The API client must provide the "plcm-high-availability-status" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical search in the "If-None-Match" header, then the HTTP response will contain the search results in the message body. The "plcm-high-availability-status" ETag can be accessed from the initial search result's HTTP response header. Also, subsequent searches require the identical search filter to ensure an equivalent ETag value. This also assumes no other client made changes to the active call on the server.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid credentials.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. Retrieving high availability status requires administrator role.

PUT

Request

Representations

application/vnd.plcm.plcm-high-availability-status+xml

application/vnd.plcm.plcm-high-availability-status+json

Response

Status	Representation	Description
204		Status successfully updated.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Bad request. One or more fields have violated a constraint. The request should not be resubmitted without correcting the field(s).
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid credentials.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Updating the status can only be performed by the HA agent using secret credentials.

https://localhost:8443/api/rest//high-availability/config-partner

Methods

POST

Request

Representations

application/vnd.plcm.plcm-rest-login-details+xml

application/vnd.plcm.plcm-rest-login-details+json

Response

Status	Representation	Description
204		Partner was successfully configured.
401		Invalid credentials.
409		Invalid credentials for the partner node.
409		See the possible responses for the PUT for updating the HA configuration.

https://localhost:8443/api/rest//high-availability/arping-timeout

Methods

PUT

Request

Representations

application/vnd.plcm.plcm-high-availability-arping-timeout+xml

application/vnd.plcm.plcm-high-availability-arping-timeout+json

Response

Status	Representation	Description
204		Timeout was successfully configured.
401		Invalid credentials.
409		System is not in HA mode.
409		See the possible responses for the PUT for updating the HA configuration.

https://localhost:8443/api/rest//high-availability/{host-identifier}/release-resources

Methods

POST

Request

Query Parameters

Name	Type	Description

force-release	xs:string	Optional parameter used to force release of resources at the application. The HA agent ignores this parameter since it is meaningless.

Response

Status	Representation	Description
204		Command was received successfully.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid credentials.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The host-identifier was not recognized as a valid host-identifier.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The host-identifier was an unknown host-identifier.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The resources specified by host-identifier are not owned by this node.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The host-identifier is this node.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. Releasing resources requires administrator role.

https://localhost:8443/api/rest//high-availability/release-resources

Methods

POST

Request

Query Parameters

Name	Type	Description
force-release	xs:string	Optional parameter used to force release of resources at the application. The HA agent ignores this parameter since it is meaningless.

Response

Status	Representation	Description
204		Command was received successfully.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid credentials.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. Releasing resources requires administrator role.

https://localhost:8443/api/rest//high-availability/cancel-release-resources

Methods

POST

Response

Status	Representation	Description
204		Command was received successfully.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid credentials.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. Releasing resources requires administrator role.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Request not valid for HA Agent.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	No release is pending.