HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community

/system

put
https://switch-ip/rest/v10.08/system
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
boolean

The unicast_gr_disabled flag is used to indentify whether the Unicast GR feature enabled or not

integer
1 to 5

The number of negotiated min_rx_intervals that can occur before a BFD session is considered to be down.

string

User configured HTTP Proxy.

string
boolean

Specifies whether the BFD protocol is enabled or not on the system.

integer
1 to 255

Maximum number of hops, after which packets originating from the switch will be discarded.

string

Reference Resource: Policy
Global Policy configuration for ingress direction.

string
string
nd_snooping_general_configuration
object
boolean

Disable SNMP trap generation for Power-Over-Ethernet (POE) related events.

int64
-9007199254740991 to 9007199254740991

The version of the 'policy_in_cfg'. This value is changed to a random value each time any management interface modifies the 'policy_in_cfg' value. An empty value means no ingress Policy has been configured globally.

string
string
ssh_kex_algorithms
object

This option specifies the SSH key exchange algorithms to use in priority order. The key represents the priority and the value is the key exchange algorithm to configure at that priority level. No configuration here means that the default key exchange algorithms and priorities will be configured: 1. curve25519-sha256 2. [email protected] 3. ecdh-sha2-nistp256 4. ecdh-sha2-nistp384 5. ecdh-sha2-nistp521 6. diffie-hellman-group-exchange-sha256 7. diffie-hellman-group16-sha512 8. diffie-hellman-group18-sha512 9. diffie-hellman-group14-sha256 10. diffie-hellman-group14-sha1

logrotate_config
object
string
string
length between 1 and 64

Specifies the schedule profile for ports that do not specify their own schedule profile (see Port qos column). When missing, the QoS row with hw_default true will be used.

string

Reference Resource: External_Storage
External storage to be used for all DHCPv4 servers.

string
string
string
string
enum

UBT VLAN mode configuration: vlan-extend: Clients are assigned to their UBT-role based VLAN in the hardware datapath. This mode allows for UBT to support VLAN-tagged clients like VOIP phones. local-vlan : Clients are assigned to a VLAN that is local to the switch and associated with their UBT-role based VLAN when client traffic reaches the controller. This mode allows for reducing the number of VLANs that need to be instantiated on the switch but can only support VLAN-untagged UBT clients. The 'ubt_client_vid' will be used to specify the local_vlan that UBT clients are assigned to.

Allowed:
certificate_association
object

Names of the certificates to be used for supported applications. If the name is not valid or the certificate is corrupted / expired, a default self-signed certificate will be used instead.

string
string

Reference Resource: External_Storage
External storage to back up IPv6 bindings learnt by DHCPv6 snooping.

router_id
object
string

Reference Resource: VRF
VRF for logrotate remote host connections. If not set, then the 'default' VRF will be used.

integer
1 to 255

Number of times SYN-ACK packets are resent in response to a TCP SYN request.

string
ssh_hostkey_algorithms
object

This option specifies the SSH host key algorithms that are offered by SSH in priority order. The key represents the priority and the value is the host key algorithm to configure at that priority level. No configuration here means that the default host key algorithms and priorities will be configured: 1. ecdsa-sha2-nistp256 2. ecdsa-sha2-nistp384 3. ecdsa-sha2-nistp521 4. ssh-ed25519 5. rsa-sha2-256 6. rsa-sha2-512 7. ssh-rsa

string
string
boolean

Set to enable or disable a trunk port from automatically transmitting or receiving traffic for dynamic VLANs i.e., MVRP and PortAccess VLANs.

http_session
object

HTTP session management global configurations.

all_user_copp_policies
array of strings
length ≤ 9223372036854776000

Reference Resource: CoPP_Policy
List of all user-defined CoPP policies in the system. The existence of a policy in this list is not an indication that it has been applied.

all_user_copp_policies
string
ssh_ciphers
object

