System

System configuration encompasses fundamental device-level settings that define core operational behavior including hostname identification, global MTU, NV overlay VXLAN UDP port settings, SVI autostate behavior, and interface breakout maps. It includes global IPv4 settings (IP routing, ECMP hash tuning, ICMP redirect logging, source route control), and global IPv6 settings (IPv6 routing, access list local match behavior, ICMPv6 adjacency stale timer, ICMPv6 redirect syslog). System configuration also manages Ethernet defaults for switchport mode, shutdown behavior, transceiver support, storm control, link-status syslog levels, and interface syslog info. Additional sub-sections cover boot options, CFS distribution, CLI aliases, CoPP profiles, iCAM monitoring, hardware platform profiles, smart licensing transport, terminal timeouts, VTY access class ACL assignments, and VDC resource limits, establishing the foundational operational baseline for NX-OS devices.

Diagram

Classes

system (nxos.devices.configuration)

Name	Type	Constraint	Mandatory
hostname	String		No
mtu	Integer	min: `576`, max: `9216`	No
nv_overlay_vxlan_udp_port	Integer	min: `1024`, max: `65535`	No
nv_overlay_vxlan_udp_source_port_mode	Choice	`low`, `high`, `rfc`	No
interface_vlan_autostate	Boolean	`true`, `false`	No
ip_routing	Boolean	`true`, `false`	No
ip_access_list_match_local_traffic	Boolean	`true`, `false`	No
logging_level_ip	Choice	`emergency`, `alert`, `critical`, `error`, `warning`, `notification`, `informational`, `debug`	No
ip_redirect_syslog	Boolean	`true`, `false`	No
ip_redirect_syslog_interval	Integer	min: `30`, max: `1800`	No
ip_source_route	Boolean	`true`, `false`	No
hardware_ecmp_hash_offset_concatenation	Boolean	`true`, `false`	No
hardware_ecmp_hash_offset_value	Integer	min: `0`, max: `63`	No
hardware_ecmp_hash_polynomial	Choice	`crc16`, `crc32hi`	No
ipv6_routing	Boolean	`true`, `false`	No
ipv6_access_list_match_local_traffic	Boolean	`true`, `false`	No
ipv6_adjacency_stale_timer	Integer	min: `30`, max: `65535`	No
ipv6_adjacency_stale_timer_icmp	Boolean	`true`, `false`	No
ipv6_redirect_syslog	Boolean	`true`, `false`	No
ipv6_redirect_syslog_interval	Integer	min: `30`, max: `1800`	No
boot	Class	`[boot]`	No
interface_breakout_modules	List	`[interface_breakout_modules]`	No
cfs_distribute	Boolean	`true`, `false`	No
cfs_eth_distribute	Boolean	`true`, `false`	No
cfs_ipv4_distribute	Boolean	`true`, `false`	No
cfs_ipv4_mcast_address	String		No
cfs_ipv6_distribute	Boolean	`true`, `false`	No
cfs_ipv6_mcast_address	String		No
cli_aliases	List	`[cli_aliases]`	No
copp_profile	Choice	`strict`, `moderate`, `lenient`, `dense`	No
copp_rate_limit	Boolean	`true`, `false`	No
ethernet	Class	`[ethernet]`	No
icam_monitor_interval	Integer	min: `1`, max: `24`	No
icam_monitor_intervals	Integer	min: `168`, max: `1344`	No
icam_monitor_scale	Boolean	`true`, `false`	No
icam_monitor_threshold_critical	Integer	min: `1`, max: `100`	No
icam_monitor_threshold_info	Integer	min: `1`, max: `100`	No
icam_monitor_threshold_warning	Integer	min: `1`, max: `100`	No
platform	Class	`[platform]`	No
smart_licensing_transport	Choice	`callhome`, `cslu`, `off`, `smart`	No
smart_licensing_url_cslu	String		No
terminal_console_exec_timeout	Integer	min: `0`, max: `525600`	No
line_vty_access_class_in	String		No
line_vty_access_class_out	String		No
line_vty_exec_timeout	Integer	min: `0`, max: `525600`	No
line_vty_session_limit	Integer	min: `1`, max: `64`	No
vdcs	List	`[vdcs]`	No

