PlcmCommon

Type definitions shared by all Polycom RealPresence APIs.

PlcmFqdn

Fully qualified domain name for a host

PlcmHostsEntry

Defines an entry in the /etc/hosts table

PlcmHostsEntryList

Defines the /etc/hosts table

Service

List of the application services that are configured for this interface. When determining compatibility, the application uses this list to ensure that peer nodes are configured similarly. This list is only used by the application side. The HA agent does not use this list.

PlcmNode

This object represents the definition of a server as a part of a larger group of similar servers.

PlcmService

A generic application defined service that is provided by any RealPresence Platform server. Servers define their own service names, for example: Media-Relay, Signaling, Management, etc.

PlcmPage

used for list types to support pagination information

PlcmRestLoginDetails

This object contains the host information and credentials required to send REST requests to another host.


PlcmRestLoginDetails Fields

NameTypeDescriptionAttributes
hostPlcmHost Hostname or ip address of the REST receiver. Mandatory
portPortNumber Port number of host that services REST requests. Mandatory
usernamestring Defines the username used in REST requests Mandatory
passwordstring Defines the password used in REST requests Mandatory

PlcmPage Fields

NameTypeDescriptionAttributes
atomLinkList Array of LinkSee Definition of Link
totalSizeint total number of items that can be retrieved (if going though all pages)
pageSizeint number of items on a full page (often specified by limit parameters)
currentPageint number of current page's information Mandatory

PlcmService Fields

NameTypeDescriptionAttributes
serviceNameServiceName Name of the service. Mandatory
dscpint Differential services code point value associated with the service.

PlcmNode Fields

NameTypeDescriptionAttributes
namestring This is the unique identying string for a node. Although not a serial number, it is still guaranteed to be globally unique for all nodes. Mandatory
rackIdstring An identifier used to represent the logical value for a node in a high availability configuration. All nodes part of the same high availability configuration, will have a unique rack-id. However, rack-id is not guaranteed to be unique across different high availability configurations or nodes that are not part of any high availability configurations. Mandatory
machineIdstring This field is populated with the hostname of the node. This is not an FQDN since the full domain portion is not included. Mandatory
siteIdstring Currently unused

Service Fields

NameTypeDescriptionAttributes
nameName Name of the service. Mandatory
dscpint Differentiated services code point to be used for network traffic associated with this service.

PlcmHostsEntryList Fields

NameTypeDescriptionAttributes
plcmHostsEntryList Array of PlcmHostsEntrySee Definition of PlcmHostsEntry

PlcmHostsEntry Fields

NameTypeDescriptionAttributes
plcmFqdnList Array of PlcmFqdnSee Definition of PlcmFqdn
addressPlcmInetAddress Defines the address for the entry Mandatory

PlcmFqdn Fields

NameTypeDescriptionAttributes
valueDomainNameMandatory


Nested Types/Restrictions


NameTypeRestrictions
PlcmIpVersionstring
Value must be one of:
  • unknown
  • ipv4
  • ipv6
PlcmDomainName
Length of value must be >=1
Length of value must be <=253
PlcmPhysAddressstring
Pattern of value must match the regular expression ([0-9a-fA-F]{2}(:[0-9a-fA-F]{2})*)?
PlcmMacAddressstring
Pattern of value must match the regular expression [0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5}
PlcmInetAddressstring
Pattern of value must match the regular expression ((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]))|(((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9]))))|((([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))
PlcmInetAddressPrefixstring
Pattern of value must match the regular expression ((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(/(([0-9])|([1-2][0-9])|(3[0-2])))?)|(((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))(/(([0-9])|([0-9]{2})|(1[0-1][0-9])|(12[0-8])))?)|((([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)(/.+)?)
PlcmHoststring
Pattern of value must match the regular expression (((([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.)*([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)|\.)|((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5]))|(((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9]))))|((([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))
Uuidstring
Pattern of value must match the regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}
EntityTagstring
Length of value must be >=0
Length of value must be <=64
DmaServiceNamestring
Value must be one of:
  • ACCESS_PROXY_LAN
  • ACCESS_PROXY_WAN
  • COLLABUTRON_LAN
  • COLLABUTRON_WAN
  • DNS_SERVER
  • EXCHANGE
  • H323_SIGNALING_LAN
  • H323_SIGNALING_WAN
  • MANAGEMENT
  • MCU_CONTROL
  • MEDIA_LAN
  • MEDIA_WAN
  • POLY_EVO_SIGNALING_LAN
  • POLY_EVO_SIGNALING_WAN
  • API_PROXY
  • REMOTE_BACKUP
  • REMOTE_LOGGING
  • SIP_SIGNALING_LAN
  • SIP_SIGNALING_WAN
  • SNMP
  • SUPER_CLSTR_COMM
  • TURN_LAN
  • TURN_WAN
  • USER_MANAGEMENT
  • WORKFLOW
DmaManagementServiceNamestring
Value must be one of:
  • DNS_SERVER
  • EXCHANGE
  • MANAGEMENT
  • MCU_CONTROL
  • REMOTE_BACKUP
  • REMOTE_LOGGING
  • SNMP
  • SUPER_CLSTR_COMM
  • USER_MANAGEMENT
  • WORKFLOW
DmaLanSignalingServiceNamestring
Value must be one of:
  • COLLABUTRON_LAN
  • H323_SIGNALING_LAN
  • SIP_SIGNALING_LAN
DmaWanSignalingServiceNamestring
Value must be one of:
  • COLLABUTRON_WAN
  • H323_SIGNALING_WAN
  • SIP_SIGNALING_WAN
DmaProxyServiceNamestring
Value must be one of:
  • ACCESS_PROXY_LAN
  • ACCESS_PROXY_WAN
DmaMediaServiceNamestring
Value must be one of:
  • MEDIA_LAN
  • MEDIA_WAN
DmaTurnServiceNamestring
Value must be one of:
  • TURN_LAN
  • TURN_WAN
DmaVpnServiceNamestring
Value must be one of:
  • VPN_TUNNEL_LAN
  • VPN_TUNNEL_WAN
PlcmPortAssignmentTypestring
Value must be one of:
  • PUBLIC
  • PRIVATE
PlcmUploadUrlstring
Pattern of value must match the regular expression (http|https|ftp|sftp)://(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\\b([-a-zA-Z0-9@:%_\+.~#?&//=]*)
SvcMcuNetworkIfaceServiceNamestring
Value must be one of:
  • MANAGEMENT
  • SIGNALING
  • MEDIA
  • SSH
ServiceNamestring
Length of value must be >=1
Length of value must be <=256
Namestring
Length of value must be >=1
Length of value must be <=256
T0string
Pattern of value must match the regular expression ((([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.)*([a-zA-Z0-9_]([a-zA-Z0-9\-_]){0,61})?[a-zA-Z0-9]\.?)|\.