This option specifies the SSH ciphers to use in priority order. The key represents the priority and the value is the cipher to configure at that priority level. No configuration here means that the default ciphers and priorities will be configured: 1. [email protected] 2. aes128-ctr 3. aes192-ctr 4. aes256-ctr 5. [email protected] 6. [email protected]

dhcp_server_external_storage_configuration
object
lacp_config
object
boolean

Enables automatic creation of a VLAN for portaccess clients if the VLAN is not already available in the system.

string

Reference Resource: VRF
VRF for HTTP Proxy connections. If not set, then the 'default' VRF will be used.

string
string
enum

Facility to be used when forwarding to remote syslog servers.

boolean

When set to true system resource data polling is disabled.

string
string
integer
0 to 1000

The shortest interval, in milliseconds, at which BFD sessions can receive BFD control messages. Remote endpoints may send messages at a slower rate. The value 0 means that the system does not want to receive BFD echo packets. The range from [1-49] is invalid.

int64
10 to 4294967295

Specifies the polling interval in seconds for system resource data polling

boolean

Disable SNMP trap generation for event logs.

integer
1 to 100

Set the threshold in percent at which the system will send an excess power consumption notification trap.

string
ssh_pubkey_algorithms
object

This option specifies the SSH public key algorithms to use in priority order. The key represents the priority and the value is the public key algorithm to be configured at that priority level. No configuration here means that the default public key algorithms and priorities will be configured: 1. rsa-sha2-256 2. rsa-sha2-512 3. ssh-rsa 4. ecdsa-sha2-nistp256 5. ecdsa-sha2-nistp384 6. ecdsa-sha2-nistp521 7. ssh-ed25519 8. x509v3-rsa2048-sha256 9. x509v3-ssh-rsa 10. x509v3-sign-rsa 11. x509v3-ecdsa-sha2-nistp256 12. x509v3-ecdsa-sha2-nistp384 13. x509v3-ecdsa-sha2-nistp521

boolean

Enable Group Based Policy enforcement.

boolean

Disable ICMPv4 and ICMPv6 redirect messages.

boolean

Enable generating loop-protect traps when a loop is detected.

mirrors
array of strings
length ≤ 9223372036854776000

Reference Resource: Mirror
Mirror references for sessions configured in this bridge.

mirrors
aaa
object
string
rpvst_enabled_vlans
array of strings
length ≤ 254

Reference Resource: VLAN
The vlans on which RPVST is enabled.

rpvst_enabled_vlans
proxies
object
string
string
other_config
object
string
dhcpv6_snooping_external_storage_configuration
object
string

Reference Resource: Logging_Filter
Currently active logging filter.

boolean

Enable redistributing the active routes that have been selected for forwarding into the target routing protocol.

string
cli_session
object

CLI session management global configurations.

boolean

Disable MAC move between secure ports.

string
string
string
configuration_lockout_config
object

Configure the system to be managed by a remote NMS. Every entry represents an owner and its corresponding configuration mode. This helps the external manager identify whether or not the device's configuration can be changed by anyone else.

integer
1 to 10

Specifies the maximum number of SSH authentication attemps permitted per connection.

integer
0 to 604800

This specifies the time in seconds for which the ports are to be disabled on detecting a loop. Default value is 0 i.e the port is disabled indefinitely.

string

Reference Resource: External_Storage
External storage to be used for all DHCPv6 servers.

string
string
boolean

Controls whether ssh public key authentication is enabled. This value will not be honored if two-factor authentication is enabled.

dlog_destination
object

Filter the dlogs that are sent to each possible destination based on the severity specified. If a destination is not present, no dlog messages will be sent to that destination. If no destinations are present then dlogs of severity debug or greater will be sent to buffer. Example: {'file':'info'} info and above level dlogs will be send to file destination.

string
integer
1 to 10

This specifies the time interval in seconds between successive transmissions of loop-protect packets. Default value is 5 seconds.

string

Domain name as configured by the user.

string
boolean