boot (nxos.devices.configuration.system)

Name	Type	Constraint	Mandatory
auto_copy	Boolean	`true`, `false`	No
dhcp	Integer	min: `0`, max: `2147483647`	No
exclude_configuration	Boolean	`true`, `false`	No
mode	Choice	`none`, `lxc`	No
order	Choice	`bootflash`, `pxe`, `pxe2bootflash`, `bootflash2pxe`	No
poap	Boolean	`true`, `false`	No
image_verify	Boolean	`true`, `false`	No
nxos_image_sup_1	String		No
nxos_image_sup_2	String		No
aci	String		No

interface_breakout_modules (nxos.devices.configuration.system)

Name	Type	Constraint	Mandatory	Default Value
id	Integer	min: `1`, max: `32`	Yes
ports	List	`[ports]`	No

cli_aliases (nxos.devices.configuration.system)

Name	Type	Constraint	Mandatory	Default Value
name	String		Yes
command	String		Yes

ethernet (nxos.devices.configuration.system)

Name	Type	Constraint	Mandatory
default_switchport_shutdown	Boolean	`true`, `false`	No
service_unsupported_transceiver	Boolean	`true`, `false`	No
default_switchport	Choice	`layer2`, `layer3`	No
logging_event_port	Choice	`link-status-default`, `link-status-enable`, `none`, `trunk-status-default`, `trunk-status-enable`	No
default_interface_shutdown	Choice	`down`, `down-exclude-fabric`, `up`	No
link_failure_laser_on	Boolean	`true`, `false`	No
storm_control_multicast	Boolean	`true`, `false`	No
dot1q_tag_native	Boolean	`true`, `false`	No
admin_link_down_syslog_level	Integer	min: `0`, max: `7`	No
admin_link_up_syslog_level	Integer	min: `0`, max: `7`	No
interface_syslog_info	Choice	`default`, `info-1`	No

platform (nxos.devices.configuration.system)

Name	Type	Constraint	Mandatory
access_list_match_inner_header	Boolean	`true`, `false`	No
acl_tap_aggregation	Boolean	`true`, `false`	No
disable_parse_error	Boolean	`true`, `false`	No
global_tx_span	Boolean	`true`, `false`	No
high_multicast_priority	Boolean	`true`, `false`	No
hardware_lou_resource_threshold	Integer	min: `1`, max: `50`	No
ingress_bd_ifacl_label_optimization	Boolean	`true`, `false`	No
ingress_racl_size	Boolean	`true`, `false`	No
ingress_replication_round_robin	Boolean	`true`, `false`	No
ip_statistics	Boolean	`true`, `false`	No
ipv6_alpm_carve_value	Integer	min: `0`, max: `4096`	No
ipv6_lpm_max_entries	Integer	min: `0`, max: `6144`	No
lpm_max_limit	Integer	min: `0`, max: `4096`	No
multicast_dcs_check	Boolean	`true`, `false`	No
multicast_flex_stats	Boolean	`true`, `false`	No
multicast_lpm_max_entries	Integer	min: `0`, max: `4096`	No
multicast_max_limit	Integer	min: `0`, max: `8000`	No
multicast_nlb	Boolean	`true`, `false`	No
multicast_racl_bridge	Boolean	`true`, `false`	No
multicast_rpf_check_optimization	Boolean	`true`, `false`	No
multicast_service_reflect_port	Integer	min: `0`, max: `48`	No
multicast_syslog_threshold	Integer	min: `1`, max: `100`	No
mld_snooping	Boolean	`true`, `false`	No
mpls_adjacency_stats_mode	Choice	`PACKETS`, `BYTES`	No
mpls_ecmp	Boolean	`true`, `false`	No
mrouting_disable_l2_update	Boolean	`true`, `false`	No
mrouting_disable_second_route_update	Boolean	`true`, `false`	No
mrouting_performance_mode	Boolean	`true`, `false`	No
openflow_forward_pdu	Boolean	`true`, `false`	No
pbr_skip_self_ip	Boolean	`true`, `false`	No
pic_core	Boolean	`true`, `false`	No
port_channel_fast_convergence	Boolean	`true`, `false`	No
port_channel_load_balance	Choice	`dlb`, `rtag7`, `rtag7-murmur`, `rtag7-local-crc`, `dynamic-pin`	No
port_channel_load_balance_resilient	Boolean	`true`, `false`	No
port_channel_mpls_load_balance_label_ip	Boolean	`true`, `false`	No
port_channel_mpls_load_balance_label_only	Boolean	`true`, `false`	No
port_channel_scale_fanout	Boolean	`true`, `false`	No
profile_front_portmode	Choice	`sfp-plus`, `qsfp`	No
profile_mode	String		No
profile_tuple	Boolean	`true`, `false`	No
pstat	Boolean	`true`, `false`	No
qos_min_buffer	Choice	`all`, `none`, `default`	No
routing_mode	String		No
service_template_name	String		No
svi_and_si_flex_stats	Boolean	`true`, `false`	No
svi_flex_stats	Boolean	`true`, `false`	No
switch_mode	Choice	`default`, `n3k`, `n9k`	No
switching_fabric_speed	Choice	`default`, `fabric-speed-40g`	No
switching_mode	Choice	`store-forward`, `cut-through`	No
system_fabric_mode	Choice	`full-rate`, `default`	No
tcam_syslog_threshold	Integer	min: `1`, max: `100`	No
unicast_max_limit	Integer	min: `0`, max: `8000`	No
unicast_syslog_threshold	Integer	min: `1`, max: `100`	No
unicast_trace	Boolean	`true`, `false`	No
unknown_unicast_flood	Boolean	`true`, `false`	No
urpf	Boolean	`true`, `false`	No
wrr_unicast_bandwidth	Integer	min: `0`, max: `100`	No

