Plantronics + Polycom. Now together as Poly Logo

Problem setting device parameters on VVX 411 using Rest API

SOLVED
Stumped
Occasional Contributor

Problem setting device parameters on VVX 411 using Rest API

I have some (perl) code that uses the REST Api to do various things to

our VVX 411 phones. I can read parameters, reboot the phones and get various

information and statistics. But I have not been able to write parameters to the phone.

Following the REST API doc I am using "..../api/v1/mgmt/config/set"  with data as

(for example) '{"data":{"device.net.cdpEnabled":"0"}}'

I have tried lots of other combinations in the data as well (including two or

more things to set) but none seem to work. I just get back Status=5000.

(Invalid parameters). As near as I can tell my data matches the documentation

so I'm guessing that maybe there is something else that I have to do.

Maybe when one is writing device parameters you have to enable some

"device" mode ??? Or maybe with device parameters you need to use some

"special access" ???? Is there some global setting that might be disallowing

me to write configuration parameters ????

Any ideas (or examples of writing device.net parameters)

would be appreciated.

 

 

Message 1 of 7
1 ACCEPTED SOLUTION

Accepted Solutions
Stumped
Occasional Contributor

Re: Problem setting device parameters on VVX 411 using Rest API

Steffen,

  Thank you for providing those pointers. Even though I had searched, I failed to find

that article. I am writing the solution to this question below to document it for others.

 

Answer:

 

   Even though you may see that "device.set=1" and "<param>.set=1"

are both set when you dump the phone configurations (either by "export" or

backup). it seems that you must also provide those settings when making

the API call to set a parameter. In my case, I had dumped the config files

and saw that those things were set to "1" so I did not include them in my

API call which was the cause of the failure. When I added them to the API

call the "set" of the parameter worked (and of course was followed by

the auto phone reboot). In my mind, this requirement to "re-set"

settings that are already set is not at all obvious. It would be very helpful if

this requirement was noted in the API description.

 

View solution in original post

Message 6 of 7
6 REPLIES 6
SteffenBaierUK
Polycom Employee & Community Manager

Re: Problem setting device parameters on VVX 411 using Rest API

Hello @Stumped ,

 

Welcome to the Poly Community.

Both the communities Must Read First or Read 1st and if available the FAQ reference the basic minimum information a new or follow up post should contain.

This ensures the questions having to be asked are limited and any new or follow up post contains the right amount of details to ensure any voluntary participant within the community does not spend additional time chasing basic information.


Unfortunately, your post fell a bit short of the above-explained requirements and we kindly ask you, therefore, to ensure to read these sections and ensure a reply (not Edit!) provides as much detail as possible

 

As it is the new year have a look at the examples here:

 

Jun 05, 2018 Question: Do Poly Phones support a REST API?

Resolution: Please => here <=


Please ensure to provide some feedback if this reply has helped you so other users can profit from your experience.

Best Regards

Steffen Baier

 

----------------
The title Poly Employee & Community Manager is a community setting and does not reflect my role. I am just a simple volunteer in the community like everybody else. All posts and words are my own & do not represent the views of Employer.

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

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
Message 2 of 7
Stumped
Occasional Contributor

Re: Problem setting device parameters on VVX 411 using Rest API

Steffen,

 

Thank you for your reply. I have reviewed everything that I could find on the knowledge

base. I did searches for "REST" "device.net" and lots of other things but could not find

anything that came close to giving me the answer to my question.

 

I have tried very hard to read everything that said anything about rules or anything

else but obviously I missed something. I can't find any community called "Must read first"

or "read first". Please tell me how to get to them.

 

In the alternative, if you can tell me what information is missing from my post I will

eagerly provide it. I didn't want to make the post full of unneeded information.

clearly things like "device serial number" and other items have no bearing on

this question. I will be happy to provide any information that might help others

help me with this problem.

 

Again, I thank you for your reply. I really have made quite an effort to comply with

guidelines and provide information as needed. Please help me understand where

I have fallen short.

 

Message 3 of 7
Stumped
Occasional Contributor

Re: Problem setting device parameters on VVX 411 using Rest API

FYI: Here is info from the phone (gotten using the REST API)

 


For Phone: 192.168.10.165

AttachedHardware:
EM:
DeviceType => hardwareEndpoint
DeviceVendor => Polycom
FirmwareRelease => 6.3.1.8427
IPV4Address => 192.168.10.165
IPV6Address => ::
MACAddress => 64167fc7984f
ModelNumber => VVX 411
UpTimeSinceLastReboot => 0 Day 5:19:31

