ethernetPcSubTypes - Nexus Dashboard API, Release 4.1(1)

{"type":"model","meta":{"id":"/apps/pubhub/media/nexus-dashboard-api-411/1d680a4cdd0fc79ff5ea7816bfd85c04c5374398/6892077b-82e7-33df-b47a-dd1fcda33552","info":{"contact":{"name":"API Support","url":"https://developer.cisco.com/docs/nexus-dashboard/4-1/developer-support/"},"description":"Manage APIs provide the ability to manage resources connected to the cluster","title":"Nexus Dashboard Manage v1","version":"1.0.130","x-nd-server-ignore":true},"x-parser-conf":{"overview":{"markdownPath":"reference-overviews/overview-manage.md"},"labelConfig":{"endpoint":{"field":"operationId","format":"startCase"}}},"openapi":"3.0.3","servers":[{"description":"Nexus Dashboard Manage APIs","url":"https://{cluster}/api/v1/manage","variables":{"cluster":{"default":"example.com","description":"The cluster URL/IP address","enum":["example.com","10.1.1.20"]}}}],"securitySchemes":{"OAuth2":{"type":"oauth2","description":"OAuth2 security scheme","flows":{"implicit":{"authorizationUrl":"https://example.com/login","scopes":{"observer":"Grants read access","fabric-admin":"Grants write access to fabric resources","support-engineer":"Primarily a role for support engineers to operate the managed resources","super-admin":"Grants access to all operations","approver":"Grants access to approve policies","designer":"Grants access to design policies"}}}},"http_signature":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"HTTP Signature security scheme"},"cookieAuth":{"type":"apiKey","description":"Cookie based authentication","in":"cookie","name":"AuthCookie"}}},"spec":{"description":"Ethernet pc sub types","discriminator":{"mapping":{"access":"#/components/schemas/accessInterface","custom":"#/components/schemas/customInterface","dot1qTunnel":"#/components/schemas/dot1qTunnelInterface","pvlanTrunk":"#/components/schemas/privateVlanTrunkInterface","routed":"#/components/schemas/routedL3Interface","trunk":"#/components/schemas/trunkInterface","unmanaged":"#/components/schemas/unmanagedInterface"},"propertyName":"subType"},"oneOf":[{"description":"Access Interface","properties":{"subType":{"description":"Type of the interface (e.g., access, trunk, pvlanTrunk, dot1qTunnel, routed, unManaged, custom)","enum":["access","trunk","pvlanTrunk","dot1qTunnel","routed","unManaged","custom"],"nullable":false,"type":"string","$$ref":"#/components/schemas/ethPcSubType"},"adminState":{"default":true,"description":"Enable/Disable Interface","type":"boolean"},"bpduGuard":{"default":"true","description":"Spanning-tree BPDU guard setting associated with this interface","enum":["true","false","no"],"type":"string"},"cdp":{"default":true,"description":"Enable CDP on the interface","type":"boolean"},"configDescription":{"description":"Configuration description","type":"string"},"duplexMode":{"default":"auto","description":"Interface duplex mode","enum":["auto","half","full"],"type":"string"},"enableOrphanPort":{"default":false,"description":"If enabled, configure the interface as a vPC orphan port to be suspended by the secondary peer in vPC failures","type":"boolean"},"freeformConfig":{"description":"logging event port link-status","type":"string"},"mtu":{"default":"default","description":"Layer-2 MTU associated with the interface","enum":["default","jumbo"],"type":"string"},"netflow":{"default":false,"description":"Enable netflow on the interface","type":"boolean"},"netflowMonitor":{"description":"Netflow Layer-2 monitor name for the interface","type":"string"},"netflowSampler":{"description":"Netflow Layer-2 sampler name for the interface (only applicable for Nexus 7000 platforms)","type":"string"},"pfc":{"default":false,"description":"Enable Priority Flow Control (PFC) on the interface","type":"boolean"},"portTypeFast":{"default":true,"description":"Enable/Disable spanning-tree edge port behavior","type":"boolean"},"qos":{"default":false,"description":"Enable QoS policy on the interface. If AI Queuing is enabled on the fabric, will use the QOS_CLASSIFICATION policy. Enter a custom policy below to override","type":"boolean"},"qosPolicy":{"description":"Custom QoS Policy associated with the interface (must be defined apriori)","type":"string"},"queueingPolicy":{"description":"Custom Queuing Policy associated with the interface (must be defined apriori)","type":"string"},"speed":{"default":"auto","description":"Interface speed","enum":["auto","10Mb","100Mb","1Gb","2.5Gb","5Gb","10Gb","25Gb","40Gb","50Gb","100Gb","200Gb","400Gb"],"type":"string"},"vlan":{"default":1,"description":"VLAN ID for the access port","maximum":4094,"minimum":1,"type":"integer"}},"required":["subType","vlan"],"type":"object","$$ref":"#/components/schemas/accessInterface"},{"description":"Trunk Interface","properties":{"subType":{"description":"Type of the interface (e.g., access, trunk, pvlanTrunk, dot1qTunnel, routed, unManaged, custom)","enum":["access","trunk","pvlanTrunk","dot1qTunnel","routed","unManaged","custom"],"nullable":false,"type":"string","$$ref":"#/components/schemas/ethPcSubType"},"adminState":{"default":true,"description":"Enable/Disable Interface","type":"boolean"},"bpduGuard":{"default":"true","description":"Spanning-tree BPDU guard setting associated with this interface","enum":["true","false","no"],"type":"string"},"cdp":{"default":true,"description":"Enable CDP on the interface","type":"boolean"},"configDescription":{"description":"Configuration description","type":"string"},"duplexMode":{"default":"auto","description":"Interface duplex mode","enum":["auto","half","full"],"type":"string"},"enableOrphanPort":{"default":false,"description":"If enabled, configure the interface as a vPC orphan port to be suspended by the secondary peer in vPC failures","type":"boolean"},"freeformConfig":{"description":"logging event port link-status","type":"string"},"mtu":{"default":"default","description":"Layer-2 MTU associated with the interface","enum":["default","jumbo"],"type":"string"},"netflow":{"default":false,"description":"Enable netflow on the interface","type":"boolean"},"netflowMonitor":{"description":"Netflow Layer-2 monitor name for the interface","type":"string"},"netflowSampler":{"description":"Netflow Layer-2 sampler name for the interface (only applicable for Nexus 7000 platforms)","type":"string"},"pfc":{"default":false,"description":"Enable Priority Flow Control (PFC) on the interface","type":"boolean"},"portTypeFast":{"default":true,"description":"Enable/Disable spanning-tree edge port behavior","type":"boolean"},"qos":{"default":false,"description":"Enable QoS policy on the interface. If AI Queuing is enabled on the fabric, will use the QOS_CLASSIFICATION policy. Enter a custom policy below to override","type":"boolean"},"qosPolicy":{"description":"Custom QoS Policy associated with the interface (must be defined apriori)","type":"string"},"queueingPolicy":{"description":"Custom Queuing Policy associated with the interface (must be defined apriori)","type":"string"},"speed":{"default":"auto","description":"Interface speed","enum":["auto","10Mb","100Mb","1Gb","2.5Gb","5Gb","10Gb","25Gb","40Gb","50Gb","100Gb","200Gb","400Gb"],"type":"string"},"mstData":{"description":"Mst L2 properties","properties":{"guardMode":{"default":"none","description":"Spanning-tree Guard Mode","enum":["root","none","loop",false],"type":"string"},"mstPathCostList":{"description":"Minimum Spanning-tree Intance List with different Port Path Cost","items":{"description":"Mst patch cost list","properties":{"mstInstanceList":{"description":"MST Instance List (e.g. 0,2-4,6,8-12). Should be between 0-4094.","type":"string"},"mstPortPriorityList":{"description":"Minimum Spanning-tree Intance List with different port priorities","items":{"description":"Mst port priority","properties":{"mstInstanceList":{"description":"MST Instance List (e.g. 0,2-4,6,8-12). Should be between 0-4094.","type":"string"},"portPriority":{"description":"Port priority","enum":[0,32,64,96,128,160,192,224],"type":"integer"}},"type":"object","$$ref":"#/components/schemas/mstPortPriorityListData"},"type":"array"},"pathCost":{"description":"Port Path Cost","maximum":200000000,"minimum":1,"type":"integer"}},"type":"object","$$ref":"#/components/schemas/mstPathCostListdata"},"type":"array"},"pathCost":{"description":"Spanning-tree Port Path Cost","maximum":200000000,"minimum":1,"type":"integer"}},"type":"object","$$ref":"#/components/schemas/mstL2Properties"},"nativeVlan":{"description":"Native VLAN associated with the trunk interface","maximum":4094,"minimum":1,"type":"integer"},"vlanIds":{"default":"none","description":"Allowed values are none, all, or vlan ranges (e.g. 1-200,500-2000,3000)","type":"string"}},"required":["subType","vlanIds"],"type":"object","$$ref":"#/components/schemas/trunkInterface"},{"description":"Private vlan trunk interface","properties":{"subType":{"description":"Type of the interface (e.g., access, trunk, pvlanTrunk, dot1qTunnel, routed, unManaged, custom)","enum":["access","trunk","pvlanTrunk","dot1qTunnel","routed","unManaged","custom"],"nullable":false,"type":"string","$$ref":"#/components/schemas/ethPcSubType"},"adminState":{"default":true,"description":"Enable/Disable Interface","type":"boolean"},"bpduGuard":{"default":"true","description":"Spanning-tree BPDU guard setting associated with this interface","enum":["true","false","no"],"type":"string"},"cdp":{"default":true,"description":"Enable CDP on the interface","type":"boolean"},"configDescription":{"description":"Configuration description","type":"string"},"duplexMode":{"default":"auto","description":"Interface duplex mode","enum":["auto","half","full"],"type":"string"},"enableOrphanPort":{"default":false,"description":"If enabled, configure the interface as a vPC orphan port to be suspended by the secondary peer in vPC failures","type":"boolean"},"freeformConfig":{"description":"logging event port link-status","type":"string"},"mtu":{"default":"default","description":"Layer-2 MTU associated with the interface","enum":["default","jumbo"],"type":"string"},"netflow":{"default":false,"description":"Enable netflow on the interface","type":"boolean"},"netflowMonitor":{"description":"Netflow Layer-2 monitor name for the interface","type":"string"},"netflowSampler":{"description":"Netflow Layer-2 sampler name for the interface (only applicable for Nexus 7000 platforms)","type":"string"},"pfc":{"default":false,"description":"Enable Priority Flow Control (PFC) on the interface","type":"boolean"},"portTypeFast":{"default":true,"description":"Enable/Disable spanning-tree edge port behavior","type":"boolean"},"qos":{"default":false,"description":"Enable QoS policy on the interface. If AI Queuing is enabled on the fabric, will use the QOS_CLASSIFICATION policy. Enter a custom policy below to override","type":"boolean"},"qosPolicy":{"description":"Custom QoS Policy associated with the interface (must be defined apriori)","type":"string"},"queueingPolicy":{"description":"Custom Queuing Policy associated with the interface (must be defined apriori)","type":"string"},"speed":{"default":"auto","description":"Interface speed","enum":["auto","10Mb","100Mb","1Gb","2.5Gb","5Gb","10Gb","25Gb","40Gb","50Gb","100Gb","200Gb","400Gb"],"type":"string"},"associationList":{"description":"Private VLAN host association. Application for private vlan mode host or trunk secondary.","items":{"description":"Association list data","properties":{"primaryVlan":{"description":"Primary VLAN","maximum":4094,"minimum":1,"type":"integer"},"secondaryVlan":{"description":"Secondary VLAN","maximum":4094,"minimum":1,"type":"string"}},"type":"object","$$ref":"#/components/schemas/associationListData"},"type":"array"},"mappingList":{"description":"Private VLAN promiscuous mapping. Application for private vlan mode promiscuous or trunk promiscuous.","items":{"description":"VLANs details","properties":{"primaryVlan":{"description":"Primary VLAN","maximum":4094,"minimum":1,"type":"integer"},"secondaryVlans":{"description":"Secondary VLANs","type":"string"}},"type":"object","$$ref":"#/components/schemas/mappingListData"},"type":"array"},"privateVlanMode":{"description":"Private VLAN mode","enum":["promiscuous","trunk promiscuous","host","trunk secondary"],"type":"string"},"nativeVlan":{"description":"Native VLAN associated with the trunk interface","maximum":4094,"minimum":1,"type":"integer"},"vlanIds":{"default":"none","description":"Private VLAN allowed values. Value can be none, all, or vlan ranges (e.g. 1-200,500-2000,3000). Not applicable for private VLAN mode host or promiscuous.","type":"string"}},"required":["subType","privateVlanMode"],"type":"object","$$ref":"#/components/schemas/privateVlanTrunkInterface"},{"description":"Dot 1q tunnel interface","properties":{"subType":{"description":"Type of the interface (e.g., access, trunk, pvlanTrunk, dot1qTunnel, routed, unManaged, custom)","enum":["access","trunk","pvlanTrunk","dot1qTunnel","routed","unManaged","custom","access","trunk","pvlanTrunk","dot1qTunnel","routed","unManaged","custom"],"nullable":false,"type":"string","$$ref":"#/components/schemas/ethPcSubType"},"adminState":{"default":true,"description":"Enable/Disable Interface","type":"boolean"},"bpduGuard":{"default":"true","description":"Spanning-tree BPDU guard setting associated with this interface","enum":["true","false","no"],"type":"string"},"cdp":{"default":true,"description":"Enable CDP on the interface","type":"boolean"},"configDescription":{"description":"Configuration description","type":"string"},"duplexMode":{"default":"auto","description":"Interface duplex mode","enum":["auto","half","full"],"type":"string"},"enableOrphanPort":{"default":false,"description":"If enabled, configure the interface as a vPC orphan port to be suspended by the secondary peer in vPC failures","type":"boolean"},"freeformConfig":{"description":"logging event port link-status","type":"string"},"mtu":{"default":"default","description":"Layer-2 MTU associated with the interface","enum":["default","jumbo"],"type":"string"},"netflow":{"default":false,"description":"Enable netflow on the interface","type":"boolean"},"netflowMonitor":{"description":"Netflow Layer-2 monitor name for the interface","type":"string"},"netflowSampler":{"description":"Netflow Layer-2 sampler name for the interface (only applicable for Nexus 7000 platforms)","type":"string"},"pfc":{"default":false,"description":"Enable Priority Flow Control (PFC) on the interface","type":"boolean"},"portTypeFast":{"default":true,"description":"Enable/Disable spanning-tree edge port behavior","type":"boolean"},"qos":{"default":false,"description":"Enable QoS policy on the interface. If AI Queuing is enabled on the fabric, will use the QOS_CLASSIFICATION policy. Enter a custom policy below to override","type":"boolean"},"qosPolicy":{"description":"Custom QoS Policy associated with the interface (must be defined apriori)","type":"string"},"queueingPolicy":{"description":"Custom Queuing Policy associated with the interface (must be defined apriori)","type":"string"},"speed":{"default":"auto","description":"Interface speed","enum":["auto","10Mb","100Mb","1Gb","2.5Gb","5Gb","10Gb","25Gb","40Gb","50Gb","100Gb","200Gb","400Gb"],"type":"string"},"vlan":{"default":1,"description":"VLAN ID for the access port","maximum":4094,"minimum":1,"type":"integer"}},"required":["subType","subType","vlan"],"type":"object","$$ref":"#/components/schemas/dot1qTunnelInterface"},{"description":"Routed L3 interface","properties":{"subType":{"description":"Type of the interface (e.g., access, trunk, pvlanTrunk, dot1qTunnel, routed, unManaged, custom)","enum":["access","trunk","pvlanTrunk","dot1qTunnel","routed","unManaged","custom"],"nullable":false,"type":"string","$$ref":"#/components/schemas/ethPcSubType"},"adminState":{"default":true,"description":"Enable/Disable Interface","type":"boolean"},"cdp":{"default":true,"description":"Enable CDP on the interface","type":"boolean"},"configDescription":{"description":"Configuration description","type":"string"},"disableIpRedirects":{"default":false,"description":"Disable both IPv4/IPv6 redirects on the interface","type":"boolean"},"duplexMode":{"default":"auto","description":"Interface duplex mode","enum":["auto","half","full"],"type":"string"},"freeformConfig":{"description":"Additional CLI for the interface","type":"string"},"ipv4Address":{"description":"IP address of the interface","type":"string"},"ipv4Prefix":{"description":"IP netmask length used with the IP address","maximum":31,"minimum":1,"type":"integer"},"ipv6Address":{"description":"IPv6 address of the interface","type":"string"},"ipv6Prefix":{"description":"IPv6 prefix length","maximum":127,"minimum":1,"type":"integer"},"mtu":{"default":9216,"description":"Layer-3 MTU associated with the interface","maximum":9216,"minimum":576,"type":"integer"},"netflow":{"default":false,"description":"Enable netflow on the interface","type":"boolean"},"netflowMonitor":{"description":"Netflow Layer-3 monitor name for the interface","type":"string"},"netflowSampler":{"description":"Netflow sampler name for the interface (only applicable for Nexus 7000 platforms)","type":"string"},"pfc":{"default":false,"description":"Enable Priority Flow Control (PFC) on the interface","type":"boolean"},"pimDrPriority":{"default":1,"description":"Configure priority for PIM DR election on the interface","format":"int64","maximum":4294967295,"minimum":1,"type":"integer"},"pimSparseMode":{"default":false,"description":"Enable PIM sparse-mode on the interface","type":"boolean"},"qos":{"default":false,"description":"Enable QoS policy on the interface. If AI Queuing is enabled on the fabric, will use the QOS_CLASSIFICATION policy. Enter a custom policy below to override","type":"boolean"},"qosPolicy":{"description":"Custom QoS Policy associated with the interface (must be defined apriori)","type":"string"},"queueingPolicy":{"description":"Custom Queuing Policy associated with the interface (must be defined apriori)","type":"string"},"routingTag":{"description":"Routing tag associated with interface IP","type":"string"},"speed":{"default":"auto","description":"Interface speed","enum":["auto","10Mb","100Mb","1Gb","2.5Gb","5Gb","10Gb","25Gb","40Gb","50Gb","100Gb","200Gb","400Gb"],"type":"string"},"vrfName":{"description":"Interface VRF name, default VRF if not specified","maxLength":32,"minLength":1,"type":"string"}},"required":["subType"],"type":"object","$$ref":"#/components/schemas/routedL3Interface"},{"description":"Unmanaged interface","properties":{"subType":{"description":"Type of the interface (e.g., access, trunk, pvlanTrunk, dot1qTunnel, routed, unManaged, custom)","enum":["access","trunk","pvlanTrunk","dot1qTunnel","routed","unManaged","custom"],"nullable":false,"type":"string","$$ref":"#/components/schemas/ethPcSubType"},"undefined":{"description":"TBD","type":"string"}},"required":["subType"],"type":"object","$$ref":"#/components/schemas/unmanagedInterface"},{"description":"Custom interface","properties":{"subType":{"description":"Type of the interface (e.g., access, trunk, pvlanTrunk, dot1qTunnel, routed, unManaged, custom)","enum":["access","trunk","pvlanTrunk","dot1qTunnel","routed","unManaged","custom"],"nullable":false,"type":"string","$$ref":"#/components/schemas/ethPcSubType"},"interfaceTemplate":{"description":"Name of the interface template","type":"string"},"nvPairs":{"additionalProperties":true,"description":"object containing name value pairs associated with properties defined in the custom interface template","type":"object"}},"required":["subType","interfaceTemplate","nvPairs"],"type":"object","$$ref":"#/components/schemas/customInterface"}],"$$ref":"#/components/schemas/ethernetPcSubTypes","title":"ethernetPcSubTypes"}}