Enables only the SNMPv3 mode of operation and disallows SNMP v1 and v2c.

integer
50 to 20000

The shortest interval, in milliseconds, at which BFD sessions can transmit BFD control messages. Messages will actually be transmitted at a slower rate if the remote endpoints cannot receive them as quickly as specified.

string

Reference Resource: VSX
VSX configuration and status

string
logging_persistent_storage
object
boolean

Disable SNMP trap generation for the memory utilization alert.

integer
1 to 86400

ICMP throttle (in seconds) can be used to configure the packet interval to send ICMPv4/v6 error and redirect messages.

string
integer
100 to 20000

The shortest interval, in milliseconds, at which BFD sessions can receive BFD control messages. Remote endpoints may send messages at a slower rate.

string
dhcpv4_snooping_general_configuration
object
ntp_config
object
boolean

Controls whether ssh password based authentication is enabled. This value will not be honored if two-factor authentication is enabled.

dns_servers
array of strings
length ≤ 9223372036854776000
dns_servers
string
dhcp_config
object
boolean

Disable all RMON alarms.

boolean

Specifies whether the port security is enabled or not on the system. 'true': enables port security configuration globally. Though port security is enabled globally, the functionality is effective only if port security is also enabled on the port. 'false': disables port security configuration on the system.

boolean

Force ZTP based provisioning to run, ignoring the status of any previous ZTP operation.

boolean

If enabled, VNI mapped VLANs will be 'UP' only if there are authenticated clients on this VLAN or have some statically configured ports as members and those ports are 'UP'. When not set, VNI mapped VLANs will always be 'UP'.

string

Reference Resource: External_Storage
External storage to back up IP bindings learnt by DHCPv4 snooping.

string
boolean

Disable SNMP trap generation for the CPU utilization alert.

syslog_remotes
array of strings
length ≤ 4

Reference Resource: Syslog_Remote
List of syslog servers to which syslog messages will be forwarded. Syslog_Remote

syslog_remotes
boolean

Enables sending SNMP traps for VSX events.

string
string
mgmd_drop_unknown
object

MGMD Drop Unknown multicast traffic configuration. This feature can be enabled/disabled globally or per-VLAN for IGMP and MLD. If this field is set on-global, a single drop_unknown multicast filter is created to forward unknown multicast traffic for the Bridge. If this field is set as on-vlan, then one filter each will be created per-vlan to forward unknown multicast traffic on that VLAN. There could be cases where even if on-vlan is set, there are no more multicast filters available in the switch for a vlan and the vlan would fall back to a global filter. There could be cases where a global filter can't be supported in the given hardware platform. In those cases, though configuration is on-global, per-vlan filter would be created. There is a drop_unknown status in this same table which indicates the platform capability status. There is a drop_unknown status at VLAN level which indicates if for that VLAN, it falls back to global filter because of filter exhaustion. If the platform cannot support on-global and filters are exhausted then MGMD would flood the unknown multicast traffic on the VLAN.

string
string
string
string
string
enum

Set the console serial port data transmission speed.

Allowed:
string
enum

Sets CDP mode globally on the system: 'enable': Enables CDP globally 'disable': Disables CDP globally 'pass_through_enable': CDP packet will be forwarded through multicast forwarding

Allowed:
string
string
string

Profile that the system should use. If not set, the system boots with the default profile, as specified in the available_profiles. Note that for any change to take effect, the system must be restarted.

string
snmp_communities
array of strings
length ≤ 10

Community strings to be used by the system when communicating over SNMPv1/SNMPv2c.

snmp_communities
dhcpv4_snooping_external_storage_configuration
object
string
length between 1 and 64

Specifies the name of queue profile (see name) for ports that do not specify their own queue profile (see Port). When missing or when the name refers to an incomplete/invalid queue-profile, the factory-default profile will be used (i.e. the row in Q_Profile with hw_default set true). Check the value of the queue-profile key in qos_status to determine the currently operating queue-profile.

mgmd_lookup
object

