PlcmSiteV5

PlcmSiteV5

Describes a site topology site defined in DMA


PlcmSiteV5 Fields

NameTypeDescriptionAttributes
plcmDataRate PlcmDataRateSee Definition of PlcmDataRateMandatory
atomLinkList Array of LinkSee Definition of Link
plcmSiteDetail PlcmSiteDetailSee Definition of PlcmSiteDetail
plcmSubnetListV4 PlcmSubnetListV4See Definition of PlcmSubnetListV4Mandatory
plcmIsdnNumberAssignment PlcmIsdnNumberAssignmentSee Definition of PlcmIsdnNumberAssignment
plcmSiteTopologyBitRateV3 PlcmSiteTopologyBitRateV3See Definition of PlcmSiteTopologyBitRateV3
siteIdentifierstring Internal identifier. Provided to protect against a name update.
nameName A meaningful name for the site (up to 128 characters). Mandatory
descriptionDescription A brief description of the site (up to 200 characters).
maximumBandwidthMaximumBandwidth The total bandwidth limit for voice and video calls. If not configured, voice and video calls can use all of the available bandwidth. The rate (bps / kbps / etc) is described by the data-rate field.
territoryIdentifierstring Internal identifier for the territory the site is assigned to.
ituDialingRulesOverrideboolean Flag to override the standard dialing rules, established by the International Telecommunications Union, when dialing out using an ISDN gateway.
pbxAccessCodestring The code needed to access the ISDN/PSTN network through the site's PBX when dialing out. This is restricted to the following characters: 0123456789AaBbCcDd#*
countryCodeCountryCode The country code for the site's location. This is only valid if the ITU dialing rules are not overridden. This is restricted to numeric characters only
areaCodeAreaCode The city or area code for the site's location. Leading zeroes are optional. This is only valid if the ITU dialing rules are not overridden. This is restricted to numeric characters only
alwaysDialAreaCodeboolean Flag indicating that the area code should always be included in the phone number. This is only valid if the ITU dialing rules are not overridden. Defaults to false if not present.
alwaysDialNationalPrefixboolean Flag indicating that the national prefix should always be included in the phone number. This is only valid if the ITU dialing rules are not overridden. Defaults to false if not present.
subscriberNumberLengthint The number of digits in a phone number.
internetCallRoutingH323InternetCallRoutingH323 Internet call routing configuration for H.323 calls. This configures how calls to the internet site are handled. The following options are available: NOT_ALLOWED - Disables H.323 calls to the internet. ALLOWED_THROUGH_H323_FIREWALL - Allows H.323 calls to the internet through a H.323 aware firewall. ALLOWED_THROUGH_H323_SBC_ALG - Allows H.323 calls to the internet through a H.323 SBC or ALG. Mandatory
h323SbcAlgCallSignalingIpAddressstring The call signaling address for the H.323 SBC or ALG. This is only valid and required if the internet-call-routing-h323 option is set to ALLOWED_THROUGH_H323_SBC_ALG.
h323SbcAlgCallSignalingIpPortint The call signaling port for the H.323 SBC or ALG. This is only valid and required if the internet-call-routing-h323 option is set to ALLOWED_THROUGH_H323_SBC_ALG.
internetCallRoutingSipInternetCallRoutingSip Internet call routing configuration for SIP calls. This configures how calls to the internet site are handled. The following options are available: NOT_ALLOWED - Disables SIP calls to the internet. ALLOWED_THROUGH_SIP_FIREWALL - Allows SIP calls to the internet through a SIP aware firewall. ALLOWED_THROUGH_SIP_SBC_ALG - Allows SIP calls to the internet through a SIP SBC or ALG. Mandatory
sipSbcAlgCallSignalingIpAddressstring The call signaling address for the SIP3 SBC or ALG. This is only valid and required if the internet-call-routing-sip option is set to ALLOWED_THROUGH_SIP_SBC_ALG.
sipSbcAlgCallSignalingIpPortint The call signaling port for the SIP SBC or ALG. This is only valid and required if the internet-call-routing-sip option is set to ALLOWED_THROUGH_SIP_SBC_ALG.
entityTagEntityTag The unique value generated from the server object instance. This value is the same value that MUST be applied to the HTTP Entity Tag (ETag) header for a single instance of this object. Client modification of this field is not allowed for this instance.


Nested Types/Restrictions


NameTypeRestrictions
EntityTagstring
Length of value must be >=1
Length of value must be <=64
InternetCallRoutingSipstring
Value must be one of:
  • NOT_ALLOWED
  • ALLOWED_THROUGH_SIP_FIREWALL
  • ALLOWED_THROUGH_SIP_SBC_ALG
InternetCallRoutingH323string
Value must be one of:
  • NOT_ALLOWED
  • ALLOWED_THROUGH_H323_FIREWALL
  • ALLOWED_THROUGH_H323_SBC_ALG
AreaCodestring
Length of value must be >=0
Length of value must be <=5
CountryCodestring
Length of value must be >=0
Length of value must be <=5
MaximumBandwidthdecimal
Descriptionstring
Length of value must be >=1
Length of value must be <=200
Namestring
Length of value must be >=1
Length of value must be <=128