vdcs (nxos.devices.configuration.system)

Name	Type	Constraint	Mandatory	Default Value
id	Integer	min: `0`, max: `65535`	Yes
resource_limits	Class	`[resource_limits]`	No

ports (nxos.devices.configuration.system.interface_breakout_modules)

Name	Type	Constraint	Mandatory	Default Value
id	Integer	min: `1`, max: `108`	Yes
map	Choice	`no-breakout`, `10g-4x`, `50g-2x`, `25g-4x`, `10g-2x`, `100g-4x`, `50g-4x`, `200g-1x`, `100g-2x`, `200g-2x`, `40g-1x`, `400g-2x`, `100g-8x`, `800g-1x`, `100g-2x-pam4`	No

resource_limits (nxos.devices.configuration.system.vdcs)

Name	Type	Constraint	Mandatory
multicast_ipv4_route_memory_maximum	Integer	min: `3`, max: `150`	No
multicast_ipv4_route_memory_minimum	Integer	min: `3`, max: `150`	No
multicast_ipv6_route_memory_maximum	Integer	min: `3`, max: `20`	No
multicast_ipv6_route_memory_minimum	Integer	min: `3`, max: `20`	No
port_channel_maximum	Integer	min: `0`, max: `766`	No
port_channel_minimum	Integer	min: `0`, max: `766`	No
unicast_ipv4_route_memory_maximum	Integer	min: `1`, max: `768`	No
unicast_ipv4_route_memory_minimum	Integer	min: `1`, max: `768`	No
unicast_ipv6_route_memory_maximum	Integer	min: `1`, max: `512`	No
unicast_ipv6_route_memory_minimum	Integer	min: `1`, max: `512`	No
vlan_maximum	Integer	min: `16`, max: `4094`	No
vlan_minimum	Integer	min: `16`, max: `4094`	No
vrf_maximum	Integer	min: `2`, max: `4097`	No
vrf_minimum	Integer	min: `2`, max: `4097`	No

Examples

Example 1: VXLAN leaf switch with system and Ethernet defaults

nxos:
  devices:
    - name: LEAF1
      configuration:
        system:
          hostname: LEAF1
          mtu: 9216
          ip_routing: true
          ipv6_routing: true
          ethernet:
            default_switchport: layer2
            default_switchport_shutdown: false
            service_unsupported_transceiver: true

Example 2: Spine switch with ECMP hash tuning for VXLAN fabric load balancing