AlternateDNSServer => 8.8.8.8
CDPCompatibility => enabled
DHCP => enabled
DHCPBootServerOption => 160
DHCPBootServerOptionType => String
DHCPBootServerUseOption => Static
DHCPOption60Format => ASCII String
DHCPServer => 192.168.10.1
DNSDomain => *removed*
DNSServer => 1.1.1.1
DefaultGateway => 192.168.10.1
IPV4Address => 192.168.10.165
IPV6Address => ::
LANPortStatus => active
LANSpeed => 1000Mbps
LLDP => enabled
ProvServerAddress => *removed*
ProvServerType => FTP
ProvServerUser => mar2021
SNTPAddress => pool.ntp.org
SubnetMask => 255.255.255.0
UpgradeServer =>
VLANDiscoveryMode => Fixed
VLANID =>
VLANIDOption => 129
ZTPStatus => disabled
ZTStatus => disabled

DHCP:
BootServerOption => 160
BootServerOptionType => String
BootServerUseOption => Static
Feature => Enabled
OfferTimeout => 1
Option60Format => ASCII String
VLANDiscovery => Default
VLANDiscoveryOption => 129
DNS:
Domain => *removed*
Feature => Enabled
PrimaryServer => 1.1.1.1
SecondaryServer => 8.8.8.8
Network:
CDP => Enabled
IPAddress => 192.168.10.165
IPGateway => 192.168.10.1
IPStack => IPv4 Only
IPv6Address => ::
IPv6AddressDiscovery => DHCP
IPv6Gateway => ::
IPv6LinkAddress => ::
IPv6ULAAddress => ::
LLDP => Enabled
PreferredNetwork => IPv6
StormFilterPPS => 38
StormFiltering => Enabled
SubnetMask => 255.255.255.0
VLAN =>
VLANFiltering => Enabled
Provisioning:
FileTxTries => 3
MaxServers => 8
NetworkEnv => Cable/DSL
RetryWait => 1
Server => *removed*
ServerType => FTP
TagSerialNo => Enabled
User => mar2021
SNTP:
GMTOffsetHours => -5
GMTOffsetSeconds => -18000
Server => pool.ntp.org
Syslog:
Facility => 16
PrependMAC => Disabled
RenderLevel => 4
Server =>
Transport => UDP
TR069:
ACSURL =>
ACSUsername => PlcmSpIp
CPEUsername => PlcmSpIp
Feature => Disabled
InformInterval => 18000
PeriodicInform => Disabled
UpgradeManagement => Disabled

 

Message 4 of 7
SteffenBaierUK
Polycom Employee & Community Manager

Re: Problem setting device parameters on VVX 411 using Rest API


@Stumped wrote:

Steffen,

...

I have tried very hard to read everything that said anything about rules or anything

else but obviously I missed something. I can't find any community called "Must read first"

or "read first". Please tell me how to get to them.

...

 


I am surprised about this but here you go:

SteffenBaierUK_0-1641034385221.png

The above should clear this up and help you in the future to provide as many details for us volunteers to try and help.

 

The shared FAQ should hopefully have answered your question and includes details.

 

There is another FAQ here:

 

Jul 25, 2013 QuestionHow can I setup certain Device parameters on my phone via a configuration file?

Resolution: Please check => here <=

 

And if all fails contact Poly support directly and if the unit is out of warranty the support team can share the details of who sold the unit and via this enable you to purchase out of warranty PPI / Pay per Incident support.

 

Best regards

 

Steffen Baier

 

----------------
The title Poly Employee & Community Manager is a community setting and does not reflect my role. I am just a simple volunteer in the community like everybody else. All posts and words are my own & do not represent the views of Employer.

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

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
Message 5 of 7
Stumped
Occasional Contributor

Re: Problem setting device parameters on VVX 411 using Rest API

Steffen,

  Thank you for providing those pointers. Even though I had searched, I failed to find

that article. I am writing the solution to this question below to document it for others.

 

Answer:

 

   Even though you may see that "device.set=1" and "<param>.set=1"

are both set when you dump the phone configurations (either by "export" or

backup). it seems that you must also provide those settings when making

the API call to set a parameter. In my case, I had dumped the config files

and saw that those things were set to "1" so I did not include them in my

API call which was the cause of the failure. When I added them to the API

call the "set" of the parameter worked (and of course was followed by

the auto phone reboot). In my mind, this requirement to "re-set"

settings that are already set is not at all obvious. It would be very helpful if

this requirement was noted in the API description.

 

View solution in original post

Message 6 of 7
SteffenBaierUK
Polycom Employee & Community Manager

Re: Problem setting device parameters on VVX 411 using Rest API

Hello @Stumped ,

 

this has been the case for any device parameter prior the 13 years I am with Poly and has not changed with the introduction of the REST API.

 

The parameters always come in "pairs" and you must at least declare once the device.set="1" for it to work.

 

The Admin Guide and the shared FAQ outline this and I am not sure the REST API documentation needs to add this.

 

Glad you got this working now.


Best Regards

Steffen Baier

 

----------------
The title Poly Employee & Community Manager is a community setting and does not reflect my role. I am just a simple volunteer in the community like everybody else. All posts and words are my own & do not represent the views of Employer.

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

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
Message 7 of 7