Cisco Cisco TelePresence MCU 4510 Developer's Guide

Page of 223
API reference
Cisco TelePresence MCU API 2.9
Page 58 of 223
device.network.modify
Modifies the device's network information. You may supply only the parameters that you want to change but,
in some cases, you must supply a parameter (depending on the value you set for another parameter).
Include the parameters you want to modify in the appropriate struct;
portAportB, or dns. The portA and
portB structs take the same parameters.
Note: The device returns a success message after successfully parsing your call but before implementing
the settings. Also, you will generate a fault if you attempt to disable the active interface.
Input parameters
Required inputs
If you set
ipv4Enabled to true, you must supply dhcpv4. If you set dhcpv4 to false, you must supply
ipv4Address and ipv4SubnetMask.
If you set
ipv6Enabled to true, you must supply ipv6Conf. If you set ipv6Conf to manual, you must supply
ipv6Address and ipv6PrefixLength.
If you set
ethernetAutomatic to false, you must supply speed and fullDuplex.
Optional or conditional inputs
Parameter name
Type
Short description
portA
struct
A structure that contains configuration and status
information for Ethernet port A on the device.
portB
struct
A structure that contains configuration and status
information for Ethernet port B on the device.
ipv4Enabled
boolean
true if IPv4 interface is enabled.
dhcpv4
boolean
Defines whether or not to use DHCP to obtain an IPv4
address. Deprecates dhcp.
ipv4Address
string (31) IPv4 address in dotted-quad format.
ipv4SubnetMask
string (31) The IPv4 subnet mask in dotted quad format. Deprecates
subnetMask.
defaultIpv4Gateway
string (31) The device's IPv4 default gateway in dotted quad format.
Deprecates defaultGateway.
ipv6Enabled
boolean
true if IPv6 interface is enabled.
ipv6Conf
string (10) Indicates how the IPv6 address is assigned; either
automatic (by SLAAC/DHCPv6) or manual.
ipv6Address
string (79) The IPv6 address in CIDR format.
ipv6PrefixLength
integer
The length of the IPv6 address prefix.