Multicast Group Membership Discovery(MGMD) forwarding lookup configuration for IGMP and MLD. A lookup mode of mac indicates that the flow entries would be programmed in L2 table in hardware and a lookup mode of ip indicates that the flow entries woudl be programmed in L3 table in hardware. If this field is left empty, lookup mode default is considered mac. For enabling IGMPv3 and MLDv2, the lookup mode must be set as ip.

string

Reference Resource: Threshold_Profile
Specifies the threshold-profile name for ports that do not specify their own profile (see Port threshold_profile column).

stp_config
object

This represents information regarding stp global configuration.

dhcpv4_snooping_option82_configuration
object
arp_config
object
string
boolean

Global knob to enable or disable MVRP. MVRP is enabled if the value is True.

string
boolean

Disable ICMPv4 and ICMPv6 unreachable messages.

string
string
boolean

Disable USB port. When disabled, devices inserted into the USB port of the switch will not be detected and will not work.

string
string
string

Reference Resource: CoPP_Policy
Specifies the user-configured top-level CoPP policy. When missing, the policy in the hw_default_copp_policy column will be used.

boolean

Specifies whether TLS crypto algorithms should be restricted to only those algorithms certified to Common Criteria NDcPP requirements.

ssh_macs
object

This option specifies the SSH Message Authentication Codes (MACs) to use in priority order. The key represents the priority and the value is the MAC to be configured at that priority level. No configuration here means that the default MACs and priorities will be configured: 1. [email protected] 2. [email protected] 3. [email protected] 4. hmac-sha2-256 5. hmac-sha2-512 6. hmac-sha1

string
string

Host name as configured by the user.

boolean

Controls whether ssh password and X.509v3 certificate authentication is enabled.

boolean

Enable SNMP trap generation for Entity MIB related events.

dhcpv6_server_external_storage_configuration
object
boolean

Disables Bluetooth management. When disabled, Bluetooth adapters inserted into the USB port of the switch will not be detected and will not work. If the USB port is disabled via usb_disable, then this setting will have no effect.

password_complexity
object

If password_complexity is 'enable'd, then minimal complexity rules would be enforced on all new passwords. Existing passwords are not affected.

ecmp_config
object
string
string
mgmt_intf
object

This column is a map of string-string pairs Management interface column contains the attributes of management interface. The keys are name, mode, ip, subnet mask, default gateway, dns server IPv4 addresses. This column holds values that are configured by the user.

string
qos_pool_priorities_mapping_config
object

Reference Resource: Qos_Pool
The PCP-to-lossless-pool mapping for interfaces with Priority-Based Flow Control(PFC) enabled.

string

Reference Resource: VRF
VRF for NTP connections. If empty then 'default' VRF will be used.

rest_api
object
checkpoint_post_config
object
string
string
string
boolean

When set to true, SNMP unique request-id check will be enabled.

string
boolean

Specifies whether the ServiceOS password prompt is enabled or not in the system. This is only applicable for ServiceOS starting with version 01.03.0001, ignored otherwise.

console_logging
object

console-logging related configuration.

dsnoopv6_local_storage_configuration
object
string
string
dsnoopv4_local_storage_configuration
object
string
string
string

Reference Resource: VLAN
VLAN-ID assigned to clients whose traffic is being redirected to the UBT cluster.

string
string
boolean

Specify to true to enable Remote Device Access to the switch.

boolean

enable the key usage check on a peer cert received during TLS handshake for client-auth or server-auth usage.

string
string
string
dhcpv6_snooping_general_configuration
object
qos_config
object
string
radius_dynamic_authorization
object

Global configuration for RADIUS dynamic authorization feature.

string

User configured Timezone. Time zone of the device in case sensitive Posix format - "US/Pacific","Asia/Singapore", "Etc/GMT". Please refer to the full list of supported time zones at https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

string
Responses
200

OK

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Updated over 4 years ago

Language
LoadingLoading…

Updated over 4 years ago