DMA Supercluster

[tags: DMA]

Resource Root

https://localhost:8443/api/rest/dma-supercluster

Summary

Resources	Methods
https://localhost:8443/api/rest/dma-supercluster	GET Retrieve the current supercluster status of the DMA. POST Join this DMA cluster to another target DMA cluster. POST Invite this DMA cluster to join a target DMA supercluster. POST Request that the receiving DMA send a supercluster join invitation to another DMA node.
https://localhost:8443/api/rest/dma-supercluster/check-compatibility	GET Validates if the server is compatible to join the requesting supercluster.
https://localhost:8443/api/rest/dma-supercluster/{value}	GET Get the status of a cluster that is a member of the supercluster. DELETE Removes a cluster from the supercluster.
https://localhost:8443/api/rest/dma-supercluster/{value}/set-service-status	POST Sets the service status for the specified cluster of the supercluster.
https://localhost:8443/api/rest/dma-supercluster/{value}/restart-services	POST Restart the services for the specified cluster of the supercluster.
https://localhost:8443/api/rest/dma-supercluster/{value}/reset-services	POST Reset the services for the specified cluster of the supercluster.

Resources

https://localhost:8443/api/rest/dma-supercluster

Methods

GET

Retrieve the current supercluster status of the DMA.

[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-dma-supercluster+xml application/vnd.plcm.plcm-dma-supercluster+json	Supercluster status successfully retrieved.
304		Supercluster status has not changed since the last get. Note: The API client must provide the "plcm-dma-supercluster" 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-dma-supercluster" 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 supercluster on the server.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. DMA roles required: administrator, provisioner

POST

Join this DMA cluster to another target DMA cluster.

If the target DMA cluster is free-standing (not superclustered), a new supercluster
will be formed with both DMA clusters becoming members of the new supercluster. The
local data store will be largely replaced by a copy of the data from the target DMA
cluster; this data becomes the shared supercluster data store.

If the target system is a member of an existing supercluster, this cluster will
become a member in that supercluster. The local data store will be largely replaced
by a copy of the data of that supercluster's existing shared data store.

Fields required: host address, username, password

Note: This API call is no longer supported in DMA 9.0 and higher

This method has been replaced by the following API methods
inviteToJoinDmaSupercluster
sendInviteToJoinDmaSupercluster

DMA roles required: administrator

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-dma-supercluster-join+xml

application/vnd.plcm.plcm-dma-supercluster-join+json

Response

Status	Representation	Description
201		The request to join the supercluster was processed successfully.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Bad request.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The supplied credentials do not have permission to join the supercluster.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The hostname must be provided.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The supplied hostname contains invalid characters.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Hostname must be between 1 and 60 characters in length, inclusive.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Username is required.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Username must be between 1 and 30 characters in length, inclusive.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Password must be between 1 and 30 characters in length, inclusive.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Initial host list must have at least one member.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster while already part of a supercluster.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster while NTP is not configured on the local cluster.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster while in Maximum Security Mode.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot form a supercluster with the local cluster.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot locate the specified hostname.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster while currently a member of a supercluster.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster while a peer server in the cluster is down.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot form a supercluster with a server that is not a DMA system.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster that has reached its maximum cluster count limit (5).
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster with incompatible security settings.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster with incompatible licensing settings.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster where local addresses conflict with the supercluster's external SIP or gatekeeper addresses.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster if the supercluster cannot resolve the local cluster's hostname.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster if the supercluster cannot connect to the local cluster via its fully qualified hostname.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot form a supercluster while the target cluster does not have NTP configured.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster with an incompatible system version.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster while a hostname in the supercluster cannot be resolved.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster while unable to communicate with a server.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join supercluster. The target cluster does not support the necessary supercluster functions.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join supercluster. The connection failed while trying to communicate with the supercluster.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join supercluster. The target cluster experienced an internal error. For further details, check the logs on the target cluster.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Failed to join supercluster.
504	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The connection timed out while trying to join the supercluster.

POST

Invite this DMA cluster to join a target DMA supercluster.
This API is meant to be used internally between two DMAs

If the DMA being invited is not part of a supercluster, it will join itself to the
target DMA supercluster. The local data store will be largely replaced by a copy of
the data from the target DMA cluster; this data becomes part of the shared supercluster
data store.

If the target system is a member of an existing supercluster, the request will be
rejected.

Note: This method is only supported in DMA 9.0 and higher

DMA roles required: administrator

[tags: DMA_INTERNAL]

Request

Representations

application/vnd.plcm.plcm-dma-invite-to-join-supercluster+xml

application/vnd.plcm.plcm-dma-invite-to-join-supercluster+json

Response

Status	Representation	Description
201		The request to join the supercluster was processed successfully.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Bad request.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The supplied credentials do not have permission to join the supercluster.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The group name must be provided.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Group name must be between 1 and 256 characters in length, inclusive.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Password is required.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Password must be between 1 and 30 characters in length, inclusive.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	DMA version of the target supercluster is required.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Version of the target supercluster is not compatible.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster while already part of a supercluster.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster while NTP is not configured on the local cluster.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster while in Maximum Security Mode.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot form a supercluster with the local cluster.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot locate the specified hostname.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster while currently a member of a supercluster.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster while a peer server in the cluster is down.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot form a supercluster with a server that is not a DMA system.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster that has reached its maximum cluster count limit (5).
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster with incompatible security settings.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster with incompatible licensing settings.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster where local addresses conflict with the supercluster's external SIP or gatekeeper addresses.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster if the supercluster cannot resolve the local cluster's hostname.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster if the supercluster cannot connect to the local cluster via its fully qualified hostname.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot form a supercluster while the target cluster does not have NTP configured.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster with an incompatible system version.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster while a hostname in the supercluster cannot be resolved.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster while unable to communicate with a server.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join supercluster. The target cluster does not support the necessary supercluster functions.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join supercluster. The connection failed while trying to communicate with the supercluster.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join supercluster. The target cluster experienced an internal error. For further details, check the logs on the target cluster.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Failed to join supercluster.
504	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The connection timed out while trying to join the supercluster.

POST

Request that the receiving DMA send a supercluster join invitation to another
DMA node.

If the DMA being invited is not part of a supercluster, it will join itself to the
target DMA supercluster. The local data store will be largely replaced by a copy of
the data from the target DMA cluster; this data becomes part of the shared supercluster
data store.

If the target system is a member of an existing supercluster, the request will be
rejected.

Note: This method is only supported in DMA 9.0 and higher

DMA roles required: administrator

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-dma-send-invite-to-join-supercluster+xml

application/vnd.plcm.plcm-dma-send-invite-to-join-supercluster+json

Response

Status	Representation	Description
201		The request to join the supercluster was processed successfully.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Bad request.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The supplied credentials do not have permission to join the supercluster.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The group name must be provided.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Group name must be between 1 and 256 characters in length, inclusive.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Password is required.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Password must be between 1 and 30 characters in length, inclusive.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster while already part of a supercluster.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster while NTP is not configured on the local cluster.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster while in Maximum Security Mode.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot form a supercluster with the local cluster.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot locate the specified hostname.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster while currently a member of a supercluster.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster while a peer server in the cluster is down.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot form a supercluster with a server that is not a DMA system.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster that has reached its maximum cluster count limit (5).
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster with incompatible security settings.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster with incompatible licensing settings.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster where local addresses conflict with the supercluster's external SIP or gatekeeper addresses.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster if the supercluster cannot resolve the local cluster's hostname.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster if the supercluster cannot connect to the local cluster via its fully qualified hostname.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot form a supercluster while the target cluster does not have NTP configured.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster with an incompatible system version.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster while a hostname in the supercluster cannot be resolved.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join a supercluster while unable to communicate with a server.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join supercluster. The target cluster does not support the necessary supercluster functions.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join supercluster. The connection failed while trying to communicate with the supercluster.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Cannot join supercluster. The target cluster experienced an internal error. For further details, check the logs on the target cluster.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Failed to join supercluster.
504	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The connection timed out while trying to join the supercluster.

https://localhost:8443/api/rest/dma-supercluster/check-compatibility

Methods

GET

Validates if the server is compatible to join the requesting supercluster.
[tags: DMA_INTERNAL]

Request

Query Parameters

Name	Type	Description
peer-version	xs:string	Application version of the requesting supercluster
proxy-addresses	xs:string	An encoded list of external proxy addresses to check for conflicts with.
security-settings	xs:string	An encoded list of security settings to check for conflicts with.

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-dma-supercluster-compatibility-status+xml application/vnd.plcm.plcm-dma-supercluster-compatibility-status+json	Compatibility check was processed successfully. See response body for results.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. DMA roles required: administrator

https://localhost:8443/api/rest/dma-supercluster/{value}

Template Parameters

Name	Type	Description
value	xs:string	Unique hostname or identifier of the cluster.

Methods

GET

Get the status of a cluster that is a member of the supercluster.

[tags: DMA]

Request

Query Parameters

Name	Type	Description

type	xs:string	Specifies an enumerated type that will indicate that the resource should be read by its human-readable name or immutable, unique identifier such as a UUID, integer, etc. The purpose of allowing the API client to specify an enumerated type ensures the option to read this resource by its human-readable name. In the case of a hostname, the name should typically be available as specified when the object is defined; however, it may sometimes be necessary to specify a fully qualified host name. Once defined, the resource is assigned an immutable, unique identifier that can be retrieved in the entity body; the API client has the option of reading this resource by that identifier. Note 1: The URL form is https://{host}:{port}/api/rest/resource/{value}?type={name\|id} Note 2: If the "name" enumeration is specified, then the value should correspond to the cluster name. Otherwise, the resource cannot be found. Note 3: If the "id" enumeration is specified, then the value should correspond to the unique identifier. Otherwise, the resource cannot be found. Note 4: The read operation will default to the "id" type enumeration. As a result, the {value} parameter can simply specify the unique identifier and the query parameter, "?type=id" is not required.

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-dma-supercluster-cluster+xml application/vnd.plcm.plcm-dma-supercluster-cluster+json	Cluster status successfully retrieved.
304		Cluster status has not changed since the last get. Note: The API client must provide the "plcm-dma-supercluster-cluster" 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-dma-supercluster-cluster" 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 cluster on the server.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. DMA roles required: administrator, provisioner
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	No such cluster can be found as a member of the supercluster.

DELETE

Removes a cluster from the supercluster. [tags: DMA]

Request

Query Parameters

Name	Type	Description

type	xs:string	Specifies an enumerated type that will indicate that the resource should be read by its human-readable name or immutable, unique identifier such as a UUID, integer, etc. The purpose of allowing the API client to specify an enumerated type ensures the option to read this resource by its human-readable name. In the case of a hostname, the name should typically be available as specified when the object is defined; however, it may sometimes be necessary to specify a fully qualified host name. Once defined, the resource is assigned an immutable, unique identifier that can be retrieved in the entity body; the API client has the option of reading this resource by that identifier. Note 1: The URL form is https://{host}:{port}/api/rest/resource/{value}?type={name\|id} Note 2: If the "name" enumeration is specified, then the value should correspond to the cluster name. Otherwise, the resource cannot be found. Note 3: If the "id" enumeration is specified, then the value should correspond to the unique identifier. Otherwise, the resource cannot be found. Note 4: The read operation will default to the "id" type enumeration. As a result, the {value} parameter can simply specify the unique identifier and the query parameter, "?type=id" is not required.

Response

Status	Representation	Description
204		Cluster successfully removed from supercluster.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. DMA roles required: administrator
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	No such cluster can be found as a member of the supercluster.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The cluster is not currently in a state to be removed from the supercluster. Check the cluster's status and/or try again later.

https://localhost:8443/api/rest/dma-supercluster/{value}/set-service-status

Template Parameters

Name	Type	Description
value	xs:string	Unique hostname or identifier of the cluster.

Methods

POST

Sets the service status for the specified cluster of the supercluster.

[tags: DMA]

Request

Query Parameters

Name	Type	Description

type	xs:string	Specifies an enumerated type that will indicate that the resource should be read by its human-readable name or immutable, unique identifier such as a UUID, integer, etc. The purpose of allowing the API client to specify an enumerated type ensures the option to read this resource by its human-readable name. In the case of a hostname, the name should typically be available as specified when the object is defined; however, it may sometimes be necessary to specify a fully qualified host name. Once defined, the resource is assigned an immutable, unique identifier that can be retrieved in the entity body; the API client has the option of reading this resource by that identifier. Note 1: The URL form is https://{host}:{port}/api/rest/resource/{value}?type={name\|id} Note 2: If the "name" enumeration is specified, then the value should correspond to the cluster name. Otherwise, the resource cannot be found. Note 3: If the "id" enumeration is specified, then the value should correspond to the unique identifier. Otherwise, the resource cannot be found. Note 4: The read operation will default to the "id" type enumeration. As a result, the {value} parameter can simply specify the unique identifier and the query parameter, "?type=id" is not required.

Representations

application/vnd.plcm.plcm-dma-supercluster-set-cluster-servicing-status-request+xml

application/vnd.plcm.plcm-dma-supercluster-set-cluster-servicing-status-request+json

Response

Status	Representation	Description
204		The service status for the cluster was set as specified.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. DMA roles required: administrator
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	No such cluster can be found as a member of the supercluster.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The requested service status value is not a viable option for this request.

https://localhost:8443/api/rest/dma-supercluster/{value}/restart-services

Template Parameters

Name	Type	Description
value	xs:string	Unique hostname or identifier of the cluster.

Methods

POST

Restart the services for the specified cluster of the supercluster.
[tags: DMA]

Request

Query Parameters

Name	Type	Description

type	xs:string	Specifies an enumerated type that will indicate that the resource should be read by its human-readable name or immutable, unique identifier such as a UUID, integer, etc. The purpose of allowing the API client to specify an enumerated type ensures the option to read this resource by its human-readable name. In the case of a hostname, the name should typically be available as specified when the object is defined; however, it may sometimes be necessary to specify a fully qualified host name. Once defined, the resource is assigned an immutable, unique identifier that can be retrieved in the entity body; the API client has the option of reading this resource by that identifier. Note 1: The URL form is https://{host}:{port}/api/rest/resource/{value}/restart-services?type={name\|id} Note 2: If the "name" enumeration is specified, then the value should correspond to the cluster name. Otherwise, the resource cannot be found. Note 3: If the "id" enumeration is specified, then the value should correspond to the unique identifier. Otherwise, the resource cannot be found. Note 4: The read operation will default to the "id" type enumeration. As a result, the {value} parameter can simply specify the unique identifier and the query parameter, "?type=id" is not required.

Response

Status	Representation	Description
202		Restart services operation started successfully. Interim status can be retrieved using task URL specified in location header.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. DMA roles required: administrator
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	No such cluster can be found as a member of the supercluster.

https://localhost:8443/api/rest/dma-supercluster/{value}/reset-services

Template Parameters

Name	Type	Description
value	xs:string	Unique hostname or identifier of the cluster.

Methods

POST

Reset the services for the specified cluster of the supercluster.
[tags: DMA]

Request

Query Parameters

Name	Type	Description

type	xs:string	Specifies an enumerated type that will indicate that the resource should be read by its human-readable name or immutable, unique identifier such as a UUID, integer, etc. The purpose of allowing the API client to specify an enumerated type ensures the option to read this resource by its human-readable name. In the case of a hostname, the name should typically be available as specified when the object is defined; however, it may sometimes be necessary to specify a fully qualified host name. Once defined, the resource is assigned an immutable, unique identifier that can be retrieved in the entity body; the API client has the option of reading this resource by that identifier. Note 1: The URL form is https://{host}:{port}/api/rest/resource/{value}/reset-services?type={name\|id} Note 2: If the "name" enumeration is specified, then the value should correspond to the cluster name. Otherwise, the resource cannot be found. Note 3: If the "id" enumeration is specified, then the value should correspond to the unique identifier. Otherwise, the resource cannot be found. Note 4: The read operation will default to the "id" type enumeration. As a result, the {value} parameter can simply specify the unique identifier and the query parameter, "?type=id" is not required.

Response

Status	Representation	Description
202		Reset services operation started successfully. Interim status can be retrieved using task URL specified in location header.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. DMA roles required: administrator
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	No such cluster can be found as a member of the supercluster.