JVC VN-E4U API Guide - Page 43

Network Basics, Enabling Network Setting Changes, Acquiring DHCP Setting from VN-E4

Page 43 highlights

5. API for Acquiring/Changing Parameters of VN-E4 _ 5.8. Network Basics 5.8. Network Basics The APIs below are related to the basics of networks. These are equivalent to the features on the Basic page of the WEB setting page. Refer to the instruction manual for details on the Basic page. Enabling Network Setting Changes Format /api/param?network.interface.status=restart Example of Response network.interface.status&200 OK Interpretation When network parameters are changed, this API can be used to enable the new settings. Changes will be not be reflected in the actions until this API is used. VN-E4 will cut off the TCP connection when this API is used. When this API is used upon changing IPv6, MTU, Negotiation, Timezone or SNMP, VN-E4 will reboot in about 1 minute. Allowed user admin Acquiring DHCP Setting from VN-E4 Format /api/param?network.interface.dhcp.status Example of Response network.interface.dhcp.status=off&200 OK Interpretation Acquire the current DHCP setting. Allowed users admin, operator, user Setting DHCP for VN-E4 Format /api/param?network.interface.dhcp.status=data Example /api/param?network.interface.dhcp.status=on Example of Response network.interface.dhcp.status&202 Required(network.interface.status=restart) Interpretation Change the DHCP setting. Upon setting this API, execute the "network.interface.status=restart" API for enabling network setting changes to enable the new settings. PPPoE will be turned off automatically when the DHCP setting is set to on. Allowed user admin Acquiring IP Address from VN-E4 Format /api/param?network.interface.ip Example of Response network.interface.ip=10.0.0.1&200 OK Interpretation Acquire the current IP address. Allowed users admin, operator, user 43

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80

43
5. API for Acquiring/Changing Parameters of VN-E4 _
5.8. Network Basics
The APIs below are related to the basics of networks. These are equivalent to the features on the Basic page of the WEB setting page. Refer to
the instruction manual for details on the Basic page.
Enabling Network Setting Changes
Format
/api/param?network.interface.status=restart
Example of Response
network.interface.status&200 OK
Interpretation
When network parameters are changed, this API can be used to enable the new settings. Changes will be not be
reflected in the actions until this API is used. VN-E4 will cut off the TCP connection when this API is used.
When this API is used upon changing IPv6, MTU, Negotiation, Timezone or SNMP, VN-E4 will reboot in
about 1 minute.
Allowed user
admin
Acquiring DHCP Setting from VN-E4
Format
/api/param?network.interface.dhcp.status
Example of Response
network.interface.dhcp.status=off&200 OK
Interpretation
Acquire the current DHCP setting.
Allowed users
admin, operator, user
Setting DHCP for VN-E4
Format
/api/param?network.interface.dhcp.status=data
Example
/api/param?network.interface.dhcp.status=on
Example of Response
network.interface.dhcp.status&202
Required(network.interface.status=restart)
Interpretation
Change the DHCP setting. Upon setting this API, execute the "network.interface.status=restart" API for
enabling network setting changes to enable the new settings. PPPoE will be turned off automatically when the
DHCP setting is set to on.
Allowed user
admin
Acquiring IP Address from VN-E4
Format
/api/param?network.interface.ip
Example of Response
network.interface.ip=10.0.0.1&200 OK
Interpretation
Acquire the current IP address.
Allowed users
admin, operator, user
5.8. Network Basics