Configuration



[tags: DMA]

Resource Root

https://localhost:8443/api/rest/port-range-settings

Summary


Resources Methods
https://localhost:8443/api/rest/port-range-settings

GET  Retrieves the port range settings.

https://localhost:8443/api/rest/port-range-settings/calls-settings

GET Retrieves the calls settings with regard to port ranges.

PUT Updates the calls settings with respect to port ranges.

https://localhost:8443/api/rest/port-range-settings/system-ephemeral

GET Retrieves the system ephemeral port range settings.

PUT Sets the system ephemeral port range settings.

https://localhost:8443/api/rest/port-range-settings/defaults

GET Retrieves Port Range Settings defaults.

PUT Sets the various port range settings to their defaults (system ephemeral, SIP, H323, media, etc.

Resources


https://localhost:8443/api/rest/port-range-settings


Methods

GET


Retrieves the port range settings. [tags: DMA]

Request

Query Parameters

Name Type Description
interface xs:string Return port range settings of the interface name passed.

Response

Status Representation Description
200 application/vnd.plcm.plcm-port-range-settings+xml
application/vnd.plcm.plcm-port-range-settings+json
Port range settings records successfully retrieved.
304
Port range settings records have not changed since the last get.

Note: The API client must provide the "plcm-port-range-settings"
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-port-range-settings" 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 Port range settings on the server.
400 text/plain
Bad request.
403 application/vnd.plcm.plcm-error+xml
User has insufficient permissions to perform the operation.
409 application/vnd.plcm.plcm-error+xml

The request contained ETags in both the header (header-ETag) and the
body (body-ETag) and they do not match.
412 application/vnd.plcm.plcm-error+xml

The resource has changed on the server. The API client must retrieve
the latest resource version, apply the resource modifications,
then update to the server.
428 application/vnd.plcm.plcm-error+xml

The API client must supply the ETag in the message body that is
bounded by
the "entity-tag" XML tag. Refer to the "plcm-port-range-settings.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/port-range-settings/calls-settings


Methods

GET

Retrieves the calls settings with regard to port ranges. This may be a real stored
value or it may be calculated from other system attributes. [tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-port-range-calls-settings+xml
application/vnd.plcm.plcm-port-range-calls-settings+json
Calls Settings values retrieved
403 application/vnd.plcm.plcm-error+xml
User does not have the correct permission to retrieve the port range settings

PUT

Updates the calls settings with respect to port ranges. I.E. An attempt is made so that
port range sizes for various call related services (media/RTP, SIP, H323, etc...) are adjusted
to accomodate the selected calls settings. The exact method the ranges are shrunk/grown based on
this setting is unspecified. Maximum call values less than 1 may result in a reset to defaults or may be ignored.
Values greater than the maximum calls specified by the system may have the same effect.
This setting differs from others in that it is a "best effort" kind of configuration. [tags: DMA]

Request

Representations

application/vnd.plcm.plcm-port-range-calls-settings+xml
application/vnd.plcm.plcm-port-range-calls-settings+json

Response

Status Representation Description
204 Port range settings updated based on calls configuration.
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
User does not have the correct permission to update calls settings
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Calls settings cannot be null.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid value, max call count must be between 0 and the maximum calls supported by the system.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Settings cannot be updated automatically as update would result in a port conflict, perform manual changes.

https://localhost:8443/api/rest/port-range-settings/system-ephemeral


Methods

GET

Retrieves the system ephemeral port range settings. [tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-port-range-system-ephemeral+xml
application/vnd.plcm.plcm-port-range-system-ephemeral+json
Ephemeral values retrieved
403 application/vnd.plcm.plcm-error+xml
User does not have the correct permission to retrieve the port range settings

PUT

Sets the system ephemeral port range settings. A restart isrequired for settings to take
full effect, but one is not performed as a result of this call. [tags: DMA]

Request

Representations

application/vnd.plcm.plcm-port-range-system-ephemeral+xml
application/vnd.plcm.plcm-port-range-system-ephemeral+json

Response

Status Representation Description
204 System ephemeral port values changed
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
User does not have the correct permission to update the port range settings
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
System port configuration cannot be null.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Invalid port number. Must be between 1024 and 65535.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Duplicated port number. This port configuration has already been used.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The version of the system ephemeral ports submitted for update does not match that on the server.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The request contained ETags in both the header and the body, and they do not match.

https://localhost:8443/api/rest/port-range-settings/defaults


Methods

GET

Retrieves Port Range Settings defaults. [tags: DMA]

Request

Query Parameters

Name Type Description
serviceName xs:string Return default port range settings of the service name passed.
interfaceName xs:string Return default port range settings of the interface name passed.

Response

Status Representation Description
200 application/vnd.plcm.plcm-port-range-settings+xml
application/vnd.plcm.plcm-port-range-settings+json
Default Information successfully retrieved
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
User does not have the correct permission to retrieve the port range settings

PUT

Sets the various port range settings to their defaults (system ephemeral, SIP, H323, media, etc...).
A restart is required for settings to take full effect, but is not performed as a result of this call.
[tags: DMA]

Request

Response

Status Representation Description
204 Port values changed
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
User does not have the correct permission to update the port range settings