nxos:
  devices:
    - name: SPINE1
      configuration:
        system:
          hostname: SPINE1
          mtu: 9216
          ip_routing: true
          ip_source_route: false
          hardware_ecmp_hash_polynomial: crc32hi
          hardware_ecmp_hash_offset_concatenation: true
          hardware_ecmp_hash_offset_value: 32
          ethernet:
            default_switchport: layer3
            default_switchport_shutdown: false

Example 3: Border leaf with IP/IPv6 routing, ICMP/ICMPv6 redirect logging, and Ethernet security

nxos:
  devices:
    - name: BORDER-LEAF1
      configuration:
        system:
          hostname: BORDER-LEAF1
          mtu: 9216
          ip_routing: true
          ip_source_route: false
          ip_access_list_match_local_traffic: true
          ip_redirect_syslog: true
          ip_redirect_syslog_interval: 300
          logging_level_ip: warning
          ipv6_routing: true
          ipv6_access_list_match_local_traffic: true
          ipv6_adjacency_stale_timer: 500
          ipv6_adjacency_stale_timer_icmp: true
          ipv6_redirect_syslog: true
          ipv6_redirect_syslog_interval: 120
          ethernet:
            default_switchport: layer2
            default_switchport_shutdown: true
            dot1q_tag_native: true
            logging_event_port: link-status-enable

Example 4: Ethernet defaults with link-status syslog tuning

nxos:
  devices:
    - name: LEAF1
      configuration:
        system:
          hostname: LEAF1
          ethernet:
            default_switchport: layer2
            default_switchport_shutdown: false
            logging_event_port: link-status-enable
            admin_link_down_syslog_level: 4
            admin_link_up_syslog_level: 4
            interface_syslog_info: info-1

Example 5: System boot configuration with NXOS image and POAP

nxos:
  devices:
    - name: LEAF1
      configuration:
        system:
          boot:
            auto_copy: true
            poap: false
            image_verify: true
            nxos_image_sup_1: bootflash:nxos64-cs.10.4.3.F.bin
            order: bootflash

Example 6: CFS distribution and CoPP profile

nxos:
  devices:
    - name: LEAF1
      configuration:
        system:
          cfs_distribute: true
          cfs_eth_distribute: true
          copp_profile: strict

Example 7: CLI aliases, terminal timeouts, and smart licensing

nxos:
  devices:
    - name: LEAF1
      configuration:
        system:
          cli_aliases:
            - name: wr
              command: copy running-config startup-config
            - name: sri
              command: show running-config interface
          terminal_console_exec_timeout: 0
          line_vty_exec_timeout: 30
          line_vty_session_limit: 10
          line_vty_access_class_in: VTY-ACL-IN
          line_vty_access_class_out: VTY-ACL-OUT
          smart_licensing_transport: cslu
          smart_licensing_url_cslu: https://cslu.example.com

Example 8: Hardware platform profile for VXLAN leaf

nxos:
  devices:
    - name: LEAF1
      configuration:
        system:
          platform:
            switching_mode: store-forward
            port_channel_load_balance: rtag7
            port_channel_load_balance_resilient: true
            multicast_rpf_check_optimization: true
            ingress_replication_round_robin: true
            urpf: true

Example 9: iCAM monitoring with scale thresholds

nxos:
  devices:
    - name: LEAF1
      configuration:
        system:
          icam_monitor_interval: 1
          icam_monitor_intervals: 168
          icam_monitor_scale: true
          icam_monitor_threshold_critical: 90
          icam_monitor_threshold_warning: 75
          icam_monitor_threshold_info: 50

Example 10: VDC resource limits for multi-tenant chassis

nxos:
  devices:
    - name: N7K-1
      configuration:
        system:
          vdcs:
            - id: 2
              resource_limits:
                vlan_minimum: 16
                vlan_maximum: 2048
                vrf_minimum: 2
                vrf_maximum: 512
                port_channel_minimum: 0
                port_channel_maximum: 256
                unicast_ipv4_route_memory_minimum: 1
                unicast_ipv4_route_memory_maximum: 384

Example 11: Interface breakout configuration for high-density ports

nxos:
  devices:
    - name: LEAF1
      configuration:
        system:
          interface_breakout_modules:
            - id: 1
              ports:
                - id: 49
                  map: 10g-4x
                - id: 50
                  map: 25g-4x