Plantronics + Polycom. Now together as Poly Logo

Polycom API - Possible to use /api/v1/mgmt/config/set to change settings with source of "device"?

SOLVED
Highlighted
Occasional Visitor

Polycom API - Possible to use /api/v1/mgmt/config/set to change settings with source of "device"?

Hello,

 

I am trying to change the provisioning server configuration using the polycom API. The value I am trying to change is device.prov.serverName with the API call /api/v1/mgmt/config/set

 

After hours of troubleshooting I think I have identified that the issue I am running into is that it seems I am unable to change config parameters that have a 'source' value of 'device'. 

 

For example, when I run /api/v1/mgmt/config/get for the device.prov.serverName config parameter I get the following output:

 

 

 

{
    "data": {
        "device.prov.serverName": {
            "Value": "<REAL RESPONSE REMOVED>",
            "Source": "device"
        }
    },
    "Status": "2000"
}

 

 
I finally had the idea to try to change some other values through the API and it worked when the source value was 'default' and not 'device'
 
Is the API able to change configuration parameters if the source is 'Device' or is that the limitation i am running into?? If so, is there a work around and where is this documented??
 
Thanks.
Message 1 of 3
1 ACCEPTED SOLUTION

Accepted Solutions
Highlighted
Polycom Employee & Community Manager

Re: Polycom API - Possible to use /api/v1/mgmt/config/set to change settings with source of "de

Hello @GNegronida ,

 

it would have been informative to post some details about the actual phone and the software version you are trying to archive this for as this may depend on the answer we can provide.

 

Any device parameter you would want to change always requires the minimum of:

device.set="1"

A device parameter itself always comes in a pair as well:

device.prov.serverName.set
device.prov.serverName

Using the REST API to change the provisioning server to a different IP address would require:

"device.set": "1", 
"device.prov.serverName.set": "1",
"device.prov.serverName`": "10.252.149.102"

Example:

.\REST_API_CFG_Set.ps1 10.252.149.60

ProcessedParams                                                                      Status
---------------                                                                      ------
@{device.prov.serverName=10.252.149.102; device.prov.serverName.set=1; device.set=1} 2000

Best regards

 

Steffen Baier

----------------

Notice: This community forum is not an official Poly support resource, thus responses from Poly employees, partners, and customers alike are best-effort in attempts to share learned knowledge. If you need immediate and/or official assistance please open a service ticket through your proper support channels.
Please also ensure you always check the VoIP , Video Endpoint , Skype for Business , PSTN or RPM FAQ's

View solution in original post

Message 2 of 3
2 REPLIES 2
Highlighted
Polycom Employee & Community Manager

Re: Polycom API - Possible to use /api/v1/mgmt/config/set to change settings with source of "de

Hello @GNegronida ,

 

it would have been informative to post some details about the actual phone and the software version you are trying to archive this for as this may depend on the answer we can provide.

 

Any device parameter you would want to change always requires the minimum of:

device.set="1"

A device parameter itself always comes in a pair as well:

device.prov.serverName.set
device.prov.serverName

Using the REST API to change the provisioning server to a different IP address would require:

"device.set": "1", 
"device.prov.serverName.set": "1",
"device.prov.serverName`": "10.252.149.102"

Example:

.\REST_API_CFG_Set.ps1 10.252.149.60

ProcessedParams                                                                      Status
---------------                                                                      ------
@{device.prov.serverName=10.252.149.102; device.prov.serverName.set=1; device.set=1} 2000

Best regards

 

Steffen Baier

----------------

Notice: This community forum is not an official Poly support resource, thus responses from Poly employees, partners, and customers alike are best-effort in attempts to share learned knowledge. If you need immediate and/or official assistance please open a service ticket through your proper support channels.
Please also ensure you always check the VoIP , Video Endpoint , Skype for Business , PSTN or RPM FAQ's

View solution in original post

Message 2 of 3
Polycom Employee

Re: Polycom API - Possible to use /api/v1/mgmt/config/set to change settings with source of "de

There is not a way to send them such that they are 'sourced' from device.  Rest APIs enter the Poly device and are evaluated as a type of 'Web', which falls in line with the config precedence hierarchy

 

The Device level of parameters however are considered as 'global' setting so no matter what level it enters it will set as a new value.  What you have to worry about however is having that same value set elsewhere by another configuration source (Provisioning server, inband from call server, etc.) as the value you set via API may require a reboot, and therefore you would have it potentially reset itself again.

Message 3 of 3