brocade fabric os rest api reference manual, 9.0

Brocade® Fabric OS® REST API Reference Manual, 9.0.x

Reference Manual30 June 2021

FOS-90x-REST-API-RM10430 June 2021

Broadcom

Copyright © 2020–2021 Broadcom. All Rights Reserved. Broadcom, the pulse logo, Brocade, the stylized B logo, andFabric OS are among the trademarks of Broadcom in the United States, the EU, and/or other countries. The term“Broadcom” refers to Broadcom Inc. and/or its subsidiaries.

Broadcom reserves the right to make changes without further notice to any products or data herein to improve reliability,function, or design. Information furnished by Broadcom is believed to be accurate and reliable. However, Broadcom doesnot assume any liability arising out of the application or use of this information, nor the application or use of any product orcircuit described herein, neither does it convey any license under its patent rights nor the rights of others.

The product described by this document may contain open source software covered by the GNU General Public Licenseor other open source license agreements. To find out which open source software is included in Brocade products, to viewthe licensing terms applicable to the open source software, and to obtain a copy of the programming source code, pleasedownload the open source disclosure documents in the Broadcom Customer Support Portal (CSP). If you do not have aCSP account or are unable to log in, please contact your support provider for this information.

Broadcom

FOS-90x-REST-API-RM104 Reference Manual Brocade® Fabric OS® REST API Reference Manual, 9.0.x

Table of Contents

Introduction...........................................................................................................................................7Supported Hardware and Software................................................................................................................................ 7REST Terminology............................................................................................................................................................8

Terms Used in YANG Files.........................................................................................................................................9Standards and Related References..............................................................................................................................10Contacting Technical Support for Your Brocade

® Product....................................................................................... 12

Document Feedback...................................................................................................................................................... 12Fabric OS REST API Overview.........................................................................................................13

FOS REST API Described.............................................................................................................................................. 13Functionality...............................................................................................................................................................14

FOS REST API URI Restrictions....................................................................................................................... 15Security and the FOS REST API...................................................................................................................... 15Zoning Operations..............................................................................................................................................16Diagnostic Port Requests.................................................................................................................................. 17Protocol Support................................................................................................................................................ 17FOS REST API Request Throttling................................................................................................................... 18Scalability Recommendations for FOS REST API Clients................................................................................20

FOS REST API and Brocade Extension...................................................................................................................20Restrictions on FOS REST API Configuration Attributes and Statistics............................................................21

Using the Brocade FOS REST API...............................................................................................................................21FOS REST API Role-Based Access Control........................................................................................................... 24HTTP Header............................................................................................................................................................ 25Request Headers...................................................................................................................................................... 25Media Types.............................................................................................................................................................. 25HTTP Status Codes and Messages......................................................................................................................... 26Supported Methods................................................................................................................................................... 26

DELETE Method................................................................................................................................................ 26GET Method.......................................................................................................................................................27HEAD Method.................................................................................................................................................... 28OPTIONS Method.............................................................................................................................................. 28PATCH Method...................................................................................................................................................29POST Method.................................................................................................................................................... 30

Using Brocade FOS REST API Session-Less Operation...........................................................................................31FOS REST API Version History.................................................................................................................................... 33Deprecated and Obsolete Resources.......................................................................................................................... 36FOS REST API and Brocade Virtual Fabrics.............................................................................................................. 37

FOS-90x-REST-API-RM1043

Broadcom


Fabric OS REST Session Configuration......................................................................................................................37Enabling and Disabling the Fabric OS REST Interface........................................................................................... 38Encrypted Authorization Token................................................................................................................................. 38

Generating an Encrypted Authorization Token..................................................................................................38Enabling and Disabling Protocol Support.................................................................................................................39Enabling and Disabling Keep Alive Mode................................................................................................................ 40Fabric OS REST Interface Session Value Configuration......................................................................................... 41Fabric OS REST Session Identification and Termination.........................................................................................41

YANG Module Overview.................................................................................................................................................42Supported Data Types.............................................................................................................................................. 43Additional FOS REST API Data Types.................................................................................................................... 44

FOS REST API YANG modules.....................................................................................................................................71FOS REST API Modules for Operations..........................................................................................75

brocade-operation-device-management.......................................................................................................................75brocade-operation-extension........................................................................................................................................ 79brocade-operation-fabric............................................................................................................................................... 84brocade-operation-firmwaredownload......................................................................................................................... 86brocade-operation-license............................................................................................................................................. 94brocade-operation-lldp.................................................................................................................................................100brocade-operation-pcie-health.................................................................................................................................... 103brocade-operation-show-status.................................................................................................................................. 106brocade-operation-supportlink....................................................................................................................................109brocade-operation-supportsave..................................................................................................................................112brocade-operation-zone............................................................................................................................................... 117

FOS REST API Modules for Fibre Channel Features...................................................................119brocade-access-gateway............................................................................................................................................. 119brocade-chassis............................................................................................................................................................139brocade-fabric............................................................................................................................................................... 148brocade-fabric-traffic-controller.................................................................................................................................. 156brocade-fdmi................................................................................................................................................................. 166brocade-fibrechannel-configuration........................................................................................................................... 181brocade-fibrechannel-diagnostics.............................................................................................................................. 192brocade-fibrechannel-logical-switch.......................................................................................................................... 209brocade-fibrechannel-routing......................................................................................................................................219brocade-fibrechannel-switch....................................................................................................................................... 232brocade-fibrechannel-trunk......................................................................................................................................... 244brocade-ficon................................................................................................................................................................ 255brocade-fru.................................................................................................................................................................... 277brocade-interface/fibrechannel................................................................................................................................... 303


Broadcom


brocade-license.............................................................................................................................................................343brocade-lldp.................................................................................................................................................................. 362brocade-logging............................................................................................................................................................371brocade-logging Examples..........................................................................................................................................382brocade-maps............................................................................................................................................................... 398brocade-maps Examples............................................................................................................................................. 429brocade-media.............................................................................................................................................................. 449brocade-name-server................................................................................................................................................... 463brocade-security........................................................................................................................................................... 472brocade-security Examples.........................................................................................................................................506brocade-snmp............................................................................................................................................................... 545brocade-supportlink..................................................................................................................................................... 569brocade-time................................................................................................................................................................. 578brocade-time Examples............................................................................................................................................... 580brocade-zone.................................................................................................................................................................583

FOS REST API Modules for Extension Features..........................................................................598brocade-extension........................................................................................................................................................ 598brocade-extension-ip-route......................................................................................................................................... 632brocade-extension-ipsec-policy.................................................................................................................................. 636brocade-extension-tunnel............................................................................................................................................ 640brocade-interface/extension-ip-interface................................................................................................................... 683brocade-interface/gigabitethernet...............................................................................................................................690brocade-interface/portchannel.................................................................................................................................... 701

Sample Use Cases........................................................................................................................... 706Logging On, Retrieving Switch Information, and Logging Out...............................................................................706Logging On, Retrieving Chassis Information, and Logging Out Using Session-Less REST API Operation.......708Creating a Port Trunk Area Using JSON...................................................................................................................708Disabling and Enabling a Port....................................................................................................................................712Creating an Up State Tunnel Using Multiple URIs................................................................................................... 713Running a ClearLink Diagnostic Port Test................................................................................................................716Creating a MAPS Rule to Monitor CRC Errors on FC Ports................................................................................... 718Monitoring the Execution of a MAPS Rule............................................................................................................... 720Creating a User-Defined Group, Adding Ports to the Group, and Using the Group to Monitor a Rule............... 721Retrieving the Switch Status Policy Report..............................................................................................................722Generating a CSR and Importing a Security Certificate..........................................................................................723Configuring SSH Public Key Authentication on a Switch for Incoming Connections..........................................725Configuring SSH Public Key Authentication on a Switch for Outgoing Connections..........................................726Creating a New Zone Using REST............................................................................................................................. 727Adding Additional Zone Members to an Existing Zone...........................................................................................728


Broadcom


Creating, Modifying, and Deleting a Zone Using REST...........................................................................................729Creating a New Zone in an Existing Configuration Using REST........................................................................... 729Modifying a Zone.................................................................................................................................................... 732Aborting a Zone Transaction.................................................................................................................................. 734Deleting a Zone.......................................................................................................................................................735

Concurrent Zoning Transactions on a Local Switch............................................................................................... 738Multiswitch Concurrent Transaction Cancellation....................................................................................................738Simultaneous Multiswitch Zone Transaction Commitments................................................................................... 739REST Zone Transaction Timer Timeout.....................................................................................................................739

References........................................................................................................................................ 740REST API Description..................................................................................................................................................740

Resources................................................................................................................................................................740Base Resources...................................................................................................................................................... 741Resources and the YANG Model........................................................................................................................... 741Relationship of YANG and Resource Data Models................................................................................................741Uniform Resource Identifiers.................................................................................................................................. 742

URI Structure................................................................................................................................................... 742XML Resource Representation................................................................................................................................... 743JSON Resource Representation.................................................................................................................................744Error Reporting.............................................................................................................................................................746

Error Returned Due to Invalid POST Request....................................................................................................... 747Existing IP Address Error....................................................................................................................................... 748Unsupported Platform Error.................................................................................................................................... 749Login Errors.............................................................................................................................................................749

Revision History............................................................................................................................... 751


Broadcom


IntroductionThis document describes the REST API (a programmable Web service interface) for Brocade® Fabric OS® (FOS). TheREST API can manage Brocade SAN switches across a fabric.

Supported Hardware and SoftwareThe following hardware platforms are supported by Fabric OS 9.0.x.

Although many different software and hardware configurations are tested and supported by Broadcom Inc. for Fabric OS9.0.x, documenting all possible configurations and scenarios is beyond the scope of this document.

Fabric OS support for the Brocade Analytics Monitoring Platform (AMP) device depends on the specific version of thesoftware running on that platform. For more information, refer to the Brocade Analytics Monitoring Platform documentationand release notes.

Brocade Gen 5 (16G) Fixed-Port Switches

• Brocade 6505 Switch• Brocade 6510 Switch• Brocade 6520 Switch• Brocade M6505 blade server SAN I/O module• Brocade 6542 blade server SAN I/O module• Brocade 6543 blade server SAN I/O module• Brocade 6545 blade server SAN I/O module• Brocade 6546 blade server SAN I/O module• Brocade 6547 blade server SAN I/O module• Brocade 6548 blade server SAN I/O module• Brocade 6558 blade server SAN I/O module• Brocade 7840 Extension Switch

Brocade Gen 5 (16G) Directors

For ease of reference, Brocade chassis-based storage systems are standardizing on the term “director.” The legacy term“backbone” can be used interchangeably with the term “director.”

• Brocade DCX 8510-4 Director• Brocade DCX 8510-8 Director


• Brocade G610 Switch• Brocade G620 Switch• Brocade G630 Switch• Brocade 7810 Extension Switch


• Brocade X6-4 Director• Brocade X6-8 Director


Broadcom



• Brocade G720 Switch


• Brocade X7-4 Director• Brocade X7-8 Director

REST TerminologyThe following terms are used in this manual to describe REST and REST functionality contained in the Brocade FOSREST API.

base URI A base URI is specific to the Fabric OS server. All URIs accessing the same server use the same baseURI. For example, in the request “POST http://10.10.10.10/rest/login”, “http://10.10.10.10/rest/” is the baseURI.

device Any host or target device with a distinct WWN. Devices may be physical or virtual.D_Port A port configured as a diagnostic port on a switch or connected fabric switch, used to run diagnostic tests

between ports to test the link.E_Port An interswitch link (ISL) port. A switch port that connects switches together to form a fabric.F_Port A fabric port. A switch port that connects a host, host bus adapter (HBA), or storage device to a SAN.fabric A fabric consists of interconnected nodes that look like a single logical unit when viewed collectively.

This refers to a consolidated high-performance network system consisting of coupled storage devices,networking devices, and parallel processing high bandwidth interconnects such as 8Gb/s, 10Gb/s, 16Gb/s,or 32Gb/s Fibre Channel ports.

FCID A Fibre Channel ID (FCID) is a 24-bit (3 byte) field used to route frames through a Fibre Channel (FC)network. The FOS REST API shows this as a decimal value, such as “14776283”.

FCIP Fiber Channel over IP. This functionality allows connectivity between two remote fabrics that are separatedby an IP network. FCIP is different from “IP over FC”. Refer to RFC 3821.

HTTP HyperText Transfer Protocol. An application protocol for distributed, collaborative, and hypermediainformation systems. Refer to RFC 7230.

Internet Protocol (IP) The principal communications protocol in the Internet Protocol suite. It conveys packets from a source hostto a destination host based on the IP addresses contained in the packet headers. Refer to RFC 791.

IPsec Internet Protocol security. A network protocol suite that authenticates and encrypts the packets of datasent over a network, protecting data flows between a pair of hosts (host-to-host), between a pair of securitygateways (network-to-network), or between a security gateway and a host (network-to-host). Refer toRFC 4301, RFC 4303, and RFC 4309.

JSON JavaScript Object Notation. JSON is an open-standard file format that uses human-readable text to transmitdata objects consisting of attribute–value pairs and array data types (or any other serializable value). Itis a very common data format used for asynchronous browser–server communication, including as areplacement for XML in some AJAX-style systems. Refer to RFC 8259 and ECMA-404.

N_Port A node port. A N_Port presents a host or storage device to the fabric.NETCONF NETwork CONFiguration protocol. A network management protocol developed and standardized by the

IETF. Refer to RFC 6241.NPIV N_Port ID Virtualization. NPIV is a Fibre Channel facility that allows multiple F_Port IDs to share a single

physical N_Port. Multiple F_Ports can be mapped to a single N_Port. This allows multiple Fibre Channelinitiators to occupy a single physical port, easing hardware requirements in storage area network design,especially for virtual SANs.

REST REpresentational State Transfer is a way of providing interoperability between computer systems in anetwork.


Broadcom

https://tools.ietf.org/html/rfc3821







http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf



RESTCONF REST CONFiguration protocol. A RESTful protocol used to access data defined using the YANG language.Refer to RFC 8040.

request URI A request URI is the URI used to perform a REST HTTP request such as GET, POST, PUT, DELETE,HEAD or OPTIONS.

SNMP Simple Network Management Protocol. SNMP is a set of protocols for managing complex networks. SNMPprotocols are application layer protocols. Using SNMP, devices within a network send messages, calledprotocol data units (PDUs), to different parts of a network. Refer to RFC 1157, RFC 3411, RFC 3412, RFC3414 and RFC 3415.

TCP Transmission Control Protocol. One of the main protocols of the Internet Protocol (IP) suite. TCP providesreliable, ordered, and error-checked delivery of a stream of data in octets between applications running onhosts communicating by an IP network. Refer to RFC 1122 and RFC 7323.

VE_Port Virtual E_Port. Software mechanism for creating a logical E_Port connection to allow the Fibre Channelfabric protocols to communicate over this virtual interface. Typically used for FCIP products.

YANG Yet Another Next Generation. A data modeling language for the definition of data sent over the NETCONFnetwork configuration protocol. Refer to RFC 7950.

XML eXtensible Markup Language. A markup language that defines a set of rules for encoding documents ina format that is both human-readable and machine-readable through use of tags that can be created anddefined by users. Refer to the W3C XML standard.

NOTEDefinitions are based on information extracted from either the specific standard or the Wikipedia entry for thatterm.

For definitions of additional SAN-specific terms, visit the Storage Networking Industry Association online dictionary:

http://www.snia.org/education/dictionary

Terms Used in YANG FilesThe following list provides definitions and explanations for terms commonly used when discussing YANG files. Refer toRFC 6020 for complete details on YANG language features.

augmentation The module hierarchy can be augmented, allowing one module to add data nodes to the hierarchy definedin another module (without changing the augmented module). Augmentation can be conditional, usingwhen statements, with new nodes appearing only if certain conditions are met.

case node YANG allows the data model to segregate incompatible nodes into distinct choices using “choice” and“case” statements. A “choice” statement contains a set of “case” statements that define sets of schemanodes that cannot appear together. Each “case” may contain multiple nodes, but each node may appearin only one “case” under a “choice”. When an element from one case is created, all elements from all othercases are implicitly deleted.

The device handles the enforcement of the constraint, preventing incompatibilities from existing in theconfiguration.

The choice and case nodes appear only in the schema tree, not in the data tree or in NETCONF messages.The additional levels of hierarchy are not needed beyond the conceptual schema. Refer to section 4.2.7 ofRFC 6020.

choice node This defines a set of alternatives, only one of which may exist at any one time. A choice consists of anumber of branches, defined with case substatements. The nodes from one of the choice's branches(limited to one) exist in the data tree, and the choice node itself does not exist in the data tree.

container A container node has at most one instance in a module.data model A data model describes how data is represented and accessed. In YANG, data models are represented

by definition hierarchies called schema trees. Instances of schema trees are called data trees and areencoded in XML.

data node Data nodes can represent either configuration data or state data. The config statement specifies whetherthe definition it occurs in represents configuration data (config=true) or status data (config=false). If config


Broadcom











http://www.w3.org/TR/xml/

http://www.snia.org/education/dictionary




is not specified, the default is the same as the parent schema node’s config value. If the top node does notspecify a config statement, the default is config=true.

grouping A grouping defines a reusable collection of nodes.if An “if” statement in a .yang file indicates that the leaf or container has conditional support. Refer to section

7.18.2 of RFC 6020.key A key provides a unique identifier for an entry in a list. A key may be composed of a single leaf, such as

“name”, or by a combination of leaves such as “name” plus “address”.leaf A leaf node has at most one instance in a container or list.

leaf-list A leaf-list node may have multiple instances.leafref A leafref is used to reference a particular leaf instance in the data tree, as specified by a path. This path

is specified using the XML Path Language (XPath), in a notation that is similar to the syntax for directorypaths in UNIX/Linux.

list A list defines a sequence of list entries. Each entry is like a structure or a record instance, and the individualentry is uniquely identified by the values of its key leafs. A list can define multiple key leafs and may containany number of child nodes of any type (including leafs, lists, containers).

mandatory A mandatory statement indicates that a node must exist in the data tree. This applies only to POSTrequests.

module YANG organizes data models into modules and submodules. A module can import data from othermodules, and include data from submodules. Besides schema definitions, a module contains headerstatements (yang-version, namespace, prefix), linkage statements (import and include), meta-information(organization, contact), and a revision history.

presence A presence statement provides a description of what the model designer intends the node’s presence tosignify.

schema tree A schema tree defines the data structure for validation, documentation, and interaction control.when A “when” statement in a .yang file makes the node's parent data definition statement conditional. The node

defined by the parent data definition statement is only valid when the condition specified by the “when”statement is satisfied. Refer to section 7.19.5 of RFC 6020.

union A data type that is composed of multiple data types.

Standards and Related ReferencesThe following list identifies the IETF RFCs, ECMA, and W3C standards that apply to the FOS REST API.

• User Datagram Protocol (RFC 768)• Internet Protocol (RFC 791)• Transmission Control Protocol (RFC 793)• Requirements for Internet Hosts -- Communication Layers (RFC 1122)• Requirements for Internet Hosts -- Application and Support (RFC 1123)• A Simple Network Management Protocol (SNMP) (RFC 1157)• Management Information Base for Network Management of TCP/IP-based internets: MIB-II (RFC 1213)• Guidelines for creation, selection, and registration of an Autonomous System (AS) (RFC 1930)• TCP Slow Start, Congestion Avoidance, Fast Retransmit, and Fast Recovery Algorithms (RFC 2001)• Internet Protocol, Version 6 (IPv6) Specification (RFC 2460)• Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers (RFC 2474)• Structure of Management Information Version 2 (SMIv2) (RFC 2578)• Textual Conventions for SMIv2 (RFC 2579)• IANA Allocation Guidelines For Values In the Internet Protocol and Related Headers (RFC 2780)• Textual Conventions for Additional High Capacity Data Types (RFC 2856)• Management Information Base for the Differentiated Services Architecture (RFC 3289)


Broadcom




















• Report from the Joint W3C/IETF URI Planning Interest Group: Uniform Resource Identifiers (URIs), URLs, and UniformResource Names (URNs): Clarifications and Recommendations (RFC 3305)

• An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks (RFC 3411)• Message Processing and Dispatching for the Simple Network Management Protocol (SNMP) (RFC 3412)• Simple Network Management Protocol (SNMP) Applications (RFC 3413)• User-based Security Model (USM) for version 3 of the Simple Network Management Protocol (SNMPv3) (RFC 3414)• View-based Access Control Model (VACM) for the Simple Network Management Protocol (SNMP) (RFC 3415)• Internet Protocol Version 6 (IPv6) Addressing Architecture (RFC 3513)• Textual Conventions for IPv6 Flow Label (RFC 3595) (RFC 3595)• Fibre Channel Over TCP/IP (FCIP) (RFC 3821)• Uniform Resource Identifier (URI): Generic Syntax (RFC 3986)• Textual Conventions for Internet Network Addresses (RFC 4001)• IPv6 Scoped Address Architecture (RFC 4007)• A Universally Unique IDentifier (UUID) URN Namespace (RFC 4122)• A Border Gateway Protocol 4 (BGP-4) (RFC 4271)• IP Version 6 Addressing Architecture (RFC 4291)• Security Architecture for the Internet Protocol (RFC 4301)• IP Encapsulating Security Payload (ESP) (RFC 4303)• Using Advanced Encryption Standard (AES) CCM Mode with IPsec Encapsulating Security Payload (ESP) (RFC 4309)• Datagram Congestion Control Protocol (DCCP) (RFC 4340)• Stream Control Transmission Protocol (RFC 4960)• MIB Textual Conventions for Uniform Resource Identifiers (URIs) (RFC 5017)• A Recommendation for IPv6 Address Text Representation (RFC 5952)• YANG – A Data Modeling Language for the Network Configuration Protocol (RFC 6020)• Guidelines for Authors and Reviewers of YANG Data Model Documents (RFC 6087)• Network Configuration Protocol (NETCONF) (RFC 6241)• BGP Support for Four-Octet Autonomous System (AS) Number Space (RFC 6793)• Common YANG Data Types (RFC 6991)• A YANG Data Model for Interface Management (RFC 7223)• IANA Interface Type YANG Module (RFC 7224)• A YANG Data Model for IP Management (RFC 7227)• Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing (RFC 7230)• HTTP/1.1 Semantics and Content (RFC 7231)• YANG System Management (RFC 7317)• TCP Extensions for High Performance (RFC 7323)• YANG Module Library (RFC 7895)• The YANG 1.1 Data Modeling Language (RFC 7950)• RESTCONF Protocol (RFC 8040)• YANG Patch Media Type (RFC 8072)• The JavaScript Object Notation (JSON) Data Interchange Format (RFC 8259)• The JSON Data Interchange Syntax (ECMA-404)• Uniform Resource Identifier (URI): Generic Syntax (STD 66)• Extensible Markup Language (XML) 1.0 (W3C XML standard)


Broadcom
































https://tools.ietf.org/html/rfc7231#section-4.3.5








http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf

https://tools.ietf.org/html/std66

https://www.w3.org/TR/xml/


Contacting Technical Support for Your Brocade® ProductFor product support information and the latest information on contacting the Technical Assistance Center, go to https://www.broadcom.com/support/fibre-channel-networking/. If you have purchased Brocade

® product support directly from

Broadcom, use one of the following methods to contact the Technical Assistance Center 24x7.

Online Telephone

For nonurgent issues, the preferred method is to log on tomyBroadcom at https://www.broadcom.com/mybroadcom. (Youmust initially register to gain access to the Customer SupportPortal.) Once there, select Customer Support Portal > SupportPortal. You will now be able to navigate to the following sites:• Knowledge Search: Clicking the top-right magnifying glass

brings up a search bar.• Case Management: The legacy MyBrocade case

management tool (MyCases) has been replaced with the FibreChannel Networking case management tool.

• DocSafe: You can download software and documentation.• Other Resources: Licensing Portal (top), SAN Health (top and

bottom), Communities (top), Education (top).

Required for Severity 1 (critical) issues:Please call Fibre Channel Networking Global Support at one ofthe numbers listed at https://www.broadcom.com/support/fibre-channel-networking/.

If you purchased Brocade product support from a Broadcom OEM/solution provider, contact your OEM/solution providerfor all your product support needs.

• OEM/solution providers are trained and certified by Broadcom to support Brocade products.• Broadcom provides backline support for issues that cannot be resolved by the OEM/solution provider.• Brocade Supplemental Support augments your existing OEM support contract, providing direct access to Brocade

expertise. For more information on this option, contact Broadcom or your OEM.• For questions regarding service levels and response times, contact your OEM/solution provider.

Document FeedbackQuality is our first concern. We have made every effort to ensure the accuracy and completeness of this document.However, if you find an error or an omission or if you think that a topic needs further development, we want to hear fromyou. Send your feedback to [email protected]. Provide the publication title, publication number, topicheading, page number, and as much detail as possible.


Broadcom

https://www.broadcom.com/support/fibre-channel-networking/


https://www.broadcom.com/mybroadcom



mailto:[email protected]


Fabric OS REST API OverviewFabric OS 8.2.0 and later support an application programming interface (API) for managing Brocade storage area network(SAN) switches. The FOS REST API is not supported for releases of Fabric OS prior to 8.2.0.

This API is referred to as the FOS REST API and is enabled by default in Fabric OS 8.2.0 and later. It follows theRESTCONF protocol defined in IETF RFC 8040 and defines data using the YANG 1.1 (Yet Another Next Generation) datamodeling language as defined in IETF RFC 7950.

NOTEBecause the FOS REST API permits HTTP communications, it is not fully compliant with RFC 8040.

FOS REST API DescribedThe FOS REST API is a programmable web service interface for Brocade Fabric OS that can manage Brocade SANswitches across a fabric. This API uses standard HTTP methods to perform Create, Read, Update, and Delete (CRUD)operations on the fabric configuration data, and provides an interface for provisioning, status, and validation operationsusing the YANG data model described in the YANG 1.1 RFC, but not the datastore managed with NETCONF. An Apacheweb server that is embedded in Fabric OS is used to serve the API.

Figure 1: FOS REST API Architecture

FOS REST API Session-Less Operation Described

FOS REST API session-less operation allows you to provide authentication credentials directly for each GET request.Essentially, FOS REST API session-less operation completes the login, GET operation, and logout as one completerequest. You can only use basic authentication formats for REST API session-less operation, which includes plain text orBase64.

NOTEFabric OS 8.2.2 or later supports REST API session-less operation for GET requests only.

FOS REST API session-less operation requests do not count toward the maximum permitted number of REST APIsessions. However, a Fabric OS switch must have at least one FOS REST API session available to execute session-lessrequests. The default limit for FOS REST API sessions is three sessions. A session-less REST API request opens animplicit active session that is closed at the end of the request. For command throttling, a session-less request counts asone REST operation.

FOS REST API session-less operation has the same hardware support and functionality requirements (unless otherwisenoted) as FOS REST API.

The following shows example GET request structures using either plain text or Base64 authentication:

• Plain Text Authentication Structure


Broadcom




curl –v –X GET -u <user_name>:<password> -H "<media_type>" "<base_URI>/<FOS_REST_API_request>"

• Base64 Authentication Structurecurl –v –X GET -H "Authorization:Basic <Base64_authentication>" -H "<media_type>"

"<base_URI>/<FOS_REST_API_request>"

Once the Fabric OS switch receives the request, it sends the request to the authentication module to validate thecredentials. If authentication is successful, it starts additional precondition validations (such as REST interface enabledstate or REST API session count). After precondition validation is complete, the system processes the GET request.

Software Support

The FOS REST API allows a user, application, or script to control certain aspects of a Brocade Gen 5 or Gen 6 StorageArea Network (SAN) device running Fabric OS 8.2.0 and later. Fabric OS 8.2.0 and later includes a set of CLI commandsthat control the API functionality, including REST session management and command throttling.

Hardware Support

The FOS REST API supports all Brocade Gen 5 and Gen 6 Fibre Channel devices that are supported by Fabric OS 8.2.0and later. For a complete list of these platforms, refer to Supported Hardware and Software. The FOS REST API is notsupported on the Brocade Analytics Monitoring Platform or the Brocade FX8-24 blade. The Brocade Extension platformshave some additional restrictions; these are noted in FOS REST API and Brocade Extension.

FunctionalityThe FOS REST API supports the following set of REST operations used for switch interaction: GET, POST, PATCH,DELETE, HEAD, and OPTIONS. REST sessions can be established through all supported management IP addresses.Attempting to use an unsupported method will return the HTTP status code 405, “Method Not Allowed”. No RASLog entryis made for this error.

The modules in Fabric OS 8.2.0 include support for fabric and switch discovery, zoning operations, port configuration,performing port diagnostics (D_Port operations), extension configuration and retrieving interface statistics.Fabric OS 8.2.0a added support for access gateway, FDMI, Name Server, and logical switch. Fabric OS 8.2.1 addedsupport for chassis, Fibre Channel configuration, FRUs, logging, media, operations (supportSave and show-status)trunking, time, security, and MAPS.

The modules in Fabric OS 9.0.x added support for Fabric Traffic Controller, Fibre Channel routing, FICON, SupportLink,Extension, and port channel, as well as additional Operations support (device management, extension, fabric, license,LLDP, PCIE health, SupportLink, and zoning).

The FOS REST API can also do the following:

• Restart Fabric OS Extension Internet Key Exchange (IKE) sessions.• Reset interface statistics.• Perform parallel REST virtual fabric operations across multiple REST sessions with multiple virtual fabrics.• Operate in conjunction with Brocade SANnav™ Management Portal and Web Tools activity.

NOTEThe REST API for Brocade SANnav Management Portal is not the same as the FOS REST API, although theremay be some overlaps. For REST operations using Brocade SANnav Management Portal, refer to the Brocade®

SANnav™ Management Portal REST API and Northbound Streaming Reference Manual.


Broadcom


FOS REST API URI RestrictionsThe following restrictions apply to FOS REST API URI requests.

• A FOS REST API request URI cannot be longer than 255 characters.• A FOS REST API request URI cannot have more than 20 resource segments. A resource segment is the content

between two slashes, and the count starts after the switch address.Examples: The request POST http://10.10.10.10/rest/running/brocade-extension-ip-route/extension-ip-route has 4 segments. The request GET http://10.10.10.10/rest/running/brocade-zone/zoning/defined-configuration has 5 segments.

The FOS REST API will reject requests and return a descriptive error for any of the following:

• Any REST operations that use unsupported HTTP methods (COPY, LINK, UNLINK, PUT, PURGE, LOCK, UNLOCK,PROPFIND, VIEW).

• Any URIs that do not meet length or part count requirements.• Any URIs that do not contain all required keys at the same container level. However, the FOS REST API will accept

URIs having multiple keys at the same container level in different orders.

For additional information on URI request structures, see URI Structure.

Security and the FOS REST APIFOS REST API function calls are permitted or denied based on user privilege configurations determined by the role-basedaccess control (RBAC) functionality in Fabric OS. Only accounts with the following RBAC role permissions can log inusing REST: admin, user, switchadmin, operator, zoneadmin, fabricadmin, basicswitchadmin, or securityadmin. There isno support for the following default switch roles: root and maintenance.

The following restrictions and constraints apply to using REST operations with Fabric OS:

• FOS REST API operations have the following restrictions:– REST operations are not permitted after the session timeout period expires. The default REST session timeout

is 2 hours. This is updated if there is any change in the global http session timeout in configurechassis, webtoolsattributes command.

– REST operations cannot be executed on a standby CP.• FOS REST API logins have the following restrictions:

– While the HTTP protocol is supported, Brocade strongly recommends using the HTTPS protocol for greatercommunication security before making REST calls.

– HTTPS logins require a valid switch certificate. The login will fail if the switch certificate is not valid. A valid clientcertificate is not required, but is supported. Refer to the Brocade Fabric OS Administration Guide for instructions oninstalling certificates.

– Neither HTTP and HTTPS logins are subject to time-of-day limits on account access.– A FOS REST API logout operation invalidates the session authorization key. After a REST logout, subsequent

REST commands using the invalidated authorization key are not permitted.– FOS REST API logins are not persistent across switch reboots or HA failovers.

Only FOS REST API configuration activity is recorded as Fabric OS audit logs and RASLogs, these can be viewed usinga GET request on /brocade-logging/audit-log or using the auditdump -show command. Read activity is not audited.

FOS REST API sessions are maintained if an Ethernet management interface cable is disconnected and reconnected.


Broadcom


Zoning OperationsThe FOS REST API supports discovery and configuration of zone aliases, standard zones (both WWN and domain/port),QoS zones, LSAN zones, and peer zones.

You can use FOS REST API operations to perform the following zone operations:

• Zone creation• Zone deletion• Zone alias creation• Zone alias deletion• Zone configuration actions:

– Zone configuration creation– Zone configuration deletion– Zone configuration enablement– Zone configuration disablement– Zone configuration addition– Zone configuration removal– Zone object member addition– Zone object member removal– Zone alias object member addition– Zone alias object member removal

• Zone database clear• Zone database saving• Zone transaction abort• Zone database contents retrieval• Default Zone mode modification to “NoAccess” or “AllAccess”

Zoning Restrictions

The following restrictions apply to zoning actions using the FOS REST API:

• Only zone discovery is supported for boot LUN zones, redirect and multi-service frame redirect (MSFR) zones, andtraffic isolation (TI) zones.

• The maximum zone database transaction size that FOS API REST operations can handle is 4 MB, which is the largestzone database size supported on Director-only fabrics.

• REST operations fail on zone operations using an incorrect zone database checksum.All REST clients are expected to store and provide the MD5 (128-bit) ZoneDB checksum in their zoning commitoperations. If the provided checksum does not match the checksum stored in zoning, the commit operation will not beallowed. The intent of this requirement is to avoid management interfaces operating off of a zoneDB cache to push instale data and thus potentially overwrite zone updates that were made after the zoneDB copy was synced.

Zoning Transaction Timer RestrictionsFOS API REST zoning transactions are assumed to be short-lived. However, there is no way to enforce this and clientscan potentially open a zone transaction and leave it open indefinitely. This would lock out other zoning users from makingchanges on the local switch.

To prevent an indefinite lockout condition, zoning maintains a FOS API REST zone transaction timer that applies onlyto REST transactions. The timer is started the first time a FOS API REST zone transaction is opened and on eachsuccessive zoning operation, the timer is restarted. The timer is tied to the specific REST session ID. A client cannot starta zoning operation in one session, log out, login again under a different session ID and continue the zone transaction from


Broadcom


the prior session. The switch treats the new login session as a different client and the previous dangling zone transactionis cancelled. Pending FOS API REST zoning operations time out after 5 minutes. After 5 minutes a zoning transaction canbe recommenced by the original REST client, provided that neither of the following has happened:

• No other zone user on the local switch has tried to start another zone transaction.• The transaction has not been aborted via a zone merge or remote zone commit operation.

NOTEThe 5-minute timeout restriction applies only to REST zoning transactions, and is not user-configurable.

RESTCONF transactions follow legacy zone transaction rules and are therefore susceptible to being discontinued by thefollowing conditions:

• Zone merges (when the merge results in a zoneDB change)• Zone updates from remote switches• Forceful transaction aborts by CLI users (that is, cfgtransabort transaction-token operations)

Zoning ChecksumsAll FOS API REST clients will be expected to store and provide the MD5 (128-bit) ZoneDB checksum in their zoningcommit operations. If the provided checksum does not match the checksum stored in zoning, the commit operation will notbe allowed. The intent of this requirement is to avoid management interfaces operating off of a zoneDB cache to push instale data and thus potentially overwrite zone updates that were made after the zoneDB copy was synced.

Diagnostic Port Requests

You can use REST requests to perform the following Fabric OS ClearLink Diagnostics (D_Port) requests:

• D_Port test start• D_Port test restart• D_Port test stop

For more information about D_Port configuration and results, see brocade-fibrechannel-diagnostics.

Protocol SupportThe Fabric OS REST API supports both the HTTP and HTTPS protocols. The default HTTP port number is 80, and thedefault HTTPS port number is 443.

NOTEAlthough the HTTP protocol is supported, Brocade strongly recommends using the HTTPS protocol for greatercommunication security. To use HTTPS, a valid security certificate must be installed on the switch and theHTTPS protocol must be enabled on the switch before beginning REST operations. Refer to the Brocade FabricOS Administration Guide for instructions on both these actions.

NOTEBrocade also recommends enabling KeepAlive when using the HTTPS protocol. See Fabric OS REST SessionConfiguration to enable KeepAlive.


Broadcom


FOS REST API Request ThrottlingFabric OS sets limits on how often a FOS REST API session can invoke Fabric OS subsystems via REST requestthrottling; this prevents a FOS REST API session from consuming excessive memory or CPU resources.

FOS REST API uses a feature within the REST sub-module to limit the number of requests processed by the server. ThisREST sub-module distinguishes between the normal and DOS requests and limits the rate based on the pre-defined userconfiguration.

REST uses the following three attributes to configure throttling:

• Idle time (default is 3 seconds)• Sampling time (default is 30 seconds)• Number of FOS REST API requests allowed within the sampling time (default is 120)

NOTEOnce idle time elapses, the REST interface processes 1 request for each idle time.

NOTEYou cannot configure the throttling values below the default values.

The following figure describes the REST throttling state:


Broadcom


Figure 2: FOS REST API Throttling State

For example, using the default values (idle time is 3 seconds, sampling time is 30 seconds, and number of requests is120), the REST starts collecting the timestamp and requests each time they are received from the external applicationsand checks to see if there are 120 requests processed within 30 seconds (“t”). If there are 120 requests processed within30 seconds, the REST introduces a wait time of 3 seconds to execute subsequent requests. For all subsequent requestsreceived within the 3 second idle time, the REST responds with an HTTP “Status: 503” busy error. This allows the RESTto process only one request per 3 seconds for the next 30 second sampling time (“t”+30). Since the REST processed only~10 requests (based on the time spent on the request process) within the current 30 seconds, for the next 30 secondsthe REST can process another 120 requests. This cycle continues in the same manner for subsequent requests. If norequests are received within the sampling time, the REST processes the next set of requests without delay. In caseof DOS attacks, the REST helps to free up the CPU every 30 seconds. If there are legitimate requests (such as zonecreation, add zone, and configure enable operations or statistics polling [every 10 seconds]), they are executed withoutdelay.


Broadcom


Note that throttling is applicable to all REST sessions. There is no session-based throttling as CPU usage is tied upwith the overall REST requests and not per session ID. Note that throttling does not impact the Brocade SANnav™

Management Portal or Web Tools requests and those requests continue to be processed without any throttling.

To configure the FOS REST API throttling attributes, see Fabric OS REST Session Configuration.

Scalability Recommendations for FOS REST API ClientsIn a heavily managed fabric environment, multiple applications may be used to manage a switch at the same time. In suchenvironments, Brocade recommends not to exceed the total number of application instances with the following guidelinesfor Gen5 and Gen6 platforms.

These recommendations are based on the default throttling settings described in Fabric OS REST Session Configuration.

Table 1: Total Number of Concurrent Instances of Management Applications

Management Application Number of Instances Notes

Brocade SANnav ManagementPortal

2

Brocade Network Advisor 2

The total number of concurrent SANnav and Network Advisorsessions should be no greater than 2.

SNMP client 1

Brocade Web Tools 1

FOS REST API clients 3

Best Practices for FOS REST API Clients

The normal response time from a switch is less than 30 seconds for an individual request. If a response to a request is notreceived in 30 seconds, the FOS REST API client should retry the request up to 3 times. If the switch responds with a 503Service Unavailable, the FOS REST API client should use the same retry logic described above.

For FOS REST API clients to have predictable and stable performance on Brocade Gen5 platforms, it is recommendedto add a one second delay between each request. Utilizing this recommendation for Brocade Gen5 platforms in a largescale fabric minimizes the occurrence of FOS REST API requests that may require a retry. This one second delay is notnecessary for Brocade Gen5 platforms in limited scale fabrics.

FOS REST API and Brocade ExtensionThe FOS REST API supports the Brocade Extension product as implemented in Fabric OS 8.2.0.

Brocade Extension product support includes the following:

• Port configuration and statistics monitoring for Gigabit Ethernet ports• IP interface configuration• Route configuration• IPsec configuration• Tunnel configuration• Tunnel statistics monitoring• Circuit configuration• Circuit statistics monitoring


Broadcom


Extension-specific Limitations

• FOS REST API support for Fabric OS Extension products is limited to Brocade 7840 and 7810 Extension switches andBrocade SX6 Extension blades.

• The FOS REST API is not supported on Brocade 7800 switches or Brocade FX8-24 blades.

Restrictions on FOS REST API Configuration Attributes and StatisticsNot all configuration attributes and statistics that are part of the Fabric OS CLI may be exposed through the FOS RESTAPI interface. This is either because of limitations in the FOS REST API or because their values may be obvious due tothe way data modeling is done in YANG files.

Examples of this include:

• The ability to set values for attributes (such as setting a Gigabit Ethernet port as a LAN or WAN port) is not exposedthrough the FOS REST API interface.

• In the CLI version of the portshow fciptunnel command output, the “Flags” section identifies the features thatare enabled on the tunnel. In the FOS REST API output, this is not displayed, becaues these attributes are modeledindividually in each YANG file.

Using the Brocade FOS REST APIThe following items should be kept in mind when using the Brocade FOS REST API.

Before You Begin

Before you can use the FOS REST API, you must obtain a user name and password authorized to access Fabric OSthrough the FOS REST API. The FOS REST API allows you to log in using basic authorization (user name and password)or an encrypted authorization token (base64 encoded user-name:auth-token). For more information about encryptedauthorization, see Generating an Encrypted Authorization Token.

NOTEIf your user password is expired, FOS REST API allows you to change your password before you log in to theREST API (see Configuring a User Password).

To use the recommended HTTPS protocol, a valid security certificate must be installed on the switch and theHTTPS protocol must be enabled on the switch before beginning REST operations. Refer to the Brocade Fabric OSAdministration Guide for instructions on both these actions.

Logging In and Out

To log in to a device, you must provide a valid Fabric OS user name and password or encrypted authorizationtoken through an authorization header in a POST https://<device_ID>/rest/login request. The device_ID canbe in the form of either an IPv4 or IPv6 address or a host:port ID. If the authentication is successful, an authorizationkey is returned to the client in the response authorization header. Subsequent FOS REST API operations must includethis authorization key in the request authorization header. The client applications use this token to obtain further accessto the server using the persistent connection. For examples of logging in and out, see Logging On, Retrieving SwitchInformation, and Logging Out and Logging On, Retrieving Chassis Information, and Logging Out Using Session-LessREST API Operation.

Examples

Here are two forms of login statements.

POST https://10.10.10.10/rest/login

POST https://[10:10:10:eb:1a:b7:77:bc]:443/rest/login


Broadcom


URI Headers

For JSON, in addition to the Authorization key, you must include the following keys and values in the headers.

• Accept = application/yang-data+json• Content-Type = application/yang-data+json

Figure 3: URI Headers

URI Request


Request Body

There is no request body; however, you must provide a valid Fabric OS user name and password (such as, administrator /password) through an authorization header.

Request Response

There is no request response. When the operation is successful, the response body contains an empty message bodyand a “200 OK” status in the header.

If authentication is successful, a session authorization key (for example, Authorization →Custom_BasicTk0ZmY2Zjg3NTY2ZDYwYjhmNj5NGQ0NTkzZjM0M2ZlMWM=) is returned to the client in the response headers.Subsequent FOS REST API operations must include this authorization key in the request authorization header. The clientapplications use this token to obtain further access to the server using the persistent connection.

To log out from a device, close the session using a POST https://<device_ID>/rest/logout request. You mustinclude the session authorization key in the request authorization header. The device_ID can be in the form of either anIPv4 or IPv6 address or a host:port ID.

Examples

Here are two forms of logout statements.

POST https://10.10.10.10/rest/logout

POST https://[10:10:10:eb:1a:b7:77:bc]:443/rest/logout

URI Headers

For JSON, you must include the following keys and values in the header.


URI Request


Request Body

There is no request body; however, you must include the session authorization key in the request authorization header.


Broadcom


Request Response

There is no request response. When the operation is successful, the response contains an empty message body and a“204 No Content” status in the header.

Supported User Types

FOS REST API supports the following user types:

• Local command interface (CLI) user• Web Tools user

Password Change Before REST API Login

If your user password is expired, FOS REST API allows you to change your password before you log in to the RESTAPI (see Configuring a User Password in the brocade-security Examples section).

REST Session Count Limit

The default limit for FOS REST API sessions is three sessions, but the maximum number of sessions is configurable from1 to 10. Be aware that increasing the number of FOS REST API sessions or the number of requests within a session maynegatively affect latency in a fabric. Refer to REST session configuration for details on setting the session count limit.

Character Restrictions

The following character restrictions apply when making FOS REST API requests:

• Key values containing the “forward slash” reserved character (/) in the URI must be percent-encoded per RFC 8040and RFC 3986 as “%2f”.

• Key values containing a comma (,), which is used when there is more than one key, must be encoded as “%2c”.• The following lists common characters that are used in XML (per RFC 3470) and must be properly encoded to be used

in strings:– The less than character (<) must be encoded as "<".– The ampersand character (&) must be encoded as "&".– The greater than character (>) must be encoded as ">".– The double quote character (") must be encoded as """.– The apostrophe character (') must be encoded as "'".

• The following lists common characters that are used in JSON (per RFC 7159) and must be properly encoded to beused in strings:– The double quote character (") must be encoded as \".– The single quote character (') must be encoded as \'.– The backslash character (\) must be encoded as \\.

Keyword SupportThe FOS REST API supports standard YANG keywords such as if, when, and mandatory. Refer to the individualmodule .yang files to see where these keywords are supported; they are not identified in this document.

Configuration Upload and Download

Fabric OS REST configurations can be saved and restored using the standard configUpload and configDownloadcommands as well as during a high availability (HA) failover operation. If you downgrade a device to a version of FabricOS earlier than 8.2.0, FOS REST API is not supported and does not function, and any mgmtapp configuration commandsare discarded.


Broadcom






FOS REST API Role-Based Access ControlThe FOS REST API supports user-created roles and permissions. For instructions on managing roles, refer to theBrocade Fabric OS Administration Guide.

To view a list of FOS REST API roles, enter mgmtapp --show rbacinfo .

sw0:admin> mgmtapp --show rbacinfo

-------------------------------------------------------------------------------------------------------------

URL RBAC CONTEXT_TYPE

-------------------------------------------------------------------------------------------------------------

/rest/auth-token None both

/rest/brocade-module-version None both

/rest/login None both

/rest/logout None both

/rest/modules-state None both

/rest/operations/device-management NxPortManagement both

/rest/operations/extension SwitchPortManagement chassis

/rest/operations/fibrechannel-fabric Fabric vf

/rest/operations/fibrechannel-zone Zoning vf

/rest/operations/firmwaredownload FirmwareManagement both

/rest/operations/license License both

/rest/operations/lldp DCE both

/rest/operations/pcie-health-test Blade chassis

/rest/operations/show-status None both

/rest/operations/supportlink SessionManagement both

/rest/operations/supportsave Restricted both

/rest/running/brocade-access-gateway/device-list AG vf

/rest/running/brocade-access-gateway/f-port-list AG vf

(output truncated)

Table 2: RBAC Output

Output Description

URL The request URI, which is the URI used to perform a GET, POST, PATCH, DELETE, HEAD, or OPTIONSoperation.

RBAC The meta-object format (MOF) class. The REST requests are grouped into feature sets called MOF classes.For example, /rest/operations/fibrechannel-zone and and /rest/running/brocade-zone/alias are all relatedunder zoning and are therefore grouped together under a MOF class called Zoning.

CONTEXT_TYPE The Virtual Fabric or chassis context type or both. REST requests can be issued in one or more of thecontexts. Note that issuing of a chassis REST request requires chassis permissions.


Broadcom


HTTP HeaderHTTP header fields are components of the message header of a request and response in HTTP. They define theoperating parameters and are name-value pairs that appear in both request and response messages.

The following table contains the supported HTTP methods for the media types.

Table 3: Supported HTTP Methods and Media Types

Method Supported media types

DELETE application/yang-data+xml (default) and application/yang-data+jsonGET application/yang-data+xml (default) and application/yang-data+jsonHEAD application/yang-data+xml (default) and application/yang-data+jsonOPTIONS All media types for this method.POST application/yang-data+xml (default) and application/yang-data+jsonPATCH application/yang-data+xml (default) and application/yang-data+json

For more information about supported media types, refer to media types.

Request HeadersThe FOS REST API supports only the following request headers. All requests that use a body must have the body in XMLformat.

• Accept• Authorization• Cache-Control• Content-Length• Date• Host• User-Agent

NOTEAll FOS REST API requests that return data return that data in XML or JSON format.

Media TypesIn REST, “Media type” is an application-specific format with a well-defined name represented in the form of an identifierused to identify the form of the data contained within a resource representation.

Media types are specified in the Accept header for requests and in the Content-Type header for responses. Media typesare resource-specific, this allows them to change independently and support formats that other resources do not. TheFOS REST API supports the XML (default) and JSON media types. If you do not specify Accept or Content-Type headers,the media type defaults to XML.

For the JSON media type, you must include the following keys and values in the headers:



Broadcom


HTTP Status Codes and MessagesBoth success and error status conditions are reported to the client by way of the HTTP status line, which contains theHTTP status code. These application-specific messages are similar to CLI responses.

The following table lists and describes the HTTP status codes supported by the Fabric OS REST API.

Table 4: Supported HTTP Status Codes

Status Line Value Description

100 Continue POST is accepted, 201 should follow

200 OK Success with response body

201 Created Request successfully created a resource

202 Accepted Request to create a resource accepted

204 No Content Success without a response body

400 Bad Request Invalid request message

403 Forbidden Access to resource denied

404 Not Found Resource target or resource node not found

405 Method Not Allowed Method not allowed for target resource

413 Request Entity TooLarge

The request entity is too large

414 Request URI Too Large The request URI is too large

415 Unsupported Media Not a supported media type

500 Internal Server Error Operation failed. In this case, the response body will contain the application’s specific error message

501 Not Implemented Unknown operation

502 Server Busy Server busy error

503 Service Unavailable Recoverable server error

Supported MethodsThe FOS REST API supports the DELETE, GET, HEAD, OPTIONS, PATCH, and POST methods.

DELETE MethodThe DELETE method is used to delete a specified resource.

The latest update to the HTTP 1.1 specification (RFC 7231) explicitly permits an entity body in a DELETE request: Apayload within a DELETE request message has no defined semantics; sending a payload body on a DELETE requestmight cause some existing implementations to reject the request.

The following example shows a DELETE operation to remove an existing IP interface.

Request URI

DELETE https://10.10.10.10/rest/running/brocade-interface/extension-ip-interface

Request Body

<extension-ip-interface>


Broadcom

https://tools.ietf.org/html/rfc7231#section-4.3.5


<name>4/5</name>

<dp-id>0</dp-id>

<ip-address>10.10.10.05</ip-address>

<ip-prefix-length>24</ip-prefix-length>

</extension-ip-interface>

Request Response

When the operation is successful, the response contains an empty message body and a “204 No Content” status in theheader.

Notes

• An authorization header is required to perform a DELETE operation.• A request payload is required when any zone members are deleted.

GET MethodThe GET method is used to retrieve the representation of the resource (for example, base configuration) including themetadata information.

NOTEThe GET operation only depends on key leafs in the request body and the key leaf values as per the yang. Ifany non-key leafs are included in the request body along with key leafs, the non-key leafs are ignored and novalidation is performed for the non-key leaf values. The GET response body always contains the actual valuesfrom the switch at any time irrespective of what is sent in the request body for non-key leafs.

The following example shows a GET operation to display information about the switch you are logged in to.

Request URI

GET https://10.10.10.10/rest/running/brocade-fibrechannel-switch/fibrechannel-switch/

Request Body

No request body is required.

NOTEA request payload is not required for a GET operation.

Response Body

When the operation is successful, the response has a message body similar to the following, and a “200 OK” statusappears in the headers.

<?xml version="1.0"?>

<Response>

<fibrechannel-switch>

<name>10:00:a1:b1:1c:1d:ac:1c</name>

<domain-id>43</domain-id>

<fcid>16776235</fcid>

<fcid-hex>0xfffc2b</fcid-hex>

<user-friendly-name>66-243_X6-4_Venator</user-friendly-name>

<enabled-state>2</enabled-state>

<is-enabled-state>true</is-enabled-state>

<operational-status>2</operational-status>

<banner/>

<up-time>73389</up-time>


Broadcom


<domain-name>brm.bsnlab.broadcom.net</domain-name>

<dns-servers>

<dns-server>190.19.190.10</dns-server>


</dns-servers>

<principal>0</principal>

<ip-address>


</ip-address>

<subnet-mask>255.255.10.20</subnet-mask>

<model>165.0</model>

<firmware-version>v9.0.0</firmware-version>

<ip-static-gateway-list>

<ip-static-gateway>10.20.30.1</ip-static-gateway>

</ip-static-gateway-list>

<vf-id>-1</vf-id>

<fabric-user-friendly-name>East</fabric-user-friendly-name>

<ag-mode>0</ag-mode>

<dynamic-load-sharing>lossless-dls</dynamic-load-sharing>

<in-order-delivery-enabled>false</in-order-delivery-enabled>

<advanced-performance-tuning-policy>exchange-based</advanced-performance-tuning-policy>

<lacp-system-mac-address>c4:f5:7c:59:ac:6e</lacp-system-mac-address>

<lacp-system-priority>32768</lacp-system-priority>

</fibrechannel-switch>

</Response>

HEAD MethodThe HEAD method retrieves the specified resource’s metadata.

Request URI

HEAD https://10.10.10.10/rest/running/brocade-fibrechannel-switch/fibrechannel-switch/

Request Body


Request Response

On successful retrieval of the metadata, the response contains an empty message body and a “200 OK” status in theheaders.

NOTEA request payload is not required for a HEAD operation.

OPTIONS MethodThe OPTIONS method is used to retrieve the allowed methods on the resource identified by the given request. Theresponse to this operation contains the headers and an empty response body. The “Allow” header in the responsecontains the allowed operations on the resource.

For an OPTIONS request, the leaf elements within a second-level container return all the supported methods for thewhole container. For example, in the brocade-fibrechannel-diagnostics module, “fec” is a container that has three leafs:“enable”, “options” and “active”. Only the “enable” leaf is read-write; the other two leafs are read-only. Nonetheless, when


Broadcom


an OPTIONS request is made that includes the “active” or “options” leafs, the request response body will list read-writemethods (such as PATCH), even though read-write methods are not valid for those leafs.

Request URI

OPTIONS https://10.10.10.10/rest/running/brocade-zone/defined-configuration

Request Body


Request Response

The response contains an empty message body and a “Allow:” line in the header. This lists the supported operations forthe specified module.

HTTP/1.1 200 OK

Allow: DELETE, GET, HEAD, POST, PATCH <= Allowed operations

Cache-Control: no-cache

Connection: close

Content-Secure-Policy: default-src 'self'

Content-Type: application/yang-data+xml

Date: Wed, 18 Oct 2017 20:53:32 GMT

Server: Apache

Transfer-Encoding: chunked

X-Content-Type-Options: nosniff

X-Frame-Options: DENY

X-XSS-Protection: 1; mode=block

Notes

• A request payload is not required for an OPTIONS operation.• The OPTIONS method is supported at the container and list levels but is not supported at the leaf level.

PATCH MethodThe PATCH method is used to edit or update the leaf attributes of the resource (List or Container), if the system supportsthe modification. For example, modifying the leaf or list child resource of an access control list (ACL) “sequence”command is not possible, as it is not allowed by the system.

NOTENot all Fabric OS REST API modules guarantee atomicity of PATCH operations. If a PATCH operation returnsan error status code, it is recommended that the application issue a GET request for the same node(s) in orderto retrieve and compare the state of the node(s) after the failed PATCH operation.

The FOS REST API uses the PATCH method (RFC 8072) which has features not possible with the “plain-patch”mechanism defined in RESTCONF (RFC 8040).

• It allows multiple sub-resources to be edited within the same PATCH method.• It allows a more precise editing operation than the “plain-patch” mechanism.• It uses an “edit” list with an explicit processing order. These edits are processed in the client-specified order, and error

processing can be precise even when multiple errors occur in the same PATCH request.• A request payload is required for a PATCH method request, except when the configuration value can be supplied in the

URI, as shown in the “request in body” example below.• Because a PATCH operation overwrites the entire object, all desired content must be included in the request, including

any content that was already in the leaf, list, or container. If you do not include all content, the operation fails with an"400 Bad Request" response.


Broadcom




The following example shows two methods to make a PATCH request to update the switch user-friendly-name to“My_switch”.

Request URI (for a request in the URI)PATCH https://10.10.10.10/rest/running/brocade-fibrechannel-switch/fibrechannel-switch/

name/10:10:14:f5:7c:46:3d:40/user-friendly-name/My_switch

Request URI (for a request in the body)PATCH https://10.10.10.10/rest/running/brocade-fibrechannel-switch/fibrechannel-switch/

name/10:10:14:f5:7c:46:3d:40/

Request Body (for a request in the body)<fibrechannel-switch>

<user-friendly-name>My_switch</user-friendly-name>


Request Response


POST MethodThe POST method allows you to create a new resource in the resource location identified by the URI specified in therequest.

The following example shows a POST method request to create a new zone.

Request Header

POST https://10.10.10.10/rest/running/brocade-zone/defined-configuration

Request Body

<defined-configuration>

<zone>

<zone-name>newZone1</zone-name>

<zone-type>0</zone-type>

<member-entry>

<entry-name>10:10:20:21:f8:f0:3a:10</entry-name>

<entry-name>10:10:20:21:f8:f0:38:01</entry-name>

</member-entry>

</zone>

</defined-configuration>

Request Response

When the operation is successful, the response contains an empty message body and a “201 Created” status in theheader.

NOTEA request payload is required for a POST request, except in those cases where the configuration value issupplied in the URI.


Broadcom


Using Brocade FOS REST API Session-Less OperationThe following items should be kept in mind when using FOS REST API session-less operation.

Before You Begin

Before you can use FOS REST API session-less operation, you must obtain a user name and password authorized toaccess Fabric OS through FOS REST API session-less operation. To use the recommended HTTPS protocol, a validHTTPS security certificate must be installed on the switch and the HTTPS protocol must be enabled on the switch beforebeginning REST HTTPS operations. Refer to the Brocade Fabric OS Administration Guide for instructions on both theseactions. FOS REST API session-less operation follows the same role-based access control restrictions and constraints asFOS REST API (see Security and the FOS REST API).

NOTEFabric OS 8.2.2 or later supports FOS REST API session-less operation for GET requests only.

NOTEYou must have at least one REST API session available to execute session-less requests.

Logging In and Out Using FOS REST API Session-Less Operation

FOS REST API session-less operation requests completes the login, GET operation, and logout as one complete request.You can only use basic authentication formats for FOS REST API session-less operation, which includes plain text orBase64. The following shows example GET request structures using either plain text or Base64 authentication:

• Plain Text Authentication Structurecurl –v –X GET -u <user_name>:<password> -H "<media_type>" "<base_URI>/<FOS_REST_API_request>"

• Base64 Authentication Structurecurl –v –X GET -H "Authorization:Basic <Base64_authentication>" -H "<media_type>"

"<base_URI>/<FOS_REST_API_request>"

FOS REST API session-less operation logout occurs automatically when the request is complete.

Plain Text Authentication Example

This example uses a GET request with plain text authentication to retrieve information about the chassis in JSON format.

Structure

curl –v –X GET -u <user_name>:<password> -H "<media_type>" "<base_URI>/rest/running/brocade-chassis/chassis"

Request

curl -v -X GET -u admin:password1 -H "Accept: application/yang-data+json" "https://10.11.12.13/rest/running/

brocade-chassis/chassis"

Response Body

{

"Response": {

"chassis": {

"chassis-user-friendly-name": "sanchassis1",

"license-id": "10:00:c1:f2:3c:00:af:40",

"chassis-wwn": "10:00:c1:f2:3c:00:af:4f",

"serial-number": "FER0304N00Z",

"manufacturer": "Brocade Communications Systems LLC",


Broadcom


"part-number": "40-1001199-03",

"vf-enabled": true,

"vf-supported": true,

"fcr-enabled": true,

"fcr-supported": true,

"max-blades-supported": 1,

"vendor-revision-number": "",

"vendor-part-number": "",

"vendor-serial-number": "",

"product-name": "g630",

"date": "12/24/2020-10:34:37"

}

}

Base64 Authentication Example

This example uses a GET request with Base64 authentication to retrieve information about the chassis in JSON format.

Structure

curl –v –X GET -H "Authorization:Basic <Base64_authentication>" -H "<media_type>" "<base_URI>/rest/running/


Request

curl -v -X GET -H "Authorization:Basic YWRtaW46cGFzc3dvcmQx" -H "Accept: application/yang-data+json"

"https://10.11.12.13/rest/running/brocade-chassis/chassis"

Response

{

"Response": {

"chassis": {


"license-id": "10:00:c1:f2:3c:00:af:40",




"part-number": "40-1001199-03",

"vf-enabled": true,









"date": "12/24/2020-10:44:34"

}

}


Broadcom


FOS REST API Version HistoryThe FOS REST API supports resource-API and module-level versioning using the brocade-module-version module.

You can use the resource API version history to determine backward compatibility.

• Major number – A backward incompatible API change is made (such as, removing a deprecated top-level container).• Minor number – A backward compatible API change is made (such as, adding a top-level container name or leaf).• Patch – A backward compatible API change is made (such as, new pattern inclusion for a leaf).

Resource API Version

The resource API version displays top-level URI changes for major, minor, and patch releases. The resource API versiondisplays the current API release in the ‘Content-Type’ response header. For example, Content-Type →application/yang-data+xml;version=1.30.0.

For example, the resource API version for Fabric OS 8.2.1b is 1.30.0 (major.minor.patch). The resource API version forFabric OS 9.0.0a is 1.40.0. The resource API version for Fabric OS 9.0.1 is 1.40.0.

Module Level Version

The module level version displays the revision numbering for the individual modules. Module level versioning is updatedfor changes to leafs or objects within an individual module.

The following table details the module level version for each REST API module in Fabric OS 9.0.x.

Table 5: Module Level Version

Module Name Module Version

Auth-token 1.0.0

brocade-access-gateway 1.20.0

brocade-chassis 1.10.10

brocade-extension 1.0.10

brocade-extension-ip-route 1.10.0

brocade-extension-ipsec-policy 1.0.10

brocade-extension-tunnel 1.40.0

brocade-fabric 2.10.0

brocade-fabric-traffic-controller 1.0.0

brocade-fdmi 1.10.0

brocade-fibrechannel-configuration 1.10.0

brocade-fibrechannel-diagnostics 2.10.20

brocade-fibrechannel-logical-switch 2.0.10

brocade-fibrechannel-routing 1.0.0

brocade-fibrechannel-switch 3.10.0

brocade-fibrechannel-trunk 1.10.10

brocade-ficon 1.0.0

brocade-fru 1.20.10


Broadcom


brocade-interface 3.10.0

brocade-license 1.20.10

brocade-lldp 1.0.0

brocade-logging 1.20.0

brocade-maps 1.20.0

brocade-media 1.20.0

brocade-module-version 1.0.0

brocade-name-server 2.0.0

brocade-operation-device-management 1.0.0

brocade-operation-extension 1.0.0

brocade-operation-fabric 1.0.0

brocade-operation-firmwaredownload 1.0.0

brocade-operation-license 1.10.10

brocade-operation-lldp 1.0.0

brocade-operation-pcie-health 1.0.0

brocade-operation-show-status 1.10.0

brocade-operation-supportlink 1.0.0

brocade-operation-supportsave 1.10.0

brocade-operation-zone 1.0.0

brocade-security 2.10.0

brocade-snmp 1.10.10

brocade-supportlink 1.10.0

brocade-time 1.10.0

brocade-zone 2.10.10

login 1.10.0

logout 1.0.0

Requesting the Module Level Versions

The following example uses a GET request to retrieve the module level version information.

Structure

https://<device_ID>/rest/brocade-module-version

Request URI

GET https://10.10.10.10/rest/brocade-module-version

Request Body


Response Body



Broadcom



<Response>

<brocade-module-version>

<module>

<name>login</name>

<version>1.0.0</version>

<uri>/rest/login</uri>

<objects/>

</module>

<module>

<name>logout</name>


<uri>/rest/logout</uri>

<objects/>

</module>

.

.

.

<module>

<name>brocade-snmp</name>


<uri>/rest/running/brocade-snmp</uri>

<objects>

<object>system</object>

<object>mib-capability</object>

<object>trap-capability</object>

<object>v1-account</object>

<object>v1-trap</object>

<object>v3-account</object>

<object>v3-trap</object>

<object>access-control</object>

</objects>

</module>

<module>

<name>brocade-operation-supportsave</name>


<uri>/rest/operations/supportsave</uri>

<objects>

<object>connection</object>

</objects>

</module>

</brocade-module-version>

</Response>


Broadcom


Deprecated and Obsolete ResourcesThe following sections detail the deprecated and obsolete resources for the FOS REST API.

Deprecated Resources

• Fabric OS 8.2.0a– fcid (brocade-fabric, brocade-interface, brocade-fibrechannel-switch) – Use the fcid-hex leaf.

• Fabric OS 8.2.1b– brocade-extension-tunnel/admin-enabled – Use the is-admin-enabled leaf to enable or disable and admin-

status to obtain the current status.– enabled-state

• brocade-fibrechannel-switch – Use the is-enabled-state leaf to configure and the operational-statusleaf to obtain the current state of the switch.

• brocade-interface/fibrechannel – Use the is-enabled-state leaf.

• Fabric OS 9.0.0– brocade-chassis

• part-number – Use the brocade-fru/list wwn/part-number leaf.• vendor-serial-number – Use the brocade-fru/list wwn/vendor-serial-number leaf.• vendor-part-number – Use the brocade-fru/list wwn/vendor-part-number leaf.• vendor-revision-number – Use the brocade-fru/list wwn/vendor-revision-number leaf.

– brocade-fabric/path-count – Use the brocade-fibrechannel-switch/topology-domain path-count leaf.– brocade-fibrechannel-switch

• errors-detected-local – Use the failure-report-local-details leaf-list.• errors-detected-remote – Use the failure-report-remote-details leaf-list.

– brocade-interface• port-type – Use the port-type-string leaf• pod-license-status – Use the pod-license-state leaf.

– brocade-maps/quiet-time-clear – Use the quiet-time leaf.– brocade-snmp

• access-control – Use the brocade-security/ipfilter-policy list.• security-get-level – Use the security-get-level-string leaf.• security-set-level – Use the security-set-level-string leaf.

– brocade-zone/zone-type – Use the zone-type-string leaf.

• Fabric OS 9.0.1– brocade-maps/port-loss – Use the loss-of-sync leaf.

Obsolete Resources

• Fabric OS 9.0.0– brocade-interface/fibrechannel

• g-port-locked• non-dfe-enabled• rate-limit-enabled

– brocade-name-server/share-area– brocade-security

• /sshutil-key/passphrase• /ipfilter-rule/traffic-type


Broadcom


FOS REST API and Brocade Virtual FabricsFOS REST API operations can occur across virtual fabrics.

When you log on to a switch as described in Logging In and Out, by default the session is logged on to the logical switchthat belongs to the “Home” virtual fabric of the REST user. If you want to execute a FOS REST API request on otherlogical switches, you must include the virtual fabric ID (vf_id) as part of the request query parameter.

This example uses a GET request to retrieve the switch information for a switch in the virtual fabric with anVFID of 10. Structure GET <base_URI>/running/brocade-fabric/fabric-switch?vf-id=<vf-id#> Request URIGET https://10.10.10.10/rest/running/brocade-fabric/fabric-switch?vf-id=10

Request Body No request body is required. Response Body When the operation is successful, the responsehas a message body similar to the following, and a “200 OK” status appears in the headers.


<Response>


<name>10:10:10:40:1a:b7:47:bc</name>

<chassis-wwn>10:10:10:40:7c:4a:ac:eb</chassis-wwn>


<fcid>16776283</fcid>


<switch-user-friendly-name>DCX_066_240</switch-user-friendly-name>

<chassis-user-friendly-name>BrocadeDCX</chassis-user-friendly-name>

<firmware-version>v8.2.1_bld40</firmware-version>

<vf-id>10</vf-id> <== Virtual fabric ID


<fcip-address>0.0.0.0</fcip-address>

<ipv6-address>2620:100:4:fa01:227:f8ff:fe0f:b9f0</ipv6-address>



</Response>

Fabric OS REST Session ConfigurationThe apploginhistory and mgmtapp Fabric OS CLI commands allow you to manage REST session-related operations.

The mgmtapp command allows you to perform REST session-related operations, including enabling, disabling, andterminating the REST session, as well as configuring the maximum number of REST sessions for an entire switch orchassis, configuring keep alive for the REST session, and setting throttling values. On chassis-based systems, thiscommand is only supported on the active CP.

Entering mgmtapp --show displays the number of active REST sessions and the REST throttling configuration values(sample request counts, sample time (in seconds), idle time (in seconds), whether keep alive is enabled, and keep alivetimeout (in seconds)). The following example shows the output of the command when all values are at their defaults.

switch:admin> mgmtapp --show

REST Interface State: Enabled

REST Session Count: 3

REST Throttling Configurations:

Sample Requests : 30

Sample Time (in sec) : 30

Idle Time (in sec) : 3

KeepAlive : Enabled


Broadcom


KeepAliveTimout : 15sec

NOTEREST operations are not permitted if the REST interface is disabled in CLI, and are denied after changes to auser account with an existing REST session.

Enabling and Disabling the Fabric OS REST InterfaceThe Fabric OS REST interface is enabled by default.

To disable the Fabric OS REST interface, enter mgmtapp --disable REST.

To re-enable the Fabric OS REST interface, enter mgmtapp --enable REST.

Encrypted Authorization TokenUse the Fabric OS CLI to generate an encrypted authorization token that can then be used to log on to the REST APIinterface. This authorization token is a 256-bit key encrypted with the AES-256 encryption algorithm and is storedpersistently in the configuration. Once you base64-encode the authorization token along with your user name (user-name:auth-token), the FOS REST API uses this authorization token for subsequent logons in a base64 format of <user-name:auth-token>.

To log in to the REST API interface using an encrypted authorization token, you must use a custom authorizationtype (Custom_Auth ). The HTTP authorization token format is Custom_Auth <base64-encoded-authorizationtoken> . The custom authorization type replaces the standard basic authorization used to log in to theREST API interface.

The FOS REST API authorization key is supported for local user accounts only. Note that the following changes to theuser account remove the encrypted authorization key from the configuration:

• User account deleted• User account changed (such as, role)• User password changed• User password expired• User account disabled• User permission revoked• Factory reset• User Virtual Fabric modified

Generating an Encrypted Authorization TokenYou must use the Fabric OS CLI to generate an encrypted authorization token.

1. To create an encrypted authorization token, enter mgmtapp --create authtoken .

2. To display the encrypted authorization token for the current user, enter mgmtapp --show authtoken .

SU5lZWRTb21lYm9keShIZWxwISlOb3RKdXN0QW55Ym9keShIZWxwISlZb3VLbm93SU5lZWRTb21lb25laGVscCFJTm

V2ZXJOZWVkZWRBbnlib2R5J3NIZWxwSW5BbnlXYXlidXROb3dUaGVzZURheXNBcmVHb25lLEknbU5vdFNvU2VsZk

Fzc3VyZWRCdXROb3dUaGVzZURheXNBcmVHb25lKUFuZE5vd0lGaW5kKU5vd0lGaW5kSSd2ZUNoYW5nZWRNeU1

pbmRBbmRPcGVuZWRVcFRoZURvb3JzaGVscE1lSWZZb3VDYW4sSSdtRmVlbGluZ0Rvd24oSGVscCEp==

3. Base64-encode your user name and the encrypted authorization token using the following format: <user-name:auth-token> .For example, the following user name and the encrypted authorization token (<user-name:auth-token> ):


Broadcom


gumbeaux504:SU5lZWRTb21lYm9keShIZWxwISlOb3RKdXN0QW55Ym9keShIZWxwISlZb3VLbm93SU5lZWRTb21lb

25laGVscCFJTmV2ZXJOZWVkZWRBbnlib2R5J3NIZWxwSW5BbnlXYXlidXROb3dUaGVzZURheXNBcmVHb25lLEknbU

5vdFNvU2VsZkFzc3VyZWRCdXROb3dUaGVzZURheXNBcmVHb25lKUFuZE5vd0lGaW5kKU5vd0lGaW5kSSd2ZUNoY

W5nZWRNeU1pbmRBbmRPcGVuZWRVcFRoZURvb3JzaGVscE1lSWZZb3VDYW4sSSdtRmVlbGluZ0Rvd24oSGVscCEp==

becomes the following base64-encoded authorization token:

Z3VtYmVhdXg1MDQ6SU5lZWRTb21lYm9keShIZWxwISlOb3RKdXN0QW55Ym9keShIZWxwISlZb3VLbm93SU5lZWR

Tb21lb25laGVscCFJTmV2ZXJOZWVkZWRBbnlib2R5J3NIZWxwSW5BbnlXYXlidXROb3dUaGVzZURheXNBcmVHb25l

LEknbU5vdFNvU2VsZkFzc3VyZWQoQnV0Tm93VGhlc2VEYXlzQXJlR29uZSlBbmROb3dJRmluZClOb3dJRmluZEkndm

VDaGFuZ2VkTXlNaW5kQW5kT3BlbmVkVXBUaGVEb29yc2hlbHBNZUlmWW91Q2FuLEknbUZlZWxpbmdEb3duKEh

lbHAhKQ==

4. Use the base64-encoded authorization token during the REST login process.To log on to the REST API interface using an encrypted authorization token, you must use a custom authorization type(Custom_Auth ). The HTTP authorization token format is Custom_Auth <base64-encoded-authorization-token> . The custom authorization type replaces the standard basic authorization used to log in to the REST APIinterface.

Enabling and Disabling Protocol SupportNOTEAlthough the HTTP protocol is supported, Fabric OS strongly recommends using the HTTPS protocol for greatercommunication security.

Enabling and Disabling the HTTPS Protocol

The following example shows the output of the command when all values are at their defaults for HTTPS only protocolsupport.


REST Configuration:

Interface State: Enabled

Effectivie Protocol: HTTPS only

HTTP State: Disabled

Session Count: 3

Throttling Configurations:




HTTPS Configuration:

KeepAlive : Enabled


To enable the HTTPS Protocol, enter mgmtapp --enable rest --protocol https.

To disable the HTTPS Protocol, enter mgmtapp --disable rest --protocol https.

The following example shows the output of the command when REST is disabled.

66-61_G610_Chewbacca:root> mgmtapp --show

REST Configuration:


Broadcom


Interface State: Disabled

Effective Protocol: None

HTTP State: Disabled

Session Count: 10






KeepAlive : Enabled

KeepAliveTimeout : 15sec

Enabling and Disabling the HTTP Protocol

NOTEUpgrading a switch from a pre-Fabric OS 9.0.0 version to Fabric OS 9.0.0 or later enables the HTTP RESTinterface by default.

The following example shows the output of the command when all values are at their defaults after an upgrade.


REST Configuration:

Interface State: Enabled

Effectivie Protocol: HTTP only

HTTP State: Enabled

Session Count: 3






KeepAlive : Enabled


To disable the HTTP Protocol, enter mgmtapp --disable rest --protocol http.

To enable the HTTP Protocol, enter mgmtapp --enable rest --protocol http.

Enabling and Disabling Keep Alive ModeThe keep alive mode is disabled by default. For HTTPS mode, it is recommended that you enable keep alive mode.

NOTEKeep alive mode is only supported with HTTPS mode.

To disable the keep alive mode, enter mgmtapp --disable keepalive.

To reenable the Fabric OS REST interface, enter mgmtapp --enable keepalive.

HTTP mode will be disabled after enabling KeepAlive. Do you want to continue? (y or n) y


Broadcom


Fabric OS REST Interface Session Value ConfigurationWhen the Fabric OS REST interface is enabled, it uses the -maxrestsession count to determine how many concurrentREST sessions are permitted to an entire switch or chassis. There can be from 1 to 10 REST sessions configured, thedefault is 3. An error message is returned if you attempt to establish more REST sessions than the permitted number.

In addition to the number of concurrent REST sessions permitted, you can configure the samplingtime and idle time in seconds and the sample request count. These options are set using the mgmtapp--config configuration_parameters command.

The configuration parameters are: -maxrestsession rest session count,-sampletime, sampling_time_in_seconds, -samplerequest sampling_request_count, and-idletime throttling_time_in_seconds. Not all parameters are required in the command, as the followingexample shows:switch:admin> mgmtapp --config -maxrestsession 4 -sampletime 120 -idletime 60

The minimum sampling time is 30 seconds (this is also the default) and the maximum is 2147483647 seconds(596,523 hours, 14 minutes, 7 seconds). The minimum sampling request count allowed is 30 and the maximum is2147483647. The minimum idle time is 3 seconds (this is also the default) and the maximum is 2147483647 seconds(596,523 hours, 14 minutes, 7 seconds).

Fabric OS REST Session Identification and TerminationTo identify the rest sessions on a platform, enter apploginhistory --show to display the number of sessions from theexternal applications that are currently active. This example shows a typical output. In this example, the lines have beenbroken for clarity and the REST session line has been rendered in bold.

switch:admin> apploginhistory --show

The following are the sessions from the external applications that are active currently:

2017/09/11-16:47:10.151901, 10.10.10.125, admin, Network_Advisor\14.3.0,

77d3af04955bb28172a44ed4c52d483ae9fb7c591b3c3f48c3f0a27dafe205e7, 128

2017/09/11-16:47:10.436586, 10.10.10.1, admin, Network_Advisor\14.3.0,

365916859cc7bca4cffa57bce88bb2259645a6583ded6a8c6ab6ff87e7ef5261, 128

2017/09/11-16:48:20.456304, 10.10.10.79, admin, PostmanRuntime/6.3.2,

a25fb215731ba5af9f5519a0d4fec0e154b2e1fd2bfcec25fc1c5af2f34d6b19, 128

To terminate a REST session, enter mgmtapp --terminate session_id. You must provide the session ID. Thisexample terminates the REST session identified above.switch:admin> mgmtapp --terminate a25fb215731ba5af9f5519a0d4fec0e154b2e1fd2bfcec25fc1c5af2f34d6b19

Rest session terminated successfully.

Refer to the entry for these commands in the Brocade Fabric OS Command Reference Manual for more information andexamples.


Broadcom


YANG Module OverviewThe Fabric OS REST API uses YANG 1.1 (Yet Another Next Generation) as the basis for its data structure.

YANG 1.1 is defined in IETF RFC 7950. It is a data modeling language used to model configuration data, state data,remote procedure calls, and notifications for network management protocols. The Fabric OS REST API YANG files arepart of Fabric OS distribution (/dist/yang.tar.gz).

The following figure shows how individual node fields are typically displayed in a .yang tree file.

Figure 4: YANG Module Node Fields

In the tree view of a YANG module, the indents indicate leafs. An asterisk (*) indicates container for a leaf list, and aquestion mark (?) indicates an optional item. “ro” indicates a read-only item (that is, the node contains operational data),and “rw” indicates read-write. The “+--” element provides a visual marker for following the tree structure. Refer to the tablebelow for YANG node field definitions and possible values, and Supported Data Types for data type descriptions.

YANG node field definitions and possible values are listed in the following table.

Table 6: YANG Node Field Definitions and Values

Field Definition Values

status Status of the node. + Currentx Deprecatedo Obsolete

flags Type of information. rw Read-write—The node contains configuration dataro Read-only—The node contains operational data-x RPC statement-n Notification (not supported)

name The name of the node. (name)—Choice node*(name)—Case nodeprefix:name—Augmented from the specified externalmodule

options The node name can be modified by one of these optionalvalues.

The following optional values can be used:

• ?—Optional leaf or presence container• *—Leaf-list• [keys]—Keys for a list

type The leaf or leaf-list type. If the specified type is other thanone of the basic types, then the type is defined in a typedefstatement in the .yang file.

N/A


Broadcom

https://datatracker.ietf.org/doc/rfc7950/


Supported Data TypesThe following tables describe the YANG built-in data types and the additional data types supported in the FOS REST API.

YANG Built-In Data Types

The following data types are inherent to the YANG architecture. Refer to RFC 6991 or RFC 2578 for additional details.binary Any binary data.

bits A set of bits or flags.boolean Either the value “true” or the value “false”.

counter32 A non-negative integer that monotonically increases until it reaches a maximum value of 2^32-1(4294967296 in decimal), at which point it wraps around and starts increasing again from zero. It has nopreset initial value.

counter64 A non-negative integer that monotonically increases until it reaches a maximum value of 2^64-1(18446744073709551615 in decimal), at which point it wraps around and starts increasing again from zero.It has no preset initial value.

empty A leaf that does not have any value.enumeration One of an enumerated (explicitly listed) set of strings.

int8 An 8-bit signed integer.int16 A 16-bit signed integer.int32 A 32-bit signed integer.int64 A 64-bit signed integer.

leafref A reference to a leaf instance.mac-address An IEEE 802.xx media access control address (MAC) address. The canonical representation uses

lowercase characters.string A series of alphanumeric and punctuation characters including spaces treated as a single unit. A string

may also include special characters. For a formal definition refer to http://www.w3.org/TR/2000/WD-xml-2e-20000814 and section 3.2.1 of http://www.w3.org/TR/xmlschema-2/.

timetick The time (measured in hundredths of a second) between two epochs. When a schema node is defined thatuses this type, the description of the schema node identifies both of the reference epochs.

uint8 An 8-bit signed unsigned integer.uint16 A 16-bit signed unsigned integer.uint32 A 32-bit signed unsigned integer.uint64 A 64-bit signed unsigned integer.union A data type that is composed of multiple data types.

zero-based-counter32 A counter32 that has zero as its defined initial value.

zero-based-counter64 A counter64 that has zero as its defined initial value.


Broadcom



http://www.w3.org/TR/2000/WD-xml-2e-20000814

http://www.w3.org/TR/2000/WD-xml-2e-20000814

http://www.w3.org/TR/xmlschema-2/


Additional FOS REST API Data TypesThe following sections describe additional data types supported by the FOS REST API.

• Additional General Data Types• Fibre Channel Data Types• FRU Module Data Types• ietf-inet Data Types• ietf-yang Data Types• Logging Module Data Types• MAPS Module Data Types• Operations Module Data Types• Security Module Data Types• SNMP Module Data Types• Time Module Data Types

Additional General Data Types

The following table describes additional data types supported by the FOS REST API. Additional details about these datatypes can be found in the associated .yang file (for example, brocade-zone.yang). This file is located in the same folder asthe module .yang files.

Table 7: General Data Types

Name Type Range/Pattern/Length Description

air-flow-direction-type(brocade-fru.yang)

string forward (non-portside exhaust)|non-portside exhaust|reverse (non-portside intake)|non-portside intake|notavailable

The air flow direction of the fan.

alert-type(brocade-media.yang)

int16 -32767–32767 The high or low alert type for the media.

authentication-data(brocade-extension-ipsec-policy.yang)

union “preshared-key” or “pki-key-pair” The authentication data format. The valuedepends on the profile used, either “preshared-key” or “pki-key-pair”.

brocade-hex-string-type string 0[xX][0-9a-fA-F] Brocade hexadecimal string format. This typedefines a generic case-insensitive hexadecimalstring that requires a '0x' prefix (also case-insensitive).

capable-speed-type(brocade-media.yang)

uint16 1–1000 The supported transmission speeds of themedia.


Broadcom



comments-type(brocade-fibrechannel-diagnostics.yang)

string |Test failed|No SFP or chip support|See remote port results|Remoteport is not ready to start the test|Toomany offline events|Remote port testfailed|Remote port WWN changed|Slot or port offline|Protocol error|Unable to start/restart the test|D-Port mode mismatch, Not D-Port|Module removed|No remote SFP orchip support|No remote port support orskipped|E_WRAP/O_WRAP set failed|User opted to skip|Test skipped due toSFP loopback error|Test timed out

Additional textual information elaborating on thecompletion status when a test is skipped or fails.It returns an empty string if no comments areavailable.

congestion-detection-signal-cycles-type(brocade-fabric-traffic-controller.yang)

uint16 0|1–999 The signal threshold - congestion detection cyclecount:• 0 = Not supported.• 1 to 999 = The number of cycles at the

indicated signaling scale used to detectcongestion signals.

congestion-detection-signal-type(brocade-fabric-traffic-controller.yang)

enumeration "none", "warning", or "warning-and-alarm"

The congestion detection signal capability.

congestion-detection-signal-scale-type(brocade-fabric-traffic-controller.yang)

enumeration "none", "seconds", "milliseconds","microseconds", or "nanoseconds"

The signal threshold - congestion detectionscale in seconds, milliseconds, microseconds, ornanoseconds.

congestion-state-type(brocade-fabric-traffic-controller.yang)

enumeration "none", "credit-stalled", "lost-credit", or"oversubscribed"

The congestion status.

current-type(brocade-media.yang)

decimal64 0–999.99 The transceiver current of the media.

date-code-type(brocade-media.yang)

string [ -~]{1,32} The vendor's manufacturing date code.

domain-index-type(brocade-zone.yang)

string ([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0123][0-9]),(([0-9])|([1-9][0-9])|([1-9][0-9][0-9])|([1-9][0-9][0-9][0-9])|([1-5][0-9][0-9][0-9][0-9])|(6[0-4][0-9][0-9][0-9])|(65[0-4][0-9][0-9])|(655[0-2][0-9])|(6553[0-5])|(-1))

Domain (D) and Index (I) zone members appearas "D,I". The value for domain is between 1 and239 and the value for index is between -1 and65535.

domain-port-type string ([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0123][0-9]),(([0-9])|([1-9][0-9])|([1-9][0-9][0-9])|([1-9][0-9][0-9][0-9])| ([1-5][0-9][0-9][0-9][0-9])|(6[0-4][0-9][0-9][0-9])|(65[0-4][0-9][0-9])| (655[0-2][0-9])|(6553[0-5]))

Domain/port zone members appear as“domain,port”. The value for domain is from 1through 239 and the value for port is from 0through 65535.

els-descriptor-type(brocade-fabric-traffic-controller.yang)

enumeration "none", "fpin-peer-congestion", "fpin-link-integrity", "fpin-congestion", or"fpin-delivery"

The ELS + ELS-descriptor pairs that areexchanged via the Register Diagnostic Functions(RDF) ELS.


Broadcom



error-stats-type(brocade-fibrechannel-diagnostics.yang)

enumeration "none", "generic", "enc-in", "crc-err","trunc-frame", "frame-too-long", "bad-eof", "enc-out", "bad-os", "c3-discard","rx-c3-timeout", "tx-c3-timeout","unroutable", "unreachable", "other-discard", "link-failure", "sync-loss","signal-loss", "prim-seq-proto", "inv-tx-word", "invalid-crc", "delimiter-err","addr-id-err", "link-reset-in", "link-reset-out", "port-ols-in", "port-ols-out", "inv-arb", "single-credit-loss", "multi-credit-loss", "fec-uncorrected", "pcs-block-error ", or "unknown-error

The error statistics on the port.

extension-ipsec-profile-name(brocade-extension-ipsec-policy.yang)

enumeration “preshared” or “pki” An Extension IPsec policy name. This is either“preshared” or “pki”.

fc-speed-type uint64 0|1000000000|2000000000|4000000000|8000000000|100000000000|160000000000|320000000000|400000000000|53000000000|64000000000

The nominal port bandwidth.• 0 = Auto-negotiated speed• 1000000000 = 1Gb/s• 2000000000 = 2Gb/s• 4000000000 = 4Gb/s• 8000000000 = 8Gb/s• 10000000000 = 10Gb/s• 16000000000 = 16Gb/s• 32000000000 = 32Gb/s• 40000000000 = 40Gb/s• 53000000000 = 53Gb/s• 64000000000 = 64Gb/s

fcr-device-state(brocade-fibrechannel-routing.yang)

enumeration "configured", "initializing", "exist", or"imported"

The state of the device.

ge-interface-type string (([1][0-2]|[0-9])/(1[0-7]|[0-9])) GE interface of an Extension blade or system inthe form of the slot and port number of the port(slot/port).

interface-type(brocade-media.yang)

string 6–16((fc|ge|te)/([0-9]|1[0-9])/([1][0-9][0-9][0-9]|[0-9][0-9][0-9]|[0-9][0-9]|[0-9]))

The network interface name in 3-tuple canonicalformat: interface-id/slot/port. The interface IDsinclude fc, ge, and te.

lag-port-timeout(brocade-interface.yang)

enumeration "short" or "long" The timeout (short or long) configured for the portchannel member.

lldp-mandatory-tlv-name-type(brocade-lldp.yang)

enumeration "chassis-id", "port-id", or "time-to-live" The LLDP mandatory TLV names.

lldp-optional-tlv-name-type(brocade-lldp.yang)

enumeration "dcbx", "fcoe-app", "fcoe-lls", "dot1","dot3", "mgmt-addr", "port-desc", "sys-cap", "sys-desc", or "sys-name"

The LLDP optional TLV names.


Broadcom



logical-path-operational-states(brocade-ficon.yang)

enumeration "Oper" or Reset" The operational state for a logical path.

media-power-type(brocade-media.yang)

decimal64 0–9999.99 The power type of the media.

operational-type uint16 0–40 Tunnel/Circuit operational status.• 0 = NULL• 1 = Offline• 2 = Online• 3 = Online Warning• 4 = Disabled• 5 = Degraded• 6 = Initializing• 7 = Delete Pending• 8 = HA Online• 9 = HA Offline• 10 = HA Ready• 11 = Empty• 12 = In Progress• 13 = MisConfig• 14 = Failover• 15 = Down Pending• 16 = Circuit Disabled/Fenced/Testing• 17 = Internal Error• 18 = IPSec Error• 19 = Network Error• 20 = Authentication Error• 21 = Timeout• 22 = TCP-Timeout• 23 = Remote Close Timeout• 24 = Remote Close• 25 = Rejected• 26 = No Port• 27 = No Route• 28 = DP Offline• 29 = HCL Inprogress• 30 = Internal Error• 31 = Configuration Incomplete• 32 = Circuit Fenced• 33 = Child Delete Complete• 34 = Delete Failure• 35 = Spill Over• 36 = Running• 37 = Testing• 38 = Aborted• 39 = Passed• 40 = Failed


Broadcom



pki-key-pair(brocade-extension-ipsec-policy)

string 1–32 characters, matching thefollowing pattern:Excludes “/”. The modifier is “invert-match”.

This is a certificate name.For a “pki” profile, this specifies the local key pairname to use for IKE authentication. This operandis required for logging in using a PKI profile.

portchannel-type(brocade-interface.yang)

enumeration "static" or "dynamic" Whether the port channel is static or dynamic.

port-type-string-type(brocade-interface.yang)

enumeration "e-port", "g-port", "universal-port", " f-port", "l-port", "fcoe-port", "ex-port", "d-port", " sim-port", "af-port", "ae-port","ve-port", "ethernet-port", "flex-port","n-port", "mirror-port", "encryption-support-port", "loopback-port", or"unknown-port"

The supported Fibre Channel port types.

preshared-key(brocade-extension-ipsec-policy)

string 16–64 characters, matching thefollowing pattern:'[a-zA-Z0-9~@%_+:\[\]][a-zA-Z0-9~@%_+:\[\]\-]{15,63}';

For a “preshared” profile, this specifies thepreshared-key to be used for authentication.This operand is required with shared-keyauthentication.

result-type(brocade-fibrechannel-diagnostics.yang)

string NOT STARTED|PASSED|SKIPPED|FAILED|IN PROGRESS|RESPONDER|STOPPED|UNKNOWN

The completion status of a diagnostic test.

speed-type uint64 1000000000|10000000000|40000000000

The Gigabit Ethernet port bandwidth.• 1000000000 = 1Gb/s• 10000000000 = 10Gb/s• 40000000000 = 40Gb/s

temperature-type(brocade-media.yang)

int16 -128–1000 The temperature of the media.

tunnel-load-level enumeration default|failover|spillover The load balancing method for the extensiontunnel.

ve-interface-type string ((([1][0-2]|[1-9])/(1[6-9]|2[0-9]|3[0-5]))|((0)/(2[4-9]|3[0-9]|4[0-3])))

VE interface of an Extension blade or system inthe form of the slot and port number of the port(slot/port).

vendor-name-type(brocade-media.yang)

string 0–255 The vendor name for the media.

vendor-revision-type(brocade-media.yang)

string 0–255 The vendor revision number for the media.

voltage-type(brocade-media.yang)

decimal64 0–999.99 The transceiver voltage of the media.

zone-member-type(brocade-zone.yang)

union This data type is composed of thefollowing data types:• zoning-name-type• fibrechannel:wwn-type• domain-index-type

The zone member composed of the followingthree zone member types:• WWN• Domain-Index• zone alias

zone-operation-action-type(brocade-operation-zone.yang)

enumeration "expunge" The zone operation action type field. You mustcomplete this field for any RPC zone operation.

zone-type-string-type(brocade-zone.yang)

enumeration "zone", "user-created-peer-zone", or"target-created-peer-zone

The zone type. This field must be supplied forany peer zone operation.


Broadcom



zone-type-type(brocade-zone.yang)

uint8 0|1|2 The zone type.• 0 = Default (any zone that is not a peer zone)• 1 = User-created peer zone• 2 = Target-created peer zone

zoning-name-type(brocade-zone.yang)

string 1–64 characters, matching thefollowing pattern:([0-9a-zA-Z_\-^$]{1,64})

A counter64 that has zero as its defined initialvalue.

Fibre Channel Data Types

The following table describes additional Fibre Channel data types supported by the FOS REST API. For additional detailsabout Fibre Channel data types, refer to the fibrechannel-yang-types.yang file.

Table 8: Fibre Channel Data Types


brocade-hex-string-type string 0[xX][0-9a-fA-F] Brocade hexadecimal string format. This typedefines a generic case-insensitive hexadecimalstring that requires a '0x' prefix (also case-insensitive).

deskew-type uint16 1–255 The time in 10ns units. This is used by trunkingfor fibrechannel ports.

domain-id-type uint32 0–239 A Fibre Channel switch domain identifier. Notethat a value of zero indicates a segmented link.

fabric-id-type uint32 1–128 A fabric ID (FID).

fcid-type Deprecated: Use'fcid-hex-string-type' instead.

uint32 [0-9A-F]{12} A Fibre Channel ID (FCID) in decimal format.This is a 3-byte (24-bit) field used to route framesthrough a FC network.

fcid-hex-string-type string 0[xX][0-9a-fA-F] A Fibre Channel ID (FCID) for an Nx_Port(FCID), hexadecimal format. The format allowsfor six hexadecimal digits prefixed by '0x' or '0X'.For example: 0x010200


Broadcom



fc4-type-type string (0[xX][0-9a-fA-F]{2}| |IPFC|FCP|FCP-Features|SATA-Tunnel|SBCCS|SBCCS-Channel|SBCCS-Control-Unit|FC-CT|FC-SW|FC-IFR|FC-NVMe|HIPPI-FP|MIL-STD-1553|ASM|FC-VI|Application-Services|Generic-FC-Features|RNID-Topology-Discovery)

The FC4 type.• Unknown/Reserved <hexadecimal value> =

(0xnn)• IPFC = (0x05)• FCP = (0x08)• FCP-Features = (0x0A)• SATA-Tunnel = (0x14)• SBCCS = (0x18)• SBCCS-Channel = (0x1B)• SBCCS-Control-Unit =(0x1C)• FC-CT = (0x20)• FC-SW = (0x22)• FC-IFR = (0x25)• FC-NVMe = (0x28)• HIPPI-FP = (0x40)• MIL-STD-1553 = (0x48)• ASM = (0x49)• FC-VI = (0x58)• Application-Services = (0x60)• Generic-FC-Features = (0xDE)• RNID-Topology-Discovery = (0xDF)

fc4-features-type string (FCP-Initiator|FCP-Target|FC-NVMe-Discovery-Service|FC-NVMe-Initiator|FC-NVMe-Target)

The registered FC-4 features in relation to agiven FC-4 type.

fibrechannel_extended_isl N/A N/A Indicates that Extended ISL (XISL) use issupported on this platform. XISL use requires VFMode to be enabled.

fibrechannel_extension_platform

N/A N/A Indicates that the Extension platform issupported.

fibrechannel_virtual_fabric_platform

N/A N/A Indicates that Virtual Fabric mode is enabled.

octet-member-index-type int8 0–7 Identifies the member in the octet for a trunk.

percentage-type string ([0-9][0-9].[0-9][0-9]|100.00) A percentage string up to two decimal places.

portchannel_platform N/A N/A Indicates that Port Channels are supported onthis platform.

port-type-string-type string 0[xX][0-9a-fA-F]{2}|n-port|nl-port|f/nl-port|nx-port|f-port|fl-port|e-port|b-port|a-port

A Fibre Channel port type identifier.• Unknown/Reserved <hexadecimal value> =

(0xnn)• n-port = (0x01)• nl-port = (0x02)• f/nl-port = (0x03)• nx-port = (0x7F)• f-port = (0x81)• fl-port = (0x82)• e-port = (0x84)• b-port = (0x85)• a-port = (0x86)


Broadcom



slot-port-name-type string (([1-9]|1[0-9])/([1][0-9][0-9][0-9]|[1-9][1-9][0-9]|[1-9][1-9]|[1-9]))

The slot and port number (slot/port) of theinterface.

speed-type string ( |bit-[0-9]{1,2}|speed-1-gfc|speed-2-gfc|speed-10-gfc|speed-4-gfc|speed-8-gfc|speed-16-gfc|speed-32-gfc|speed-20-gfc|speed-40-gfc|speed-128-gfc|speed-64-gfc|speed-256-gfc|speed-not-established|speed-10-ge|speed-40-ge|speed-100-ge|speed-25-ge|speed-50-ge|speed-400-ge)*

Fibre Channel transmission speeds.• bit-n = (Unknown/Reserved <bit position>)• speed-1-gfc = (Mask Value (hex): 0000 0001)• speed-2-gfc = (Mask Value (hex): 0000 0002)• speed-10-gfc = (Mask Value (hex): 0000

0004)• speed-4-gfc = (Mask Value (hex): 0000 0008)• speed-8-gfc = (Mask Value (hex): 0000 0010)• speed-16-gfc = (Mask Value (hex): 0000

0020)• speed-32-gfc = (Mask Value (hex): 0000






0800)• speed-not-established = (Mask Value (hex):

0000 8000)• speed-10-ge = (Mask Value (hex): 0001

0000)• speed-40-ge = (Mask Value (hex): 0002





0000)

time-generated-type uint32 1–2147483646 The time since the start of an epoch in seconds.An epoch is an instant in time chosen as theorigin of a particular measurement block.

user-port-number-type int32 -1–3400 A Fibre Channel port user port number.

wwn-type string ([0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){7}) A Fibre Channel WWN. This is a 64-bitidentifier, with a 60-bit value preceded by a 4-bitNetwork_Address_Authority Identifier, used toidentify entities in Fibre Channel (e.g., Nx_Port,node, F_Port, or Fabric). Typically shown as 16uppercase hexadecimal characters with a colonseparating each tuple.


Broadcom


FRU Module Data Types

The following table describes additional FRU data types supported by the FOS REST API. Additional details aboutthese data types can be found in the associated brocade-fru-types.yang file. This file is located in the same folder as themodule .yang files.

Table 9: FRU Module Data Types


firmware-version-type string 1–255[ -~]{1,255}

A human readable string identifying the firmwareversion running on the switch.

ip-gateway-type union [*] The IP address of an IP router that can routepackets to the destination IP address. Enter an'*' (asterisk) to retrieve route entries that arecreated internally by the system.

manufacturer-type string 1–63[ -~]*

The name of the organization responsible forproducing the blade.

part-number-type string 1–14[ -~]{1,14}

The part number assigned by the organizationresponsible for producing or manufacturing thephysical element.

serial-number-type string 1–15[ -~]{1,15}

A printable ASCII string that specifies the serialnumber of the chassis.

ietf-inet Data Types

The following table describes additional ietf-inet data types supported by the FOS REST API. For additional details ietf-inet data type refer to the ietf-inet-types.yang file. This file is located in the same folder as the module .yang files.


Broadcom


Table 10: ietf-inet Data Types


inet:as-number uint32 N/A The autonomous system numbers which identifyan Autonomous System (AS). An AS is a set ofrouters under a single technical administration,using an interior gateway protocol and commonmetrics to route packets within the AS, andusing an exterior gateway protocol to routepackets to other ASes. IANA maintains the ASnumber space and has delegated large partsto the regional registries. Autonomous systemnumbers were originally limited to 16 bits. BGPextensions have enlarged the autonomoussystem number space to 32 bits. This typetherefore uses an uint32 base type without arange restriction in order to support a largerautonomous system number space. In the valueset and its semantics, this type is equivalentto the InetAutonomousSystemNumber textualconvention of the SMIv2. Refer to RFC 1930,RFC 4271, RFC 4001, and RFC 6793.

inet:domain-name string 1–253 characters A domain name service (DNS) domain name.Refer to RFC 1123.

inet:dscp uint8 0–63 A differentiated services code point (DSCP)that can be used for marking packets in a trafficstream. In the value set and its semantics, thistype is equivalent to the dscp textual conventionof the SMIv2. Refer to RFC 3289, RFC 2474, and RFC 2780.

inet:host union N/A The host type represents either an IP address ora DNS domain name.

inet:ip-address union N/A An IP address that is IP version neutral, wherethe format of the address indicates the IPversion. This type supports scoped addresses byallowing zone identifiers in the address format.Refer to RFC 4007.

inet:ip-address-no-zone union N/A An IP address that is IP version neutral, wherethe format of the address indicates the IPversion. This type supports scoped addresses byallowing zone identifiers in the address format.Refer to RFC 4007.

inet:ipv4-address uint16 N/A An IP address in the IPv4 format. Refer to RFC791.

inet:ipv4-address-no-zone inet:ipv4-address

[0-9\.]* An IPv4 address without a zone index. This type,derived from inet:ipv4-address type, may be usedin situations where the zone is known from thecontext and hence no zone index is needed.


Broadcom















inet:ipv6-address uint16 N/A An IP address the IPv6 format. Refer to RFC2460.

inet:ipv6-address-no-zone inet:ipv4-address

[0-9a-fA-F:\.]* An IPv6 address without a zone index. This type,derived from inet:ipv6-address type, may be usedin situations where the zone is known from thecontext and hence no zone index is needed.Refer to RFC 4291, RFC 4007, and RFC 5952.

inet:ipv6-flow-label uint32 0–1048575 The flow identifier or flow label in an IPv6 packetheader that can be used to discriminate trafficflows. In the value set and its semantics, thistype is equivalent to the IPv6FlowLabel textualconvention of the SMIv2. Refer to RFC 3595 andRFC 2460.

inet:ip-prefix union N/A An IP prefix that is IP version neutral, where theformat of the address indicates the IP version.

inet:ipv4-prefix string (([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}' + '([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])' + '/(([0-9])|([1-2][0-9])|(3[0-2]))

The length of the IPv4 address prefix. The prefixlength is given by the number following the slashcharacter and must be less than or equal to 32.A prefix length value of n corresponds to an IPaddress mask that has n contiguous 1-bits fromthe most significant bit (MSB) and all other bitsset to 0. The canonical format of an IPv4 prefixhas all bits of the IPv4 address set to zero thatare not part of the IPv4 prefix.

inet:ipv6-prefix string ((:|[0-9a-fA-F]{0,4}):)([0-9a-fA-F]{0,4}:){0,5}' + '((([0-9a-fA-F]{0,4}:)?(:|[0-9a-fA-F]{0,4}))|' + '(((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\.){3}' + '(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])))' + '(/(([0-9])|([0-9]{2})|(1[0-1][0-9])|(12[0-8])))';pattern '(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|'+ '((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)' + '(/.+)

The length of the IPv6 address prefix. The prefixlength is given by the number following the slashcharacter and must be less than or equal to 128.A prefix length value of n corresponds to an IPaddress mask that has n contiguous 1-bits fromthe most significant bit (MSB) and all other bitsset to 0. The IPv6 address should have all bitsthat do not belong to the prefix set to zero. Thecanonical format of an IPv6 prefix has all bits ofthe IPv6 address set to zero that are not part ofthe IPv6 prefix. Refer to RFC 5952.

inet:ip-version enumeration

N/A The IP protocol version.• 0 = unknown• 1 = ipv4• 2 = ipv6


Broadcom











inet:port-number uint16 0..65535 A 16-bit port number of an Internet transport-layer protocol such as UDP, TCP, DCCP, orSCTP. Port numbers are assigned by IANA. Acurrent list of all assignments is available fromIANA (http://www.iana.org/).Note that the port number value zero is reservedby IANA. In situations where the value zerodoes not make sense, it can be excluded bysubtyping the port-number type. In the value setand its semantics, this type is equivalent to theInetPortNumber textual convention of the SMIv2.Refer to RFC 768, RFC 793, RFC 4960, RFC4340, and RFC 4001.

inet:uri string N/A A Uniform Resource Identifier (URI) as definedby STD 66. Objects using the URI type MUST bein US-ASCII encoding, and MUST be normalizedas described by RFC 3986 Sections 6.2.1,6.2.2.1, and 6.2.2.2. All unnecessary percent-encoding is removed, and all case-insensitivecharacters are set to lowercase except forhexadecimal digits, which are normalized touppercase as described in Section 6.2.2.1. Thepurpose of this normalization is to help provideunique URIs. Note that this normalization is notsufficient to provide uniqueness. Two URIs thatare textually distinct after this normalization maystill be equivalent. Objects using the URI typemay restrict the schemes that they permit. Forexample, 'data:' and 'urn:' schemes might not beappropriate. A zero-length URI is not a valid URI.This can be used to express 'URI absent' whererequired. In the value set and its semantics,this type is equivalent to the URI SMIv2 textualconvention defined in RFC 5017. Refer to RFC3986, RFC 3305, and RFC 5017.

ietf-yang Data Types

The following table describes additional ietf-yang data types supported by the FOS REST API. For additional details onietf-yang data types, refer to the ietf-yang-types.yang file. This file is located in the same folder as the module .yang files.


Broadcom







https://tools.ietf.org/html/std66








Table 11: ietf-yang Data Types


ietf:counter32 uint32 0–4294967296 A non-negative integer that monotonicallyincreases until it reaches a maximum value of2^32-1 (4294967296 in decimal), at which pointit wraps around and starts increasing again fromzero. It has no preset initial value.

ietf:counter64 uint64 0–18446744073709551615 A non-negative integer that monotonicallyincreases until it reaches a maximum value of2^64-1 (18446744073709551615 in decimal), atwhich point it wraps around and starts increasingagain from zero. It has no preset initial value.

ietf:date-and-time string \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?' + '(Z|[\+\-]\d{2}:\d{2})

A profile using the ISO 8601 standard forrepresenting dates and times using the Gregoriancalendar. Refer to RFC 6991.

ietf:dotted-quad string (([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])

An unsigned 32-bit number expressed in thedotted-quad notation, such as, four octets writtenas decimal numbers and separated with the'.' (full stop) character.

ietf:gauge32 uint32 0–4294967296 A non-negative integer, which may increase ordecrease, but shall never exceed a maximumvalue, nor fall below a minimum value. Themaximum value cannot be greater than 2^32-1(4294967295 in decimal), and the minimumvalue cannot be smaller than 0. The value ofa gauge32 has its maximum value wheneverthe information being modeled is greater thanor equal to its maximum value, and has itsminimum value whenever the informationbeing modeled is smaller than or equal to itsminimum value. If the information being modeledsubsequently decreases below (increases above)the maximum (minimum) value, the gauge32 alsodecreases (increases). In the value set and itssemantics, this type is equivalent to the Gauge32type of the SMIv2. Refer to RFC 2578.


Broadcom





ietf:gauge64 uint64 0–18446744073709551615 A non-negative integer, which may increase ordecrease, but shall never exceed a maximumvalue, nor fall below a minimum value. Themaximum value cannot be greater than 2^64-1(18446744073709551615 in decimal), and theminimum value cannot be smaller than 0. Thevalue of a gauge64 has its maximum valuewhenever the information being modeled isgreater than or equal to its maximum value, andhas its minimum value whenever the informationbeing modeled is smaller than or equal to itsminimum value. If the information being modeledsubsequently decreases below (increases above)the maximum (minimum) value, the gauge64also decreases (increases). In the value setand its semantics, this type is equivalent to theCounterBasedGauge64 SMIv2. Refer to RFC2856.

ietf:hex-string string ([0-9a-fA-F]{2}(:[0-9a-fA-F]{2})*)? A hexadecimal string with octets represented ashex digits separated by colons. The canonicalrepresentation uses lowercase characters.

ietf:mac-address string Six groups of two hexadecimal digits,separated by hyphens, matching thefollowing pattern:([0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){5})

An IEEE 802.xx media access control address(MAC) address. The canonical representationuses lowercase characters.

ietf:object-identifier string (([0-1](\.[1-3]?[0-9]))|(2\.(0|([1-9]\d*))))(\.(0|([1-9]\d*)))*

An administratively assigned name in aregistration-hierarchical-name tree. Values of thistype are denoted as a sequence of numericalnon-negative sub-identifier values. Each sub-identifier value MUST NOT exceed 2^32-1(4294967295). Sub-identifiers are separatedby single dots and without any intermediatewhitespace. The ASN.1 standard restricts thevalue space of the first sub-identifier to 0, 1, or2. Furthermore, the value space of the secondsub-identifier is restricted to the range 0 to 39if the first sub-identifier is 0 or 1. Finally, theASN.1 standard requires that an object identifierhas always at least two sub-identifiers. Thepattern captures these restrictions. Although thenumber of sub-identifiers is not limited, moduledesigners should realize that there may beimplementations that stick with the SMIv2 limitof 128 sub-identifiers. This type is a superset ofthe SMIv2 OBJECT IDENTIFIER type since it isnot restricted to 128 sub-identifiers. Hence, donot use this type to represent the SMIv2 OBJECTIDENTIFIER type; use the object-identifier-128type instead. Refer to ISO/IEC 9834-1:2008.


Broadcom



https://www.iso.org/standard/51424.html



ietf:object-identifier-128 object-identifier

\d*(\.\d*){1,127} An object identifier restricted to 128 sub-identifiers. In the value set and its semantics, thistype is equivalent to the OBJECT IDENTIFIERtype of the SMIv2. Refer to RFC 2578.

ietf:phys-address string ([0-9a-fA-F]{2}(:[0-9a-fA-F]{2})*)? A media- or physical-level address representedas a sequence of octets, each octet representedby two hexadecimal numbers separated bycolons. The canonical representation useslowercase characters. In the value set andits semantics, this type is equivalent to thePhysAddress textual convention of the SMIv2.Refer to RFC 2579.

ietf:timestamp yang:timeticks

N/A The value of an associated timeticks schemanode at which a specific occurrence happened.The specific occurrence must be defined in thedescription of any schema node defined usingthis type. When the specific occurrence occurredprior to the last time the associated timeticksattribute was zero, then the timestamp valueis zero. Note that this requires all timestampvalues to be reset to zero when the value ofthe associated timeticks attribute reaches 497+days and wraps around to zero. The associatedtimeticks schema node must be specified in thedescription of any schema node using this type.In the value set and its semantics, this type isequivalent to the TimeStamp textual conventionof the SMIv2. Refer to RFC 2579.

ietf:timeticks uint32 0–4294967296 The time (measured in hundredths of a second)between two epochs. When a schema node isdefined that uses this type, the description ofthe schema node identifies both of the referenceepochs.

ietf:uuid string [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

A Universally Unique IDentifier in thestring representation defined in RFC4122. The canonical representation useslowercase characters. The following is anexample of a UUID in string representation:f81d4fae-7dec-11d0-a765-00a0c91e6bf6. Referto RFC 4122.

ietf:xpath1.0 string N/A An XPATH 1.0 expression. When a schema nodeis defined that uses this type, the description ofthe schema node must specify the XPath contextin which the XPath expression is evaluated.Refer to "XPATH: XML Path Language (XPath)Version 1.0.


Broadcom





https://www.w3.org/TR/1999/REC-xpath-19991116/

https://www.w3.org/TR/1999/REC-xpath-19991116/



ietf:yang-identifier string [a-zA-Z_][a-zA-Z0-9\-_.]*.|..|[^xX].*|.[^mM].*|..[^lL].*

A YANG identifier string as defined by the'identifier' rule in Section 12 of RFC 6020. Anidentifier must start with an alphabetic characteror an underscore followed by an arbitrarysequence of alphabetic or numeric characters,underscores, hyphens, or dots. A YANG identifiermust not start with any possible combination ofthe lowercase or uppercase character sequence'xml'. Refer to RFC 6020.

ietf:zero-based-counter32 uint32 0–4294967296 A counter32 that has zero as its defined initialvalue.

ietf:zero-based-counter64 uint64 0–18446744073709551615 See zero-based-counter64 above.

Logging Module Data Types

The following table describes additional logging module data types supported by the FOS REST API. Additional detailsabout these data types can be found in the associated brocade-logging-types.yang file. This file is located in the samefolder as the module .yang files.

Table 12: Logging Module Data Types


ascii-text-type string [ -~]* The type of text.

class-type string zone|security|configuration|firmware|fabric|ls|cli|maps

The type of log to be collected (such as fabricrelated log).

message-id-type string 7 to 12 alphanumeric characters.[A-Z]{2,7}-[0-9]{4,4}

The unique identifier for the raslog message.

module-id-type string 2 to 7 alphanumeric characters.[A-Z]{2,7}

The FOS module ID type.

severity-level-type string info|warning|error|critical The severity level types.

time-24hr-type string 5 numeric characters.[0-2][0-9]:[0-5][0-9]

The time in 24 hour clock in the format HH:MM.

MAPS Module Data Types

The following table describes additional Monitoring and Alerting Policy Suite (MAPS) data types supported by the FOSREST API. Additional details about these data types can be found in the associated brocade-maps-types.yang file. Thisfile is located in the same folder as the module .yang files.


Broadcom



Table 13: MAPS Module Data Types


maps-types:credit-stall-state-type

enumeration N/A The available states on the FPI credit-stallcongestion conditions.• frame-loss = The frame loss state.• perf-impact = The performance impact state.• medium = The medium state.• low = The low state.• info = The information state.• no-congestion = The no congestion state.• monitoring-paused = Monitoring is paused for

the member.

maps-types:data-type-type enumeration N/A The data type support. Each monitoring systemsupports different data types for thresholds.• unsigned-int32 = The unsigned integer 32 bits

data type.• int32 = The integer 32 bits data type.• float = The float data type.• unsigned-int64 = The unsigned integer 64 bits

data type.• enum = The enumeration data type.

maps-types:fru-state-type enumeration N/A The FRU states.• faulty = The faulty state.• in = The plug in state.• out = The plug out state.• off = The power off state.• on = The power on state.


Broadcom



maps-types:maps-dashboard-category-type

enumeration N/A The dashboard category. Each rule can belong toonly one category.• port-health = The Port Health category

monitors port statistics and takes actionbased on the configuration thresholds andactions. You can configure thresholds per porttype and apply the configuration to all portsof the specified type. Ports whose thresholdscan be monitored include physical ports,D_Ports, E_Ports, and F_Ports. The PortHealth category also monitors the physicalaspects of a small form-factor pluggable(SFP) transceiver, such as voltage, current,receive power (RXP), and transmit power(TXP) in physical ports, D_Ports, E_Ports,and F_Ports.

• backend-port-health = The FRU Healthcategory enables you to define rules for fieldreplaceable units (FRUs).

• extension-ge-port-health = The GigabitEthernet (GE) ports category monitorsstatistics for GE ports and takes action basedon the configuration thresholds and actions.You can configure thresholds and apply theconfigure to all ports.

• security-violations = The Security Healthcategory monitors security violations onthe switch and takes action based on theconfigure thresholds and their actions.

• fabric-state-changes = The Fabric StateChanges category monitors areas of potentialfabric related or switch related problems,such as zone changes, fabric segmentation,E_Port down, fabric reconfiguration, domainID changes, and fabric logins.

• fru-health = The FRU Health categoryenables you to define rules for fieldreplaceable units (FRUs).

• extension-health = The Extension Healthcategory enables you to define rules forExtension health, including circuit statechanges, circuit state utilization, and packetloss.

• switch-resources = The Switch Resourcecategory monitors your system's temperature,flash usage, memory usage, and CPU.

• fabric-performance-impact = The FabricPerformance Impact category monitors thecurrent condition of the latency detected onE_Ports and F_Ports in a fabric over differenttime windows and uses this to determine theperformance impact to the fabric and network

• traffic-performance = The Traffic Performancecategory monitors flows.


Broadcom



maps-types:maps-data-unit enumeration N/A The unit of the monitoring system.

• CRCs• ITWs• LFs• loss-of-signal• errors• LRs• timeouts• milli-ampere• days• loss-of-signals• loss-of-synchronization• violations• ports• extension-flows• it-flows• certificates• segmentations• changes• logins• IOs• IOPS• MBps• %• hours• centigrade• bytes• micro-seconds• milli-volts• micro-watts• aborts• reserves• not-applicable

maps-types:maps-event-severity-type

string 1 to 10 characters.[info|warning|error|critical|^$]

The user-configured severity (such as warning,error, critical, or info). Each event has its ownseverity and is user editable. If the value isempty, the system assigns a severity to therule. For more information about the defaultseverity, refer to the Brocade Fabric OS MAPSUser Guide.


Broadcom



maps-types:maps-generic-action-type

enumeration N/A The MAPS actions. You can enable one or moreactions globally at the switch level or per rule.

• port-fence = This action immediately takesports offline, which might cause loss of traffic.

• snmp-trap = This action generates amessage (called a “trap”) that notifies amanagement station when specific eventsoccur on a switch.

• raslog = This action adds an entry to theswitch event log for an individual switch.

• sddq = This action moves the traffic destinedto a port affected by device-based latency toa low-priority virtual channel. This action doesnot disable the port, but it reduces the effectof its latency on other flows in the fabric.

• un-quarantine = This action releases thepreviously quarantined ports.

• decommission = This action takes a portoffline without loss of traffic.

• port-toggle = This action temporarily disablesa port and then re-enables it, allowing theport to reset and recover from some devicebased issues.

• e-mail = This action sends information aboutthe event to one or more specified e-mailaddresses. The e-mail alert specifies thethreshold and describes the event, much likean error message.

• fms = This action MAPS sends a notificationevent information to the FICON managementservice.

• vtap-uninstall = This action uninstalls vTAPfeature if the mirrored frame count exceeds250K IOPS and encryption is enabled on the16Gb/s-capable ASIC. If encryption is notenabled on the ASIC, vTAP is not uninstalled.

• re-balance = This action brings the port groupstate back to balance state. This may take 3or more seconds.

• sw-marginal = This action places the switchinto a marginal operating state.

• sw-critical = = This action places the switchinto a down operating state.

• sfp-marginal = This action places the SFPinto a marginal operating state.

• fpin = This action sends Fabric PerformanceImpact Notifications (FPIN) to registered enddevices.


Broadcom



maps-types:maps-group-feature-type

string 1 to 32 characters.[node\-name|port\-wwn|^$]

The existing feature name for the group. If thevalue is empty, no user feature is assigned tothe group. You can create user-defined groupsmatching the port name or node WWN.• node-wwn = The node WWN feature.• port-name = The port name feature.

maps-types:maps-group-name-type

string 1 to 32 alphanumericcharacters.[0-9a-zA-Z_]*

The group name. The group name must beunique; it is not case sensitive and can containup to 32 characters.

maps-types:maps-group-type-type

enumeration N/A • power-supply = The power supply group type.The device may have multiple power suppliesand may be integrated with a fan.

• fan = The fan group type. The device mayhave multiple fans may be integrated withpower supplies.

• fc-port = The FC port group type.• sfp = The FC SFP group type. The device

may have different SFPs based on speed orvendor.

• blade = The blade group type. This grouptype manages all blades including core, CP,or switch blades.

• circuit = The FCIP circuit group type.• circuit-qos = The circuit QOS traffic group

type. Note that each circuit can carry multipleQOS traffic.

• temperature-sensor = The temperaturesensor group type.

• flash = The flash memory group type.• switch = The switch group type.• chassis = The chassis group type.• cpu = The CPU group type.• wwn = The WWN card group type.• flow = The flow group type.• tunnel = The tunnel group type.• tunnel-qos = The tunnel qos group type.• backend-port = The back end group type.• ge-port = The giga bit ethernet port group

type.• certificate = The security certificate group

type.• dp = The data process group type.• device-pid = The device PID group type.• ethernet-port = The Ethernet port group type.• vtap-port = The vTAP port group type.• asic = The ASIC group type.


Broadcom



maps-types:maps-logical-operator-type

enumeration N/A The relational operation to be used in evaluatingthe condition.• l = The less than logical operator.• le = The less than or equal to logical operator.• g = The greater than logical operator.• ge = The greater than or equal to logical

operator.• eq = The equal to logical operator.• ne = The not equal to logical operator.

maps-types:maps-monitoring-system-type


The monitoring system name (CRC,BLADE_STATE, ITW, and so on). A monitoringsystem is a value (measure or statistic) that canbe monitored.

maps-types:maps-policy-name-type


The MAPS policy name. The name for the policymust be unique; it is case-sensitive and cancontain up to 32 characters.

maps-types:maps-port-monitoring-state

enumeration N/A MAPS monitors each port and based on itsoperating condition it sets the state.

• offline = The offline state.• online = The online state.• faulty = The faulty state.• marginal = The marginal state. A port can

be in marginal state if the port does not haveenough credits to operate.

• error = The error state. A port cam be set toan error state if the port is not in operationdue to hardware malfunction or security.

• un-monitored = The un-monitored state.

maps-types:maps-quiet-time-unit-type

enumeration N/A The unit of quiet time.

• minute = A minute.• hour = An hour.• day = A day.

maps-types:maps-rule-type boolean true|false The rule name. A rule can be one of two types:base or rule-on-rule. A base rule monitorsthe statistics or FRUs whereas a rule-on-rulemonitors the base rule.

maps-types:maps-rule-name-type


The rule name.

maps-types:oversubscription-state-type

enumeration N/A The available states on the FPI oversubscriptionconditions.• oversubscription = The oversubscription

state.• no-oversubscription = The no

oversubscription state.• monitoring-paused = Monitoring is paused for

the member.


Broadcom



maps-types:ssp-state-type enumeration N/A The switch status policy report state. The stategives the summary health of the switch andindividual components.

• unknown = The unkown state.• down = The down state - some service is

already impacted.• marginal = The marginal state - if a FRU is in

a marginal state, fix it or replace it with a newone.

• healthy = The healthy state - normaloperating condition.

maps-types:maps-time-base-type

enumeration N/A The time interval between two samples to becompared.

• none = The time base is not applicable.• second = The samples are compared every

second.• minute = The samples are compared every

minute.• five-minute = The samples are compared

every five minutes.• hour = The samples are compared every

hour.• day = The samples are compared every day.• week = The samples are compared every

week.

maps-types:monitoring-type-type

enumeration N/A The monitoring type (event based or poll based)for the monitoring system.• event-based = Event based monitoring.• poll-based = Poll based monitoring.

maps-types:threshold-value-type

string 1 to 32 alphanumericcharacters.[0-9a-zA-Z,_]*

The threshold to be used in the condition.

Operations Module Data Types

The following table describes additional operations data types supported by the FOS REST API. Additional details aboutthese data types can be found in the associated brocade-operations-types.yang file. This file is located in the same folderas the module .yang files.


Broadcom


Table 14: Operations Module Data Types


operation:message-id-type uint32 1–maximum The Remote Procedure Call (RPC) message.When asynchronous operation is triggered,it returns the random message identifier toassociate it with the operation being triggered.The application could use this identifier toobtain the status of the operation in subsequentrequests.

operation:show-status-group N/A N/A The group of leafs associated with the operation.

• show-status = The supportSave operationstatus based on the specified message ID.

• message-id = The message ID associatedwith the supportSave operation.

• operation = The operation (such assupportsave).

• status = The exact state of the supportSaveoperation. When supportSave is triggered,it is added to the queue. The supportSaveoperation then goes into in-progress untilall supportsave files are transferred tothe remote server. Once the supportSaveoperation is complete, the status moves tothe done, then to delivered until it is purgedfrom the database. If any supportSaveoperational level or application level erroroccurs, it shows an error or application-errorstatus respectively.

• application-name = The name of theapplication that triggered the supportSaveoperation.

• percentage-complete = The percentagecomplete of the operation.

Security Module Data Types

The following table describes additional security module data types supported by the FOS REST API. Additional detailsabout these data types can be found in the associated brocade-security-types.yang file. This file is located in the samefolder as the module .yang files.

Table 15: Security Module Data Types


aaa-authspec-type string 1–128radius;local|radius;localbackup|tacacs;local|tacacs;localbackup|ldap;local|ldap;localbackup|radius|tacacs+|ldap|local

The authentication mode for RADIUS,TACACS+, and LDAP.

aaa-encryption-algorithm-type

enumeration none|aes256 The encryption algorithm type (none oraes256).


Broadcom



aaa-protocols-type enumeration chap|pap The authentication protocols that arecommonly used by both RADIUS andTACACS+.

aaa-timeout-type uint16 1–30 seconds. The default responsetimeout is 3 seconds.

The response timeout for the RADIUS,TACACS+, and LDAP server.

base64-string-type string 0|4–maximum([!-~]{4,})?

The Base64-encoded string. Base64 isa binary-to-text encoding scheme thatrepresents binary data in an ASCII stringwhere each Base64 digit representsexactly 6 bits of data. So a plain string of3 characters is represented by a Base64encoded string of 4 characters. Thegeneric string length relation between theplain and its encoded representation is:length of encoded string = 0 for null stringor a multiple of 4 greater than or equalto (4 * n)/3, where 'n' is the number ofcharacters in the plain string.

certificate-application-type enumeration commoncert|https|radius|ldap|syslog|fcap|all|extension

The certificate type.

certificate-entity-type enumeration cert|ca-client|ca-server|csr|ca The certificate entity type.

default-string-type string 1–maximum[ -~]*

The default string.

gen-certificate-entity-type enumeration cert|csr The certificate entity type.

hash-algorithm-type enumeration md5|sha258|sha512 The hash type (such as md5, sha258, orsha512)

home-virtual-fabric-type fibrechannel:fabric-id-type

N/A The account's home Virtual Fabric.

host-type union Any The IP address. This data type iscomposed of the following data types:• inet:host• inet:ip-prefix• string

ipfilter-action-type enumeration activate|clone The action to take on the IP filter policy.

ipfilter-ip-version-type enumeration IPv4|IPv6 The IP filter policy version (such as IPv4or IPv6).

ipfilter-name-type string 1–20([a-zA-Z0-9_]{1,20})default_ipv4|default_ipv6modifier = invert-match

The name of the IP filter policy.

ipfilter-permission-type enumeration permit|deny The permit or deny action associatedwith this rule.

ipfilter-protocol-type enumeration tcp|udp The protocol type (such as tcp or udp).

ipfilter-traffic-type enumeration INPUT|FORWARD The type of traffic allowed for thespecified IP address.


Broadcom



keysize-type enumeration 1024|2048|4096|8192|P384 The size of the key in bytes. Thegreater the value, the more secure theconnection; however, performancedegrades with size.

ldap-tls-mode-type enumeration starttls|ldaps The LDAP Transport Layer Security(TLS) mode for the LDAP server.

password-cfg-operation-type enumeration hash-config|default|delete-all The configuration or deletion of passwordpolicies.

seccertmgmt-hash-type enumeration sha1|sha256|sha512 The hash type.

seccertmgmt-operation-type enumeration import|export The certificate management operations.

seccertmgmt-protocol-type enumeration scp|ftp The file transfer protocol.

sec-crypto-cfg-actions-type enumeration apply|verify|import|export The action to perform on a template.

sec-crypto-cfg-application-type

enumeration ssh|https The application type.

sec-crypto-cfg-default-template-name-type

enumeration default_generic|default_strong|default_fips|default_cc

The template's default name.

sec-crypto-cfg-file-transfer-protocol-type

enumeration scp|sftp|ftp The file transfer protocol.

sec-crypto-cfg-template-name-type

string 1–256[a-zA-Z0-9_-]{1,256}

The template name.

sec-crypto-cfg-tls-cipher-type string 1–64[-+!0-9]{0,1}[a-zA-Z0-9]{2,64}

The cipher algorithms.

sshutil-algorithm-type enumeration rsa|dsa|ecdsa The key algorithm type.

sshutil-hash-type enumeration md5|sha1|sha256|sha384|sha512 The hash type.

sshutil-key-type enumeration public-private-key|host-key The sshutil key generation type.

sshutil-operation-type enumeration import|export The sshutil operations.

tls-protocol-type string 1–10any|TLSv1.2|TLSv1|TLSv1.3

The TLS protocol.

user-config-access-hours-type

uint16 1–24 hours. The hour.

user-config-access-minutes-type

uint16 1–60 minutes. The minute.

user-config-role-type string 4–16[a-zA-Z]{4,16}

The account's role.

user-config-user-name-type string 1–32([a-zA-Z][0-9a-zA-Z._]{0,31})

The user name. User names arecase-sensitive and can contain upto 32 alphanumeric characters,including periods (.) and underscore (_)characters.

user-password-type string 1–40[ -~]{1,40}:modifier = invert-match

Specifies a password for the account.


Broadcom



validation-mode-type enumeration basic|strict The X509 validation mode.

virtual-fabric-action-type enumeration addlf|deletelf The addition or deletion of Virtual Fabricsfor user configuration.

virtual-fabric-role-id-type string N/A The Virtual Fabrics to be added to theLDAP role. The format is role=virtual-fabric-id-list where role is the LDAP roleand virtual-fabric-id-list is a list of comma-separated virtual fabrics.

SNMP Module Data Types

The following table describes additional SNMP module data types supported by the FOS REST API. Additional detailsabout these data types can be found in the associated brocade-snmp-types.yang file. This file is located in the samefolder as the module .yang files.

Table 16: SNMP Module Data Types


access-permission enumeration ro|rw The SNMP access control permission.

authentication-protocol-type enumeration md5|sha|noauth The authorization protocol for the SNMPv3 user.

default-control-type enumeration snmpv1|snmpv3|accesscontrol|systemgroup|mibcap|auditinterval|mibcapability

The SNMP default configuration options.

group-name enumeration ro|rw|read-only|read-write The SNMP group name.

mibs-name enumeration FE-MIB|SW-MIB|FA-MIB|FICON-MIB|HA-MIB|FCIP-MIB|IF-MIB|BROCADE-MAPS-MIB|T11-FC-ZONE-SERVER-MIB

A list of supported SNMP MIBs.

privacy-protocol-type enumeration des|aes128|aes256|nopriv The privacy protocol for the SNMPv3 user.

security-level uint16 0..3 The SNMP security access level for the GET orSET operation.

severity-level enumeration none|critical|error|warning|informational| debug

The event notification severity level.


Broadcom



traps-name enumeration swFCPortScn|swEventTrap|swIPv6ChangeTrap|swPmgrEventTrap|swFabricReconfigTrap|swFabricSegmentTrap|swExtTrap|swStateChangeTrap|wPortMoveTrap|swBrcdGenericTrap|swDeviceStatusTrap|swZoneConfigChangeTrap|connUnitStatusChange|connUnitEventTrap|connUnitPortStatusChange|linkRNIDDeviceRegistration|linkRNIDDeviceDeRegistration|linkLIRRListenerRemoved|linkRLIRFailureIncident|fruStatusChanged|cpStatusChanged|fruHistoryTrap|linkDown|linkUp|mapsTrapAM|mapsQuietTimeExpirationTrap|t11ZsRequestRejectNotify|t11ZsMergeFailureNotify|t11ZsMergeSuccessNotify|t11ZsDefZoneChangeNotify|t11ZsActivateNotify

A list of supported SNMP traps.

Time Module Data Types

The following table describes additional time module data types supported by the FOS REST API. Additional details aboutthese data types can be found in the associated brocade-time-types.yang file. This file is located in the same folder as themodule .yang files.

Table 17: Time Module Data Types


brocade-time-type:ts-timezone-type

enumeration

N/A The region and city of the time zone. fora complete list, refer to the brocade-time-types.yang file.

brocade-time-type:ts-ntp-type

union 1–32LOCL

The NTP server IP address(es), hostname(s), orLOCL (for the local server).

FOS REST API YANG modulesThe FOS REST API supports 41 Brocade-specific YANG modules.

In the “modules-state/module” list, the server implements the ietf-yang-library module, which identifies all the YANGmodules used by the server. For example requests and responses, refer to the Use Cases section of this publication orthe RESTCONF RFC (RFC 8040).

The FOS REST API modules supported in Fabric OS 9.0.x are described in the following tables. All support the OPTIONSmethod.


Broadcom



Table 18: FOS REST API Module Level Version History

Module Name Description Supported Methods

brocade-module-version Allows you to retrieve the module level version information forBrocade Yang modules and submodules.

GET, HEAD,OPTIONS

Table 19: FOS REST API Modules for Brocade Operations Features


brocade-operation-device-management Allows you to test the reachability of an HBA device. POST, OPTIONS

brocade-operation-extension Allows you to provide REST RPC support on an extensionplatform to either clear or default the extension configurationfor a switch or a blade. You can also reset the global LANstatistics on a data processor.

POST, OPTIONS

brocade-operation-fabric Allows you to initiate a fabric build. POST, OPTIONS

brocade-operation-firmwaredownload Allows you to download and activate firmware from a remotehost. You can configure the firmware download to a secondarypartition only without rebooting and activation. You can alsodisplay, accept, or decline the End User License Agreement(EULA).

POST, OPTIONS

brocade-operation-license Allows you to install or remove a license on a Brocade switch. POST, OPTIONS

brocade-operation-lldp Allows you to clear an LLDP neighbor or reset the LLDPstatistics.

POST, OPTIONS

brocade-operation-pcie-health Allows you to test the Peripheral Component Interconnectexpress (PCIe) links between the nontransparent ports of thePCIe switch in the blades and the standby CP.

POST, OPTIONS

brocade-operation-show-status Allows you to retrieve the status of the supportSave operation.You can also view the status of a firmware downloadoperation.

POST, OPTIONS

brocade-operation-supportlink Allows you to initiate Support Link data collection on theswitch, upload data to the Support Link server, and reset theSupport Link client to default values.

POST, OPTIONS

brocade-operation-supportsave Allows you to initiate supportSave and obtain the message IDof the supportSave operation.

POST, OPTIONS

brocade-operation-zone Allows you to perform zone-related operations. You can alsoperform a zone expunge on zone objects.

POST, OPTIONS

Table 20: FOS REST API Modules for Brocade Fibre Channel Features


brocade-access-gateway Allows you to retrieve a detailed view of configuration andruntime information of the Access Gateway.

GET, POST, PATCH,DELETE, HEAD,OPTIONS

brocade-chassis Allows you to retrieve a detailed view of configuration andruntime information of the chassis.

GET, PATCH, HEAD,OPTIONS


Broadcom



brocade-fabric Allows you to retrieve a list of switches and directors in thefabric.

GET, HEAD,OPTIONS

brocade-fabric-traffic-controller Allows you to retrieve Fabric Traffic Controller (FTC) diagnosticinformation for a device.

GET, HEAD,OPTIONS

brocade-fdmi Allows you to retrieve Fabric Device Management Interface(FDMI) information for the specified switch.

GET, HEAD,OPTIONS

brocade-fibrechannel-configuration Allows you to configure a switch or director. GET, PATCH, HEAD,OPTIONS

brocade-fibrechannel-diagnostics Allows you to perform port diagnostics on a switch or directorand retrieve diagnostic port test results.


brocade-fibrechannel-logical-switch Allows you to retrieve information of all logical switches in aoperational chassis.


brocade-fibrechannel-routing Allows you to configure FC routing between two or morefabrics without merging those fabrics.


brocade-fibrechannel-switch Allows you to retrieve configuration information for a switch ordirector.


brocade-fibrechannel-trunk Allows you to retrieve a detailed view of all of trunks in theswitch in native mode as well as the members of the individualtrunks. It can also provide traffic performance and bandwidthinformation.

GET, POST, DELETE,HEAD, OPTIONS

brocade-ficon Allows you to manage some FICON Control Unit Port (CUP)as well as providing FICON related information from theManagement Server (such as RNID, LIRR, and RLIR data).

GET, PATCH,HEAD, OPTIONS

brocade-fru Allows you to retrieve a detailed view of configuration andruntime information of the FRUs installed in the chassis whichcan be especially helpful in monitoring the health of the device.


brocade-interface/fibrechannel Allows you to configure ports and retrieve port configurations. GET, PATCH, HEAD,OPTIONS

brocade-license Allows you to retrieve a detailed view of the licenses installedon the switch.

GET, HEAD,OPTIONS

brocade-lldp Allows you to configure and monitor LLDP. GET, POST, PATCH,DELETE, HEAD,OPTIONS

brocade-logging Allows you to retrieve a detailed view of audit and RASlogmessage configuration.


brocade-maps Allows you to monitor and configure Monitoring and AlertingPolicy Suite features available in the Fabric OS REST API.


brocade-media Allows you to retrieve a detailed view of the SFP media. GET, HEAD,OPTIONS

brocade-name-server Allows you to monitor the operation of one or more instancesof Name Server functionality.

GET, HEAD,OPTIONS


Broadcom



brocade-security Allows you to configure Fabric OS security features for yourdevices.


brocade-snmp Allows you to monitor the switch through SNMP queries andtrap notifications.

GET, POST, PATCH,HEAD, OPTIONS

brocade-supportlink Allows you to display the existing SupportLink configuration,enable support link, and configure SupportLink.


brocade-time Allows you to configure the time zone and clock server. GET, PATCH, HEAD,OPTIONS

brocade-zone A data model for configuring zones and retrieving operationalzoning information.


Table 21: FOS REST API Modules for Brocade Extension Features


brocade-extension Allows you to view information about Brocade extensionobjects as well as configure traffic control lists.

GET, POST, PATCH,HEAD, OPTIONS

brocade-extension-ip-interface Allows you to manage the Brocade Extension IP interface. GET, POST, PATCH,DELETE, HEAD,OPTIONS

brocade-extension-ip-route Allows you to retrieve or configure IP route information. GET, POST, PATCH,DELETE, HEAD,OPTIONS

brocade-extension-ipsec-policy Allows you to retrieve or configure the IP security (IPsec)policies on a switch or director.


brocade-interface/portchannel Allows you to view and configure port channel interfaces onthe switch.


brocade-extension-tunnel Allows you to manage Brocade extension tunnels. GET, POST, PATCH,DELETE, HEAD,OPTIONS

brocade-interface/gigabitethernet Allows you to retrieve or configure Gigabit Ethernet interfacesor Gigabit Ethernet interface statistics for a switch or director.


NOTEThis document does not address specific pattern or keyword requirements for individual leafs. Refer to theindividual .yang files for explicit details on these aspects of the modules.


Broadcom


FOS REST API Modules for OperationsThis section details the REST RPC support for the operations modules. This section also provides examples for using theoperations modules.

brocade-operation-device-managementThis module enables you to test the reachability of an HBA device.

Module Tree

This is the tree view of the module from the brocade-operation-device-management.yang-tree.txt file. See YANG ModuleOverview for YANG node field definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-operation-device-management

rpcs:

+---x device-management

+---w input

| +---w device {fibrechannel:fibrechannel_switch_platform}?

| +---w n-port-wwn? fibrechannel:wwn-type

| +---w n-port-id? fibrechannel:fcid-hex-string-type

| +---w version? uint8

| +---w payload? string

+--ro output

+--ro device {fibrechannel:fibrechannel_switch_platform}?

+--ro n-port-wwn? fibrechannel:wwn-type

+--ro n-port-id? fibrechannel:fcid-hex-string-type

+--ro version? uint8

+--ro payload? string

URI Format

The URI format for this module takes the following form:

• <base_URI>/operations/device-management to test the reachability of an HBA device.

Parametersdevice-management

Description: The RPC command definition for Brocade device management operations.Flag: read-writeOptional: NoThis container has the following leafs:input

Description: The input parameters used for the device management operations.Flag: writeOptional: NoThis list has the following leafs:


Broadcom


deviceDescription: The HBA device query parameters for the device management operations. Notethat the Fibre Channel switch Native mode must be supported.Flag: writeOptional: NoThis list has the following leafs:n-port-wwn

Description: The port world wide name (PWWN) of the specified device.Flag: writeType: fibrechannel:wwn-typeValue: The port world wide name.Optional: No

versionDescription: The HBA registers with this version identifier. The switch handles therequests only if the input version is registered/supported by the device. The devicereturns the supported version in the response.Flag: writeType: uint8Value: The version identifier.Optional: No

payloadDescription: The opaque payload and response buffer in base64 format.Flag: writeType: stringValue: The payload.Optional: No

outputDescription: The response from the device management operations.Flag: readOptional: NoThis list has the following leafs:device

Description: The HBA device queried for the device management operations. Theswitch must be an FC switch in Native mode.Flag: readOptional: NoThis list has the following leafs:n-port-wwn

Description: The port world wide name (PWWN) of the specified device.Flag: readType: fibrechannel:wwn-typeValue: The port world wide name.Optional: No

versionDescription: The supported HBA version identifier.Flag: readType: uint8Value: The supported HBA version identifier.Optional: No


Broadcom


payloadDescription: The opaque payload and response buffer in base64 format.Flag: readType: stringValue: The opaque payload and response buffer in base64 format.Optional: No

Supported Methods

The POST and OPTIONS operations are supported in this module.

Examples

This section provides a basic example for using the brocade-operation-device-management module.

Testing the Reachability of an HBA Device

This example uses a POST request to ping the HBA device.

Structure

POST <base_URI>/operations/device-management

URI

POST https://10.10.10.10/rest/operations/device-management

Request Body

{

"device":

{

"n-port-wwn": "10:00:00:10:9b:56:ff:e3",

"n-port-id": "0x2ba300",

"version": 1,

"payload": "JAAAAOLscXYBAAIAAQACAAIAAQADAAQAAAAAAGQABAAIAAAA"

}

}

Response Body

{

"Response": {

"device": {

"payload": "LAAAAOLscXYBAAIAAQACAAIAAQADAAQAAAAAAAQABAAAAAAAZAAEAAkAAAA=",

"n-port-wwn": "10:00:00:10:9b:56:ff:e3",

"n-port-id": "0x2ba300",

"version": 1

}

}

}


Broadcom


History

Release Version History

Fabric OS 9.0.0 This API call was introduced.


Broadcom


brocade-operation-extensionThis module provides REST RPC support on an extension platform to either clear or default the extension configurationfor a switch or a blade. You can also reset the global LAN statistics on a data processor.

Module Tree

This is the tree view of the module from the brocade-operation-extension.yang-tree.txt file. See YANG Module Overviewfor YANG node field definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-operation-extension

rpcs:

+---x extension

+---w input

| +---w extension-operation-parameters {fibrechannel:fibrechannel_extension_platform}?

| +---w slot? uint16

| +---w config-clear? boolean

| +---w config-default? boolean

| +---w global-lan-statistics-reset? boolean

| +---w dp-id? extension:dp-id-type

+--ro output

+--ro extension-operation-status {fibrechannel:fibrechannel_extension_platform}?

+--ro status-message? string

URI Format


• <base_URI>/operations/extension to clear a configuration, reset to the default configuration, or reset the globalLAN statistics on a data processor for extension devices.

Parametersextension

Description: The top-level container for this module.Flag: writeOptional: NoThis list has the following leafs:input

Description: The RPC command definition for extension operation on a Brocade switch.Flag: writeOptional: NoThis list has the following leafs:extension-operation-parameters

Description: The extension operation input container. Note that extension operations aresupported only on Brocade extension platforms.Flag: writeOptional: No

slotDescription: The slot number of the data path processor.Flag: write


Broadcom


Type: uint16Value: The slot number of the data path processor.Optional: No

config-clearDescription: Clears the configuration on an extension switch or blade. Note that the config-clearoperation may be disruptive. This parameter is only configurable when the config-default andglobal-lan-statistics-reset parameters are set to false.For extension switches, you must reboot the switch after the config-clear operation; otherwise,config operations are blocked.For extension blades, you must power off the blade before you clear the slot's correspondingconfiguration.Flag: writeType: booleanValue:false: No operation.true: Clears the configuration on the extension device.Optional: No

config-defaultDescription: Resets the default configuration on the extension switch or blade. Note that theconfig-default operation may be disruptive. This parameter is only configurable when the config-clear and global-lan-statistics-reset parameters are set to false.For extension switches, the exentsion switch reboots automatically after a successful config-default operation.For exentsion blades, make sure the blade is in an online state for the config-default operation.You may need to power on and off the blade slot to apply different extension modes correctly.Flag: writeType: booleanValue:false: No operation.true: Resets the default configuration on the extension device.Optional: No

global-lan-statistics-resetDescription: Resets the global LAN statistics on a data processor (DP). This parameter is onlyconfigurable when the config-clear and config-default parameters are set to false.Flag: writeType: booleanValue:false: No operation.true: Resets the global LAN statistics on a DP.Optional: No

dp-idDescription: The extension data path processor ID. Depending on the extension platform, thedevice may have a single DP or dual DP. A single DP supports DP0 only. A dual DP supportsboth DP0 and DP1. This parameter is only configurable when the global-lan-statistics-resetparameter is set to true.Flag: writeType: extension:dp-id-typeValue:0: DP01: DP1Optional: No


Broadcom


outputDescription: The response from the extension operation.Flag: read-onlyOptional: NoThis list has the following leafs:extension-operation-status

Description: The status of the extension operation. Note that extension operations are supportedonly on Brocade extension platforms.Flag: readOptional: NoThis list has the following leafs:status-message

Description: The status message (success or fail).Flag: read-onlyType: stringValue: The status message (success or fail).Optional: No

Supported Methods


Examples

This section provides basic examples for using the brocade-operation-extension module.

Clearing the Configuration on an Extension Device

This example uses a POST request to clear the configuration on an extension device. This parameter is only configurablewhen the config-default and global-lan-statistics-reset parameters are set to false.

Note that the config-clear operation may be disruptive. For extension switches, you must reboot the switch after theconfig-clear operation; otherwise, config operations are blocked. For extension blades, you must power off the bladebefore you clear the slot's corresponding configuration.

Structure

POST <base_URI>/operations/extension

URI

POST https://10.10.10.10/rest/operations/extension

Request Body

<extension-operation-parameters>

<slot>0</slot>

<config-clear>true</config-clear>

</extension-operation-parameters>

Response Body


<Response>

<extension-operation-status>


Broadcom


<status-message>Operation Succeeded.</status-message>

</extension-operation-status>

</Response>

Resetting an Extension Device to the Default Configuration

This example uses a POST request to reset an extension device to the default configuration.

Note that the config-default operation is a disruptive operation. For exentsion switches, the exentsion switch rebootsautomatically after a successful config-default operation. For exentsion blades, make sure the blade is in an online statefor the config-default operation. You may need to power on and off the blade slot to apply different extension modescorrectly.

Structure


URI


Request Body


<slot>0</slot>

<config-default>true</config-default>


Response Body


<Response>




</Response>

Resetting the Global LAN Statistics on a Data Processor

This example uses a POST request to reset the global LAN statistics on a data processor. Depending on the extensionplatform, the device may have a single DP or dual DP. A single DP supports DP0 only. A dual DP supports both DP0 andDP1. This parameter is only configurable when the global-lan-statistics-reset parameter is set to true.

Structure


URI


Request Body



Broadcom


<slot>0</slot>

<dp-id>0</dp-id>

<global-lan-statistics-reset>true</global-lan-statistics-reset>


Response Body


<Response>




</Response>

History




Broadcom


brocade-operation-fabricThis module enables you to initiate a fabric build.

Module Tree

This is the tree view of the module from the brocade-operation-fabric.yang-tree.txt file. See YANG Module Overview forYANG node field definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-operation-fabric

rpcs:

+---x fibrechannel-fabric

+---w input

+---w fabric-operation-parameters {fibrechannel:fibrechannel_switch_platform}?

+---w build-fabric? boolean

URI Format


• <base_URI>/operations/fibrechannel-fabric to initiate a fabric build.

Parametersbrocade-operation-fabric

Description: The top-level container for this module.Flag: read-writeOptional: NoThis container has the following leafs:fibrechannel-fabric

Description: The RPC command definition for fabric operation.Flag: writeOptional: NoThis list has the following leafs:input

Description: The input container to perform fabric-related operations.Flag: writeOptional: NoThis list has the following leafs:fabric-operation-parameters

Flag: writeOptional: NoThis list has the following leafs:build-fabric

Description: Initiates the build fabric operation. The switch must be enabled.Flag: writeType: booleanValue:false: No operation.true: Builds the fabric.


Broadcom


Optional: No

Supported Methods


Examples

This section provides a basic example for using the brocade-operation-fabric module.

Initiating a Fabric Build

This example uses a POST request to initiate a fabric build.

Structure

POST <base_URI>/operations/fibrechannel-fabric

URI

POST https://10.10.10.10/rest/operations/fibrechannel-fabric

Request Body

<fabric-operation-parameters>

<build-fabric>true</build-fabric>

</fabric-operation-parameters>

Response Body

When the operation is successful, the response has an empty message body and a “204 No Content” status message.

History




Broadcom


brocade-operation-firmwaredownloadThis module enables you to download and activate firmware from a remote host. You can configure thefirmware download to a secondary partition only without rebooting and activation. You can also display, accept, or declinethe End User License Agreement (EULA).

Module Tree

This is the tree view of the module from the brocade-operation-firmwaredownload.yang-tree.txt file. See YANG ModuleOverview for YANG node field definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-operation-firmwaredownload

rpcs

+---x firmwaredownload

+---w input

| +---w firmwaredownload-parameters

| +---w eula-action? operation-types:eula-action-type

| +---w host? inet:host

| +---w user-name? string

| +---w password? string

| +---w remote-directory? string

| +---w protocol? operation-types:protocol

| +---w port? uint32

| +---w stage? boolean

| +---w activate? boolean

+--ro output

+--ro show-status

+--ro message-id? message-id-type

+--ro operation? string

+--ro status? string

+--ro application-name? string

+--ro percentage-complete? uint8

+--ro firmwaredownload

+--ro message* string

+--ro eula-text? string

URI Format


• <base_URI>/operations/firmwaredownload to configure firmware download.

Parametersbrocade-operation-firmwaredownload

Description: The top-level container for firmware download.Flag: read-writeOptional: NoThis container has the following leafs:firmwaredownload

Description: The RPC command definition to trigger the firmwaredownload operation.


Broadcom


Flag: writeOptional: NoThis list has the following leafs:input

Description: The firmwaredownload operation input container.Flag: writeOptional: NoThis list has the following leafs:firmwaredownload-parameters

Description: The firmwaredownload operation input parameters container.Flag: writeOptional: NoThis list has the following leafs:eula-action

Description: The End User License Agreement (EULA). Note that the firmwaredownload process requires that you accept the EULA.Flag: writeType: operation-types:eula-action-typeValue: The valid values are accept-eula, decline-eula, and display-eula.Optional: No

hostDescription: The IPv4 or IPv6 address or host name for the remote server.Flag: writeType: inet:hostValue: A valid IPv4 or IPv6 address or host name for the remote server.Optional: No

user-nameDescription: The user name for the remote server that is used to copy thefirmware download files.Flag: writeType: stringValue: The user name for the remote server that is used to copy the firmwaredownload files.Optional: No

passwordDescription: The password for the remote server used to copy the firmwaredownload files. The password should be base64 encoded. Refer to RFC 3414.Flag: writeType: stringValue: The password for the remote server used to copy the firmwaredownloadfiles.Optional: No

remote-directoryDescription: The fully qualified path to the remote server directory from which totransfer the firmware download.Flag: writeType: stringValue: The fully qualified path to the remote server directory.Optional: No


Broadcom


protocolDescription: The file transfer protocol.Flag: writeType: operation-types:protocolValue: The file transfer protocol. The values are ftp (File Transfer Protocol), scp(Secure Copy Protocol), sftp (Secure FTP), or http (HyperText Transfer Protocol).Optional: Yes

portDescription: The user-defined port number for the specified file transfer protocol(scp, sftp, or http).Flag: writeType: uint32Value: The user-defined port number for the specified file transfer protocol (scp,sftp, or http).Optional: Yes

stageDescription: Whether to download firmware to a secondary partition only withoutrebooting and activation.Flag: writeType: booleanValue: true: Downloads the firmware to a secondary partition. false: Does notdownload the firmware to a secondary partition.Optional: Yes

activateDescription: Whether to activate firmware.Flag: writeType: booleanValue: true: Activates the firmware. false: Does not activate the firmware.Optional: No

outputDescription: The firmware download operation status container.Flag: read-onlyOptional: NoThis container has the following leafs:show-status

Description: The status of the firmware download.Flag: read-onlyOptional: NoThis list has the following leafs:message-id

Description: The message-id which is required to retrieve the associatedoperation status.Flag: read-onlyType: message-id-typeValue: The message-id.Optional: No

operationDescription: The operation name (firmwaredownload).Flag: read-onlyType: string


Broadcom


Value: The operation name (firmwaredownload).Optional: No

statusDescription: The state of the firmware download operation.Flag: read-onlyType: stringValue: When you start the firmware download, the status is queued. While thefirmware download is running, the status is in progress. When the firmwaredownload is complete, it moves to the completed status.Optional: No

application-nameDescription: The name of the application used to trigger the operation. This isparsed from the HTTP USER_AGENT standard header.Flag: read-onlyType: stringValue: The name of the application used to trigger the operation.Optional: No

percentage-completeDescription: The firmware download percentage complete.Flag: read-onlyType: uint8Value: The firmware download percentage complete.Optional: No

firmwaredownloadDescription: A list of firmware download status messages or the EULA.Flag: read-onlyOptional: NoThis list has the following leafs:message

Description: The status messages, detailing all stages of the firmwaredownload progress.Flag: read-onlyType: stringValue: The firmware download status messages.Optional: No

eula-textDescription: The contents of latest EULA (Brocade End User LicenseAgreement).Flag: read-onlyType: stringValue: The contents of latest EULA.Optional: No

Supported Methods

The OPTIONS and POST operations are supported in this module.

Examples

This section provides basic examples for using the brocade-operation-firmwaredownload module.


Broadcom


Downloading Firmware

This example uses a POST request to download firmware using the Secure Copy Protocol (scp). Note that the firmwaredownload process requires that you accept the EULA.

Structure

POST <base_URI>/operations/firmwaredownload

URI

POST https://10.10.10.10/rest/operations/firmwaredownload

Request Body

<firmwaredownload-parameters>

<eula-action>accept-eula</eula-action>

<protocol>scp</protocol>

<host>10.11.11.11</host>

<remote-directory>/home/sa023564/GGTEST</remote-directory>

<user-name>gumbeaux</user-name>

<password>AZ8byCXdweVfu</password>

<port>22</port>

</firmwaredownload-parameters>

Response Body


<Response>

<show-status>

<message-id>20000</message-id>

<status>queued</status>

<application-name>Mozilla/5.0 (Windows NT 10.0; Win64; x64</application-name>

<percentage-complete>0</percentage-complete>

<operation>firmwaredownload</operation>

<firmwaredownload>

<message>Firmwaredownload sanity check in-progress.</message>

</firmwaredownload>

</show-status>

</Response>

Downloading Firmware Using HTTP

This example uses a POST request to download firmware using the HTTP protocol. Note that the firmware downloadprocess requires that you accept the EULA.

Structure

POST base_URI/operations/firmwaredownload

URI


Request Body



Broadcom



<protocol>http</protocol>

<host>10.11.11.11</host>



<password>AZ8byCXdweVfu</password>

<port>8000</port>


Response Body


<Response>

<show-status>






<firmwaredownload>


</firmwaredownload>

</show-status>

</Response>

Viewing the EULA

This example uses a POST request to view the End User License Agreement (EULA).

Structure

POST base_URI/operations/firmwaredownload/eula-action/display-eula

URI

POST https://10.10.10.10/rest/operations/firmwaredownload/eula-action/display-eula

Request Body

This is no request body.

Response Body


<Response>

<text>

*EULA contents*

</text>

</Response>

Checking the Status of a Firmware Download

This example uses a POST request to check the status of the firmware download.

Structure


Broadcom


POST base_URI/operations/firmwaredownload/show-status/message-id/20000

URI

POST https://10.10.10.10/rest/running/brocade-operation-firmwaredownload/show-status/message-id/20000

Request Body

This is no request body.

Response Body


<Response>

<show-status>






<firmwaredownload>


</firmwaredownload>

</show-status>

</Response>

Staging a Firmware Download

This example uses a POST request to stage a firmware download.

Structure


URI


Request Body




<host>10.11.11.11</host>


<user-name>sa023564</user-name>

<password>TZ8nbWVpbkAx</password>

<stage>true</stage>


Response Body



Broadcom


<Response>

<show-status>






<firmwaredownload>


</firmwaredownload>

</show-status>

</Response>

Activating Firmware

This example uses a POST request to download firmware.

Structure


URI


Request Body


<activate>true</activate>


Response Body


<Response>

<show-status>






<firmwaredownload>


</firmwaredownload>

</show-status>

</Response>

History




Broadcom


brocade-operation-licenseThis module enables you to install or remove a license on a Brocade switch.

Module Tree

This is the tree view of the module from the brocade-operation-license.yang-tree.txt file. See YANG Module Overview forYANG node field definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-operation-license

rpcs:

+---x license

+---w input

| +---w license-parameters

| +---w name? string

| +---w action? enumeration

| +---w license-payload? string





| +---w protocol? operation-types:protocol


+--ro output

+--ro license-operation-status

+--ro status-message? string

URI Format


• <base_URI>/operations/license to install or remove a license on a Brocade switch.

Parameterslicense

Description: The top-level container for the brocade-operation-license module.Flag: read-writeOptional: NoThis container has the following leafs:input

Description: The license input container.Flag: writeOptional: NoThis list has the following leafs:license-parameters

Description: The license parameters container.Flag: writeOptional: NoThis list has the following leafs:


Broadcom


nameDescription: The license key or serial number. The license key is a string with alphanumeric characters (for example, 'HP9ttZNSgmB4MCD3NmNWgQDWtAKBFtXtBSFJF').The license serial number is a string with the following format 'FOS-XX-X-XX-XXXXXXXX' (for example, 'FOS-00-0-02-11201234').Note that this leaf is not included when you install the licenses with a serial number froma file.Flag: writeType: stringValue: The license key or serial number.Optional: No

actionDescription: Install or remove the specified license. Flag: writeType: enumerationValue: Valid values include: install: Installs the specified license. remove: Removes thespecified license.Optional: No

license-payloadDescription: Send the entire license certificate content. The license certificate contentmust be base64-encoded (refer to RFC 3414). This parameter is applicable only whenyou are installing a license using the entire license certificate content. Flag: writeType: stringValue: The entire license certificate content.Optional: No

hostDescription: The IP address or hostname of the remote server. This parameter isapplicable only when you are installing a license using an XML file. Flag: writeType: inet:hostValue: The IP address or hostname of the remote server.Optional: No

user-nameDescription: The username for the remote server that is used to copy the licensecertificates. This parameter is applicable only when you are installing a license using anXML file.Flag: writeType: stringValue: The username for the remote serverOptional: No

passwordDescription: The password for the remote server used to copy the license certificate.The password must be base64-encoded (refer to RFC 3414). This parameter isapplicable only when you are installing a license using an XML file.Flag: writeType: stringValue: The password for the remote server .Optional: No


Broadcom




remote-directoryDescription: The file path to the remote server from which the license certificate istransferred. This parameter is applicable only when you are installing a license using anXML file.Flag: writeType: stringValue: The file path to the remote server.Optional: No

protocolDescription: The transport protocol. This parameter is applicable only when you areinstalling a license using an XML file.Flag: writeType: operation-types:protocolValue: Values include scp (Secure Copy Protocol) or sftp (Secure FTP).Optional: No

portDescription: The user-defined port number for scp (Secure Copy Protocol) or sftp(Secure FTP). This parameter is applicable only when you are installing a license usingan XML file.Flag: writeType: uint32Value: The user-defined port number.Optional: No

outputDescription: The license output container.Flag: readOptional: NoThis list has the following leaf:status-message

Description: The status message. This message provides information to perform anyadditional actions needed, such as reboot, port, switch, or chassis disable or enable, forthe license to take effect.Flag: readType: stringValue: The status message.Optional:

Supported Methods


Examples

This section provides a basic example for using the brocade-operation-license module.

Installing a License Using an XML File

This example uses a POST request to install a license using an XML file on a Brocade switch.

NOTEYou must use this method to install a license on a Gen 7 platform.

Structure


Broadcom


POST <base_URI>/operations/license

URI

POST https://10.10.10.10/rest/operations/license

Request Body

<license-parameters>

<action>install</action>

<host>10.10.10.25</host>

<user-name>adminaccount</user-name>

<password>xxxxxxxxxx</password>

<remote-directory>/var/ftp/pub/private/ab123456/lc/lc_10_20190503.xml</remote-directory>


</license-parameters>

Response Body


<Response>


<status-message>License Install success</status-message>


</Response>

Installing a License Using a License Key

This example uses a POST request to install a license key on a Brocade switch.

NOTEYou must use this method to install a license on a Gen 6 platform.

Structure


URI


Request Body


<action>install</action>

<name>RRmtMRGYg4MZ9EPHaWaGgBCHBtCEaDCLBAQYH</name>


Response Body


<Response>



Broadcom


<status-message>For license change to take effect, please reboot the switch now...</status-message>


</Response>

Removing a License From a Gen 7 Platform

This example uses a POST request to remove a license from a Gen 7 platform.

Structure


URI


Request Body


<action>remove</action>

<name>FOS-01-0-03-11201003</name>


Response Body


<Response>


<status-message>License Remove success</status-message>


</Response>

Removing a License From a Gen 6 Platform

This example uses a POST request to remove a license from a Brocade switch.

Structure


URI


Request Body


<action>remove</action>

<name>RRmtMRGYg4MZ9EPHaWaGgBCHBtCEaDCLBAQYH</name>


Response Body



Broadcom


<Response>


<status-message>For license change to take effect, please reboot the switch now...</status-message>


</Response>

History



Fabric OS 9.0.0a This API was modified to add the license-payload parameter.


Broadcom


brocade-operation-lldpThis module enables you to clear an LLDP neighbor or reset the LLDP statistics.

Module Tree

This is the tree view of the module from the brocade-operation-lldp.yang-tree.txt file. See YANG Module Overview forYANG node field definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-operation-lldp

rpcs:

+---x lldp

+---w input

+---w lldp-operations {fibrechannel:fibrechannel_chassis_platform or

fibrechannel:fibrechannel_extension_platform}?

+---w slot-port? fibrechannel:slot-port-name-type

+---w action? enumeration

URI Format


• <base_URI>operations/lldp to to clear an LLDP neighbor or reset the LLDP statistics.

Parameterslldp

Description: The top-level container for the brocade-operation-lldp module.Flag: writeOptional: NoThis container has the following leafs:input

Description: The LLDP input request container.Flag: writeOptional: NoThis list has the following leafs:lldp-operations

Description: The LLDP request container. The switch must be an FC director or an Extensionswitch in Native mode.Flag: writeOptional: NoThis list has the following leafs:slot-port

Description: The slot and port number on which you want to clear the LLDP neighbordetails or reset the LLDP-related statistics.Flag: writeType: fibrechannel:slot-port-name-typeValue: The slot and port number of the specified port in the format slot/port.Optional: No


Broadcom


actionDescription: Clears the LLDP neighbor or resets the LLDP statitics for the specified port.Flag: writeType: enumerationValue: clear-neighbor = Clear the LLDP neighbor details for the specified port.reset-statistics = Reset the LLDP-related statistics for the specified port.Optional: No

Supported Methods


Examples

This section provides a basic example for using the brocade-operation-lldp module.

Clearing an LLDP Neighbor

This example uses a POST request to clear the LLDP neighbor details for a specified port.

Structure

POST base_URI/operations/lldp

URI

POST https://10.10.10.10/rest/operations/lldp

Request Body

<lldp-operations>

<slot-port>0/3</slot-port>

<action>clear-neighbor</action>

</lldp-operations>

Response Body


Resetting LLDP Statistics

This example uses a POST request to reset the LLDP statistics for a specified port.

Structure

POST base_URI/operations/lldp

URI

POST https://10.10.10.10/rest/operations/lldp

Request Body

<lldp-operations>


<action>reset-statistics</action>

</lldp-operations>


Broadcom


Response Body

When the statistics are successfully reset, the response contains an empty message body and a "204 No Content" statusin the headers.

History




Broadcom


brocade-operation-pcie-healthThis module enables you to test the Peripheral Component Interconnect express (PCIe) links between the non-transparent ports of the PCIe switch in the blades and the standby CP.

Module Tree

This is the tree view of the module from the brocade-operation-pcie-health.yang-tree.txt file. See YANG Module Overviewfor YANG node field definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-operation-pcie-health

rpcs:

+---x pcie-health-test

+---w input

| +---w slot-test {fibrechannel:fibrechannel_chassis_platform}?

| +---w slot-id? uint8

+--ro output

+--ro slot-test* []

+--ro slot-id? uint8


URI Format


• <base_URI>/operations/pcie-health-test to test the PCIe links.

Parametersbrocade-operation-pcie-health

Description: The top-level container for the PCIe health test.Flag: read-writeOptional: NoThis container has the following leafs:pcie-health-test

Description: The RPC command definition for Brocade PCIe health operations.Flag: read-writeOptional: NoThis container has the following leafs:input

Description: The input container for the PCIe health test.Optional: NoThis container has the following leafs:slot-test

Description: The input parameters for the PCIe health slot health test. This test is onlysupported on Director platforms.Flag: writeOptional: No


Broadcom


slot-idDescription: The physical slot number in the chassis where the blade is inserted. Avalue of 255 specifies all slots in the chassis.Flag: writeType: uint8Value: The physical slot number in the chassis where the blade is inserted.Optional: No

outputDescription: The output container for the PCIe health test.Flag: read-onlyOptional: NoThis container has the following leafs:slot-test

Description: The response parameters for the PCIe slot health test.Flag: read-onlyOptional: Noslot-id

Description: The physical slot number in the chassis where the blade isinserted.Flag: read-onlyType: uint8Value: The physical slot number in the chassis where the blade is inserted.Optional: No

statusDescription: The status (success or failed) of the PCIe test on the specifiedphysical slot number.Flag: read-onlyType: stringValue: The status (success or failed) of the PCIe test on the specified physicalslot number.Optional: No

Supported Methods

The OPTIONS and POST operations are supported in this module.

Examples

This section provides a basic example for using the brocade-operation-pcie-health module.

Testing the PCIe Links

This example uses a POST request to test the Peripheral Component Interconnect express (PCIe) links between the non-transparent ports of the PCIe switch in the blades and the standby CP.

Structure

POST base_URI/operations/pcie-health-test

URI

POST https://10.10.10.10/rest/operations/pcie-health-test

Request Body


Broadcom


<slot-test>

<slot-id>255</slot-id>

</slot-test>

Response Body


<Response>

<slot-test>


<status>SUCCESS.</status>

</slot-test>

<slot-test>



</slot-test>

<slot-test>



</slot-test>

<slot-test>



</slot-test>

</Response>

History




Broadcom


brocade-operation-show-statusThis module enables you to obtain the status of any REST operation.

Module Tree

This is the tree view of the module from the brocade-operation-show-status.yang-tree.txt file. See YANG Module Overviewfor YANG node field definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-operation-show-status

+---x show-status

+---w input

| +---w message-id operation:message-id-type

+--ro output

+--ro show-status






+--ro firmwaredownload?



URI Format


<base_URI>/operations/show-status/message-id/message-id followed by the leafs as listed in module treeto obtain the status of any REST operation (where message-id is the message ID generated when you initiated the RESToperation).

Parametersshow-status

Description: The show status container.Flag: read-onlyThis container has the following leafs:input

Description: The show status request container.Flag: read-writeThis container has the following leaf:message-id

Description: The message ID associated with the REST operation.Flag: read-onlyType: operation:message-id-typeValue: A valid message ID.Optional: Yes

OutputDescription: The operation status container.Flag: read-onlyThis container has the following leafs:


Broadcom


show-statusDescription: The operation status based on the specified message ID.Flag: read-onlyThis list has the following leafs:message-id

Description: The message ID associated with the REST operation.Flag: read-onlyType: operation:message-id-typeValue: A message ID.Optional: Yes

operationDescription: The operation (such as supportSave).Flag: read-onlyType: stringValue: The operation (such as supportSave).Optional: Yes

statusDescription: The exact state of the REST operation. When the operation is triggered,it is added to the queue. The operation then goes into the in-progress status until theoperation is complete. Once the operation is complete, the status moves to done, then todelivered until it is purged from the database. If any operational-level or application-levelerror occurs, the status shows an error or application-error status respectively.Flag: read-onlyType: stringValue: The status of the REST operation (queued, in-progress, done, delivered, error,purge, and application-error).Optional: Yes

application-nameDescription: The name of the application that triggered the REST operation.Flag: read-onlyType: stringValue: The name of the application that triggered the REST operation.Optional: Yes

percentage-completeDescription: The percentage complete of the operation.Flag: read-onlyType: uint8Value: 0 to 100.Optional: Yes

firmwaredownloadDescription: A list of firmware download status messages or the EULA.Flag: read-onlyType: stringValue: The firmware download status messages, depicting all stages of firmwaredownload progress.Optional: YesThis list contains the following leafs:message

Description: A list of firmware download status messages.Flag: read-only


Broadcom


Type: stringValue: The firmware download status messages, depicting all stages of firmwaredownload progress.Optional: Yes

eula-textDescription: The contents of the latest Brocade End User License Agreement(EULA).Flag: read-onlyType: stringValue: The latest Brocade EULA.Optional: Yes

Supported Methods

Only the POST operation is supported in this module.

ExamplesViewing the supportSave StatusThe following example uses the POST request to obtain the status of a supportSave operation.StructurePOST <base_URI>/operations/show-status/message-id/message-id (where message-id is the message IDgenerated when you initiated the supportSave operation)URIPOST https://10.10.10.10/rest/operations/show-status/message-id/99767053

Request BodyThere is no request body.Response Body


<Response>

<show-status>


<status>progress</status>

<application-name>PostmanRuntime/6.1.6</application-name>

<perentage-complete>35</perentage-complete>

<operation>supportsave</operation>

</show-status>

</Response>

History



Fabric OS 9.0.0 Added the firmware download status and EULA text parameters.


Broadcom


brocade-operation-supportlinkThis module enables you to initiate Support Link data collection on the switch, upload data to the Support Link server, andreset the Support Link client to default values.

Module Tree

This is the tree view of the module from the brocade-operation-supportlink.yang-tree.txt file. See YANG Module Overviewfor YANG node field definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-operation-supportlink

rpcs:

+---x supportlink

+---w input

+---w supportlink

+---w action? enumeration

URI Format


• <base_URI>/operations/supportlink to reset all Support Link values to their defaults, collect data in the localswitch, and upload data to the ASC Gateway.

Parameterssupportlink

Description: The top-level container for this module.Flag: read-writeOptional: NoThis container has the following leafs:input

Description: The Support Link input container.Flag: writeOptional: NoThis list has the following leafs:supportlink

Description: The RPC command definition to trigger the supportLinkProfile operation.Flag: writeOptional: NoThis list has the following leafs:action

Description: The Support Link action (default, collect, or send) to be performed.Flag: writeType: enumerationValue: default = Resets all Support Link values to their defaults. collect = Collects datain the local switch. send = Uploads data to Support Link server.Optional: No


Broadcom


Supported Methods


Examples

This section provides a basic examples for using the brocade-operation-supportlink module.

Resetting the Support Link Values to Defaults

This example uses a POST request to reset the Support Link values to defaults on the specified switch.

Structure

POST base_URI/operations/supportlink

URI

POST https://10.10.10.10/rest/operations/supportlink

Request Body

<supportlink>

<action>display</action>

</supportlink>

Response Body

When the operation is successful, the response contains an empty message body and a “204 No Content” status appearsin the header.

Collecting Support Link Data

This example uses a POST request to collect Support Link data from the specified switch.

Structure

POST base_URI/operations/supportlink/action/collect

URI

POST https://10.10.10.10/rest/operations/supportlink/action/collect

Request Body

<supportlink>

<action>collect</action>

</supportlink>

Response Body


Uploading Support Link Data

This example uses a POST request to upload Support Link data from the specified switch.

Structure

POST base_URI/operations/supportlink


Broadcom


URI

POST https://10.10.10.10/rest/operations/supportlink

Request Body

<supportlink>

<action>send</action>

</supportlink>

Response Body


History




Broadcom


brocade-operation-supportsaveThis module enables you to initiate supportSave and obtain the message ID of the supportSave operation.

Module Tree

This is the tree view of the module from the brocade-operation-supportsave.yang-tree.txt file. See YANG ModuleOverview for YANG node field definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-operation-supportsave

rpcs:

+---x supportsave

+---w input

| +---w connection





| +---w protocol? string

| +---w serial-mode? boolean


+--ro output

+--ro show-status






+--ro firmwaredownload



URI Format


<base_URI>/operations/supportsave to initiate supportSave.

Parametersrpc supportsave

Description: The module container.Flag: read-writeThis container has the following leafs:input

Description: The supportSave input operation container.Flag: read-writeThis container has the following leafs:connection

Description: The supportSave input operation connection container.


Broadcom


Flag: read-writeThis container has the following leafs:host

Description: The IPv4 or IPv6 address or host name for the remote server.Flag: read-writeType: inet:hostValue: A valid IPv4 or IPv6 address or host name for the remote server.Optional: Yes

user-nameDescription: The user name of the remote server that is used to copy the supportSavefiles.Flag: read-writeType: stringValue: A valid user name.Optional: Yes

passwordDescription: The password for the remote server used to copy the supportSave files.Flag: read-writeType: stringValue: A valid password in base64-encoded format.Optional: Yes

remote-directoryDescription: The remote server directory to which the files are to be transferred.Flag: read-writeType: stringValue: A valid remote server directory.Optional: Yes

protocolDescription: The transfer protocol.Flag: read-writeType: stringValue: scp = Secure Copy Protocol. ftp = File Transfer Protocol. sftp = Secure FTP.Optional: Yes

serial-modeDescription: The legacy serial-mode module supportsave collection.Flag: read-writeType: booleanValue: true = The supportSave process is completed serially module by module. false =The supportSave process is completed in parallel for multiple modules.Optional: Yes

portDescription: The user-defined port number for SCP or SFTP. You cannot configure theport number for FTP.Flag: read-writeType: uint32Value: Enter the port number (1 through 65535) to be used for SCP or SFTP.Optional: Yes

outputDescription: The supportSave output container.


Broadcom


Flag: read-onlyThis container has the following leafs:show-status

Description: The supportSave return status container.Flag: read-onlyThis list has the following leafs:message-id

Description: The random-generated message ID associated with the supportSaveoperation. The message ID is required to retrieve the supportSave status using thesupport-status operation.Flag: read-onlyType: operation:message-id-typeValue: A message ID.Optional: Yes

operationDescription: The operation (such as supportSave).Flag: read-onlyType: stringValue: The operation (such as supportSave).Optional: Yes

statusDescription: The exact state of the supportSave operation. When supportSave istriggered, it is added to the queue. The supportSave operation then goes into the in-progress status until all supportSave files are transferred to the remote server. Once thesupportSave operation is complete, the status moves to done, then to delivered until it ispurged from the database. If any supportSave operational-level or application-level erroroccurs, the status shows an error or application-error status respectively.Flag: read-onlyType: stringValue: The status of the supportSave operation (such as queued, in-progress, done,delivered, error, purge, and application-error).Optional: Yes

application-nameDescription: The name of the application that triggered the supportSave operation.Flag: read-onlyType: stringValue: The name of the application that triggered the supportSave operation.Optional: Yes

percentage-completeDescription: The percentage complete of the operation.Flag: read-onlyType: uint8Value: 0 to 100.Optional: Yes

firmwaredownloadDescription: A list of firmware download status messages or the EULA.Flag: read-onlyType: stringValue: The firmware download status messages, depicting all stages of firmwaredownload progress.


Broadcom


Optional: YesThis list contains the following leafs:message

Description: A list of firmware download status messages.Flag: read-onlyType: stringValue: The firmware download status messages, depicting all stages of firmwaredownload progress.Optional: Yes

eula-textDescription: The contents of the latest Brocade End User License Agreement(EULA).Flag: read-onlyType: stringValue: The latest Brocade EULA.Optional: Yes

Supported Methods

Only the OPTIONS and POST operations are supported in this module.

ExamplesInitiating supportSaveThe following example uses the POST request to initiate supportSave on a switch.StructurePOST <base_URI>/operations/supportsaveURIPOST https://10.10.10.10/rest/operations/supportsave

Request Body

<connection>


<host>10.10.10.10</host>

<port>123</port>

<remote-directory>/supportsave/test</remote-directory>


<password>aZByc3xdwdV=</password>

</connection>

Response Body


<Response>

<show-status>



<application-name>PostmanRuntime/6.1.6</application-name>

<operation>supportsave</operation>


Broadcom



</show-status>

</Response>

History



Fabric OS 8.2.2 Added the port parameter to set the SCP or SFTP port number.

Fabric OS 9.0.0 Added the firmware download status, serial-mode, and EULA text parameters.


Broadcom


brocade-operation-zoneThis module enables you to perform zone-related operations.

Module Tree

This is the tree view of the module from the brocade-operation-zone.yang-tree.txt file. See YANG Module Overview forYANG node field definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-operation-zone

rpcs:

+---x fibrechannel-zone

+---w input

+---w zone-operation-parameters* [] {fibrechannel:fibrechannel_switch_platform}?

+---w action? zone-operation-action-type

+---w zone-object? zone:zone-member-type

URI Format


• <base_URI>/operations/fibrechannel-zone to perform zone-related operations.

Parametersfibrechannel-zone

Description: The RPC command definition for zone operations. The top-level container for this module.Flag: read-writeOptional: NoThis container has the following leafs:input

Description: The input container to perform zone-related operations.Flag: writeOptional: NoThis list has the following leafs:zone-operation-parameters

Description: A list of parameters that specifies what type of zone operations to perform. Theswitch must be an FC switch in Native mode.Flag: writeOptional: NoThis list has the following leafs:action

Description: The zone action operation to perform.Flag: writeType: zone-operation-action-typeValue: expunge = Expunges a zone object. In addition to deleting the object, expungealso removes the object from the member lists of all other objects. You can performexpunge operations on configurations, zones, aliases, WWNs, or 'D,I' members. Expungestages the modifications in the defined-configuration. For the staged modifications to


Broadcom


become persistent, you must save the changes using one of the following brocade-zonemodule leafs that reside under the effective-configuration container:'cfg-action': Specify '1' to save the pending changes.'cfg-name': Specify the name of configuration to become enabled.It is recommended that you save the changes within the configured fabric-lock-timeoutduration specified in the brocade-fibrechannel-configuration module under the zone-configuration container.Optional: No

zone-objectDescription: The zone object (WWN, domain,index, zone configuration, or zone alias) onwhich to perform the RPC zone action. This parameter is applicable only when the actionis expunge (../action = 'expunge').Flag: writeType: zone:zone-member-typeValue: A valid WWN, domain,index, zone configuration, or zone alias.Optional: No

Supported Methods


Examples

This section provides a basic example for using the brocade-operation-zone module.

Expunging a Zone Alias

This example uses a POST request to expunge a zone alias (ali30).

Structure

POST base_URI/operations/fibrechannel-zone

URI

POST https://10.10.10.10/rest/operations/fibrechannel-zone

Request Body

<zone-operation-parameters>

<action>ali30</action>

<zone-object>expunge</zone-object>

</zone-operation-parameters>

Response Body


History




Broadcom


FOS REST API Modules for Fibre Channel FeaturesThis section details the REST API support for Fibre Channel modules. This section also provides examples for using theFibre Channel modules.

brocade-access-gatewayThis module provides a detailed view of configuration and runtime information of the Access Gateway (AG).

It assumes a knowledge of the Access Gateway as performed in Fabric OS. For information on that topic, refer to theBrocade Fabric OS Access Gateway User Guide.

NOTEThe brocade-access-gateway module is supported in Fabric OS 8.2.0a and later.

Module Tree

This is the tree view of the module from the brocade-access-gateway.yang-tree.txt file. See YANG ModuleOverview for YANG node field definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-access-gateway

+--rw brocade-access-gateway

+--rw port-group* [port-group-id] {fibrechannel:access_gateway_platform}?

| +--rw port-group-id uint8

| +--rw port-group-name? string

| +--rw port-group-n-ports

| | +--rw n-port* fibrechannel:slot-port-name-type

| +--rw port-group-f-ports

| | +--rw f-port* fibrechannel:slot-port-name-type

| +--rw port-group-mode

| +--rw load-balancing-mode-enabled? uint8

| +--rw multiple-fabric-name-monitoring-mode-enabled? uint8

+--rw n-port-map* [n-port] {fibrechannel:access_gateway_platform}?

| +--rw n-port fibrechannel:slot-port-name-type

| +--rw failover-enabled? uint8

| +--rw failback-enabled? uint8

| +--ro online-status? uint8

| +--ro reliable-status? int8

| +--ro n-port-info

| | +--ro attached-fabric-name? fibrechannel:wwn-type

| | +--ro attached-port-wwn? fibrechannel:wwn-type

| | +--ro n-port-fcid? fibrechannel:fcid-hex-string-type

| | +--ro attached-switch-user-friendly-name? string

| | +--ro attached-switch-f-port? fibrechannel:slot-port-name-type

| | +--ro attached-switch-ip-address? inet:ip-address

| +--rw configured-f-port-list


| +--rw static-f-port-list


| +--rw preferred-f-ports

| +--rw preferred-f-port* fibrechannel:slot-port-name-type

+--ro f-port-list* [f-port] {fibrechannel:access_gateway_platform}?


Broadcom


| +--ro f-port fibrechannel:slot-port-name-type

| +--ro online-status? uint8

| +--ro f-port-info

| +--ro n-port? fibrechannel:slot-port-name-type

| +--ro login-exceeded? uint8

+--rw policy {fibrechannel:access_gateway_platform}?

| +--rw port-group-policy-enabled? uint8

| +--rw auto-policy-enabled? uint8

+--rw n-port-settings {fibrechannel:access_gateway_platform}?

| +--rw reliability-counter? yang:zero-based-counter64

+--ro device-list* [wwn] {fibrechannel:access_gateway_platform}?

+--ro wwn fibrechannel:wwn-type

+--ro fcid? fibrechannel:fcid-hex-string-type

+--ro f-port? fibrechannel:slot-port-name-type

+--ro n-port? fibrechannel:slot-port-name-type

URI Format

The URI format for this module takes the following forms:

• <base_URI>/running/brocade-access-gateway/ followed by the leafs as listed in the module tree.

• <base_URI>/running/brocade-access-gateway/n-port-map to configure N_Port mapping.

• <base_URI>/running/brocade-access-gateway/port-group to configure port groups.

• <base_URI>/running/brocade-access-gateway/f-port-list to view F_Port information.

• <base_URI>/running/brocade-access-gateway/policy to enable port group or auto policy.

• <base_URI>/running/brocade-access-gateway/n-port-settings to configure the reliability counter.

• <base_URI>/running/brocade-access-gateway/device-list to view a list of devices logged on to the AccessGateway switch and the device mapping with the F_Port, N_Port, and Fibre Channel ID (FCID).

• <base_URI>/running/brocade-interface/fibrechannel/name/fibre-channel-interface-name/n-port-enabled to configure a port to operate as an N_Port.

• <base_URI>/running/brocade-fibrechannel-switch/fibrechannel-switch/name/switch-worldwide-name/ag-mode to determine if the switch is in Access Gateway mode or to configure the Access Gatewaymode on the switch.

Parametersbrocade-access-gateway

Description: The top-level container for this module displays the configuration and runtime information of theAccess Gateway. The Fibre Channel switch must be in Access Gateway mode.Flag: read-writeThis container has the following leafs:port-group

Description: The port group configuration. The port group defines a set of N_Ports to be included in thePort Grouping policy. The factory default port group is "0", which includes all N_Ports. The default portgroup cannot be removed or renamed. This parameter is only available when the Port Grouping policy isenabled (port-group-policy-enabled = 1).Flag: read-write


Broadcom


Key: port-group-idThis list has the following leafs:port-group-id

Description: The port group ID. The maximum number of port groups that can be created isequal to the total number of ports available on the given platform. For instance, on a 64-portplatform, there can be 64 port groups with the port-group ID ranging from 0 to 63.Flag: read-writeType: uint8Value: 0 to the maximum number of ports available on the given platform.Optional: Yes

port-group-nameDescription: The port group name.Flag: read-writeType: stringValue: 1 to 64 alphanumeric characters. The name must be alphanumeric. The default port groupname uses the format pg<port-group-id>.Optional: Yes

port-group-n-portsDescription: List of N_Ports that are in the port group.Flag: read-writeThis container has the following leaf:n-port

Description: List of N_Ports that are in the port group. The port group must contain atleast one N_Port.Flag: read-writeType: fibrechannel:slot-port-name-typeValue: The slot and port number of the specified port in the format slot/port.Optional: Yes

port-group-f-portsDescription: List of F_Ports that are in the port group. This parameter is only available whenload-balancing mode is enabled (load-balancing-mode-enabled = 1) for the port group.Flag: read-writeThis container has the following leaf:f-port

Description: List of F_Ports that are in the port group. To update the configuration, youmust enable load-balancing mode for the port group.Flag: read-writeType: fibrechannel:slot-port-name-typeValue: The slot and port number of the specified port in the format slot/port.Optional: Yes

port-group-modeDescription: The mode configured for the port group.Flag: read-writeThis container has the following leafs:load-balancing-mode-enabled

Description: Enables or disables load-balancing mode for the specified port group.Flag: read-writeType: uint8


Broadcom


Values: 0 = Load-balancing mode disabled. 1 = Load-balancing mode enabled. Default:0.Optional: Yes

multiple-fabric-name-monitoring-mode-enabledDescription: Enables or disables multiple fabric name monitor mode for the specifiedport group.Flag: read-writeType: uint8Values: 0 = Multiple fabric name monitor mode disabled. 1 = Multiple fabric namemonitor mode enabled. Default: 0.Optional: Yes

n-port-mapDescription: Defines the N_Port to F_Port mappings. The Fibre Channel switch must be in AccessGateway mode.Flag: read-writeKey: n-portThis container has the following leafs:n-port

Description: Enables mapping F_Ports to an N_Port.Flag: read-writeType: fibrechannel:slot-port-name-typeValue: The slot and port number of the specified port in the format slot/port.Optional: Yes

failover-enabledDescription: Enables or disables failover for an N_Port.Flag: read-writeType: uint8Values: 0 = Failover disabled. 1 = Failover enabled.Optional: Yes

failback-enabledDescription: Enables or disables failback for an N_Port.Flag: read-writeType: uint8Value: 0 = Failback disabled. 1 = Failback enabled.Optional: Yes

online-statusDescription: Whether the N_Port is online or offline.Flag: read-onlyType: uint8Config: falseValues: 0 = Offline. 1 = Online.Optional: Yes

reliable-statusDescription: The reliable status of the N_Port. This parameter is only available when thereliability counter is enabled (reliability-counter ! = 0).Flag: read-onlyType: uint8Config: falseValues: 0 = Unreliable. 1 = Reliable. -1 = Not applicable.Optional: Yes


Broadcom


n-port-infoDescription: The N_Port logon information and the attached switch details. This parameter is onlyavailable when the port is online (online-status = 1).Config: falseThis container has the following leafs:attached-fabric-name

Description: The WWN of the fabric attached to the N_Port.Flag: read-onlyType: fibrechannel:wwn-typeValue: A valid WWN name.Optional: Yes

attached-port-wwnDescription: The WWN of the port attached to the N_Port.Flag: read-onlyType: fibrechannel:wwn-typeValue: A valid WWN name.Optional: Yes

n-port-fcidDescription: The FCID of the N_Port.Flag: read-onlyType: fibrechannel:fcid-typeValue: A valid destination FCID value.Optional: Yes

attached-switch-user-friendly-nameDescription: The ASCII name assigned to the switch by the administrator.Flag: read-onlyType: stringValue: 1 to 30 alphanumeric characters plus hyphens, periods, and underscores. Spaces arenot allowed. A switch name can begin with a letter or number, but a switch name that begins witha numeric character (0-9) must also have at least an underscore (_), hyphen (-), period (.), oralphabetic character (A-Z, a-z). A switch name with only numeric characters is not valid.Optional: Yes

attached-switch-f-portDescription: The fabric switch port number of the port attached to the N_Port.Flag: read-onlyType: fibrechannel:slot-port-name-typeValue: The slot and port number of the specified port in the format slot/port.Optional: Yes

attached-switch-ip-addressDescription: The out-of-band IP address of the attached switch.Flag: read-onlyType: inet:ip-addressValue: A valid IPv4 or IPv6 address.Optional: Yes

configured-f-port-listDescription: The F_Port to N_Port mappings.Flag: read-writeThis container has the following leaf:


Broadcom


f-portDescription: List of F_Ports that are mapped to the N_Port. There must be at least one F_Portmapped to an N_Port. Once you enable Access Gateway mode in the switch, F_Ports aremapped to the default N_Port. You must clear the existing mapping before you map an F_Port toanother N_Port. Note that configured and static port mapping cannot overlap.Flag: read-writeType: fibrechannel:slot-port-name-typeValue: The slot and port number of the specified port in the format slot/port.Optional: Yes

static-f-port-listDescription: The static F_Port to N_Port mappings.Flag: read-writeThis container has the following leaf:f-port

Description: A list of F_Ports that are statically mapped to the N_Port. There must be at leastone F_Port statically mapped to an N_Port. Note that configured and static port mapping cannotoverlap.Flag: read-writeType: fibrechannel:slot-port-name-typeValue: The slot and port number of the specified port in the format slot/port.Optional: Yes

preferred-f-portsDescription: The preferred F_Port to N_Port mappings. Note that configured and preferred portmappings cannot overlap.Flag: read-writeThis container has the following leaf:preferred-f-port

Description: A list of F_Ports for which this port is a secondary N_Port. If the N-port to whichthe F_Port is mapped, via the configured F_Port, is offline then the F_Port uses this N_Port(secondary N_Port) to login. The list can be empty when the N_Port is not mapped as asecondary N_Port for any F_Port.Flag: read-writeType: fibrechannel:slot-port-name-typeValue: An F_Port for which this port is a secondary N_Port.Optional: Yes

f-port-listDescription: A list of all F_Ports present on the Access Gateway. The Fibre Channel switch must be inAccess Gateway mode.Flag: read-onlyKey: f-portConfig: falseThis container has the following leafs:f-port

Description: The F_Port for which information is being fetched.Flag: read-onlyType: fibrechannel:slot-port-name-typeValue: The slot and port number of the specified port in the format slot/port.Optional: Yes

online-statusDescription: Whether the F_Port is online or offline.


Broadcom


Flag: read-onlyType: uint8Config: falseValues: 0 = Offline. 1 = Online.Optional: Yes

f-port-infoDescription: The F_Port login information. This parameter is only available when the port isonline (online-status = 1).Flag: read-onlyConfig: falseThis container has the following leafs:n-port

Description: The N_Port to which this F_Port is mapped.Flag: read-onlyType: fibrechannel:slot-port-name-typeValue: The slot and port number of the specified port in the format slot/port.Optional: Yes

login-exceededDescription: The login exceeded state of the F_Port.Flag: read-onlyType: uint8Values: 0 = Login limit not exceeded. 1 = Login limit exceeded.Optional: Yes

policyDescription: The Access Gateway policy configuration. To enable or disable any of the AG policies, theswitch must be in a disabled state. The Fibre Channel switch must be in Access Gateway mode.Flag: read-writeThis container has the following leafs:port-group-policy-enabled

Description: Enables or disables the port group policy. Note that the auto policy must bedisabled (auto-policy-enabled = 0). To modify the policy configuration, the switch must be in adisabled state.Flag: read-writeType: uint8Values: 0 = Disabled. 1 = Enabled.Optional: Yes

auto-policy-enabledDescription: Enables or disables the auto policy. Note that the port group policy must bedisabled (port-group-policy-enabled = 0). To modify the policy configuration, the switch must be ina disabled state.Flag: read-writeType: uint8Values: 0 = Disabled. 1 = Enabled.Optional: Yes

n-port-settingsDescription: The N_Port-related configuration parameters. Note that the port group policy must beenabled (port-group-policy-enabled = 1). The Fibre Channel switch must be in Access Gateway mode.Flag: read-writeThis container has the following leaf:


Broadcom


reliability-counterDescription: The reliability counter configuration for N_Ports.Flag: read-writeType: yang:zero-based-counter64Values: 0 = Disabled. 10–100 Enabled.Optional: Yes

device-listDescription: A list of devices logged on to the Access Gateway and their F_Port, N_Port, and FCIDmapping. The Fibre Channel switch must be in Access Gateway mode.Key: wwnFlag: read-onlyConfig: falseThis container has the following leafs:wwn

Description: The port world wide name of the connected device.Flag: read-onlyType: fibrechannel:wwn-typeValues: A valid port WWN name.Optional: Yes

fcidDescription: The fibre channel ID (FCID) of the connected device.Flag: read-onlyType: fibrechannel:fcid-hex-string-typeValues: A vaild FCID in hexadecimal format.Optional: Yes

f-portDescription: The F_Port to which the device is connected.Flag: read-onlyType: fibrechannel:slot-port-name-typeValues: The slot and port number of the specified port in the format slot/port.Optional: Yes

n-portDescription: The N_Port through which the device logged on.Flag: read-onlyType: fibrechannel:slot-port-name-typeValues: The slot and port number of the specified port in the format slot/port.Optional: Yes

Supported Methods

Only the OPTIONS, GET, PATCH, DELETE, HEAD, and POST operations are supported in this module.

ExamplesViewing the Access Gateway ModeYou use a GET request to determine the Access Gateway mode of the switch. There are three possiblemodes:

• 0: Access Gateway mode is not supported by this switch.• 1: Access Gateway mode is supported and currently disabled on this switch.• 3: Access Gateway mode is supported and currently enabled on this switch.


Broadcom


You must use a PATCH request to enable or disable Access Gateway mode on a switch. The followingexample uses the GET request to determine the Access Gateway mode of the switch.StructureGET <base_URI>/running/brocade-switch/fibrechannel-switch/name/switch-worldwide-name/ag-modeURIGET https://10.10.10.10/rest/running/brocade-switch/fibrechannel-switch/

name/10:10:10:eb:1a:b7:77:bc/ag-mode

Request BodyNo request body is required.Response BodyWhen the operation is successful, the response has a message body similar to the following, and a “200 OK”status in the headers.


<Response>


<name>10:10:10:eb:1a:b7:77:bc</name>



</Response>

Enabling Access Gateway Mode on a Switch

NOTEYou must disable the switch before you change the Access Gateway mode on a switch.

You must use a PATCH request to enable or disable the Access Gateway mode on a switch. You use a GETrequest to determine the Access Gateway mode of the switch. There are three possible modes:

• 0: Access Gateway mode is not supported by this switch.• 1: Access Gateway mode is supported and currently disabled on this switch.• 3: Access Gateway mode is supported and currently enabled on this switch.

The following example uses the PATCH request to enable Access Gateway mode on a switch.StructurePATCH <base_URI>/running/brocade-switch/fibrechannel-switch/name/fibre-channel-interface-name/ag-mode/modeURI

PATCH https://10.10.10.10/rest/running/brocade-switch/fibrechannel-switch/

name/10:10:10:eb:1a:b7:77:bc/ag-mode/3

Request BodyNo request body is required.Response BodyWhen the operation is successful, the response contains an empty message body and a “204 No Content”status appears in the header.


Broadcom


Viewing All Port Groups on the Access GatewayThe following example uses the GET request to retrieve the details for all port groups on the Access Gateway(AG).StructureGET <base_URI>/running/brocade-access-gateway/port-groupURIGET https://10.10.10.10/rest/running/brocade-access-gateway/port-group



<Response>

<port-group>

<port-group-id>0</port-group-id>

<port-group-name>pg0</port-group-name>

<port-group-n-ports>

<n-port>0/16</n-port>








</port-group-n-ports>

<port-group-f-ports>

<f-port>0/0</f-port>
















</port-group-f-ports>

<port-group-mode>

<load-balancing-mode-enabled>0</load-balancing-mode-enabled>


Broadcom


<multiple-fabric-name-monitoring-mode-enabled>0</multiple-fabric-name-monitoring-mode-

enabled>

</port-group-mode>

</port-group>

</Response>

Viewing Port InformationThe following example uses the GET request to retrieve the port mapping information for N_Ports and F_Portsin the Access Gateway.StructureGET <base_URI>/running/brocade-access-gateway/n-port-mapURIGET https://10.10.10.10/rest/running/brocade-access-gateway/n-port-map

Request BodyNo request body is required.Response BodyWhen the operation is successful, the response has a message body similar to the following, and a “200 OK”status in the headers.<?xml version="1.0"?>

<Response>

<n-port-map>


<failover-enabled>1</failover-enabled>

<failback-enabled>1</failback-enabled>

<online-status>0</online-status>

<reliable-status>1</reliable-status>

<n-port-info/>

<configured-f-port-list>



</configured-f-port-list>

<static-f-port-list/>

<preferred-f-ports/>

</n-port-map>

...

<n-port-map>






<n-port-info>

<attached-fabric-name>10:00:88:94:71:42:7b:d5</attached-fabric-name>

<attached-port-wwn>20:00:88:94:71:42:7b:d5</attached-port-wwn>

<n-port-fcid>0xed0000</n-port-fcid>

<attached-switch-user-friendly-name>66-237_B7810_A-Wing</attached-switch-user-friendly-

name>


Broadcom


<attached-switch-f-port>0/0</attached-switch-f-port>

<attached-switch-ip-address>10.38.66.237</attached-switch-ip-address>

</n-port-info>






<preferred-f-ports/>

</n-port-map>

</Response>

Creating a New Port GroupThe following example uses the POST request to create a new port group "pg1" with two N_Ports.StructurePOST <base_URI>/running/brocade-access-gateway/port-group/port-group-id/port-group-idURIPOST https://10.10.10.10/rest/running/brocade-access-gateway/port-group/port-group-id/1

Request Body





Response BodyWhen the operation is successful, the response contains an empty message body and a “201 Created” statusappears in the header.Adding an N_Port to a Port GroupThe following example uses the POST request to add a new N_Port "0/42" to an existing port group "pg1".StructurePOST <base_URI>/running/brocade-access-gateway/port-group/port-group-id/port-group-idURIPOST https://10.10.10.10/rest/running/brocade-access-gateway/port-group/port-group-id/1

Request Body




Response BodyWhen the operation is successful, the response contains an empty message body and a “201 Created” statusappears in the header.


Broadcom


Adding an F_Port to a Port GroupThe following example uses the POST request to add two new F_Ports to an existing port group "pg1". Notethat you can only add F-ports to a port-group when load-balancing mode is enabled (load-balancing-mode-enabled = 1).StructurePOST <base_URI>/running/brocade-access-gateway/port-group/port-group-id/port-group-idURIPOST https://10.10.10.10/rest/running/brocade-access-gateway/port-group/port-group-id/1

Request Body





Response BodyWhen the operation is successful, the response contains an empty message body and a “201 Created” statusappears in the header.Enabling Load-Balancing Mode on a Port GroupThe following example uses the PATCH request to enable load-balancing mode on port group "pg1".StructurePATCH <base_URI>/running/brocade-access-gateway/port-group/port-group-id/port-group-id/port-group-mode/port-group-modeURI

PATCH https://10.10.10.10/rest/running/brocade-access-gateway/port-group/port-group-id/1/port-

group-mode/

Request Body

<port-group-mode>

<load-balancing-mode-enabled>1</load-balancing-mode-enabled>

</port-group-mode>

Response BodyWhen the operation is successful, the response contains an empty message body and a “204 No Content”status appears in the header.Enabling Multiple Fabric Name Monitor Mode on a Port GroupThe following example uses the PATCH request to enable multiple fabric name monitor mode on port group"pg1".StructurePATCH <base_URI>/running/brocade-access-gateway/port-group/port-group-id/port-group-id/port-group-mode/


Broadcom


URIPATCH https://10.10.10.10/rest/running/brocade-access-gateway/port-group/port-group-id/1/port-

group-mode/

Request Body

<port-group-mode>

<multiple-fabric-name-monitoring-mode-enabled>1</multiple-fabric-name-monitoring-mode-enabled>

</port-group-mode>

Response BodyWhen the operation is successful, the response contains an empty message body and a “204 No Content”status appears in the header.Deleting Ports From a Port GroupThe following example uses the DELETE request to delete F_Port 0/5 and N_Port 0/42 from port grouppg1. Note that you can only remove F-ports from a port-group when load-balancing mode is enabled (load-balancing-mode-enabled = 1).StructureDELETE <base_URI>/running/brocade-access-gateway/port-group/port-group-id/port-group-idURIDELETE https://10.10.10.10/rest/running/brocade-access-gateway/port-group/port-group-id/1

Request Body







Response BodyWhen the operation is successful, the response contains an empty message body and a “204 No Content”status appears in the header.Deleting a Port GroupThe following example uses the DELETE request to delete port group pg1.StructureDELETE <base_URI>/running/brocade-access-gateway/port-group/port-group-id/port-group-idURIDELETE https://10.10.10.10/rest/running/brocade-access-gateway/port-group/port-group-id/1

Request BodyNo request body is required.


Broadcom


Response BodyWhen the operation is successful, the response contains an empty message body and a “204 No Content”status appears in the header.Mapping an F_Port to an N_PortThe following example uses the PATCH request to map F_Ports 0/5 and 0/6 to N_Port 0/42.

NOTEThe port group policy must be enabled (port-group-policy-enabled = 1) to map F_Ports to anN_Port.

StructurePATCH <base_URI>/running/brocade-access-gateway/n-port-mapURIPATCH https://10.10.10.10/rest/running/brocade-access-gateway/n-port-map

Request Body

<n-port-map>






</n-port-map>

Response BodyWhen the operation is successful, the response contains an empty message body and a “204 No Content”status appears in the header.Deleting an F_Port From an N_Port MappingThe following example uses the DELETE request to remove the F_Port 0/6 to N_Port 0/42 mapping.StructureDELETE <base_URI>/running/brocade-access-gateway/n-port-mapURIDELETE https://10.10.10.10/rest/running/brocade-access-gateway/n-port-map

Request Body

<n-port-map>





</n-port-map>

Response BodyWhen the operation is successful, the response contains an empty message body and a “204 No Content”status appears in the header.


Broadcom


Viewing End Device InformationThe following example uses the GET request to retrieve the N_Port login information and the attached switchdetails.StructureGET <base_URI>/running/brocade-access-gateway/n-port-mapURIGET https://10.10.10.10/rest/running/brocade-access-gateway/n-port-map


<Response>

<n-port-map>






<n-port-info>

<attached-fabric-name>10:10:10:05:1e:ab:47:00</attached-fabric-name>

<attached-port-wwn>2f:03:c4:f5:7c:c4:da:25</attached-port-wwn>

<n-port-fcid>0xec1300</n-port-fcid>

<attached-switch-user-friendly-name>G610_066_236</attached-switch-user-friendly-name>



</n-port-info>

<configured-f-port-list/>


<preferred-f-port-list/>

</n-port-map>

<n-port-map>






<n-port-info>







</n-port-info>




Broadcom







</n-port-map>

<n-port-map>






<n-port-info>







</n-port-info>









</n-port-map>

<n-port-map>






<n-port-info>


<attached-port-wwn>20:1b:c4:f5:7c:c0:fd:5d</attached-port-wwn>

<n-port-fcid>0xeb1b00</n-port-fcid>




</n-port-info>

<configured-f-port-list/>



</n-port-map>

<n-port-map>







Broadcom


<n-port-info>


<attached-port-wwn>20:19:c4:f5:7c:00:c5:30</attached-port-wwn>

<n-port-fcid>0xe81900</n-port-fcid>




</n-port-info>












</n-port-map>

</Response>

Configuring an N_PortThe following example uses the PATCH request to configure port 0/45 to operate as an N_Port.StructurePATCH <base_URI>/running/brocade-interface/fibrechannel/name/fibre-channel-interface-name/n-port-enabled/1URIPATCH https://10.10.10.10/rest/running/brocade-interface/fibrechannel/name/0%2f45/n-port-enabled/1

Request BodyNo request body is required.Response BodyWhen the operation is successful, the response contains an empty message body and a “204 No Content”status appears in the header.Configuring the Reliability Counter for N_PortsThe following example uses the PATCH request to configure the reliability counter to 30.

NOTEThe port group policy must be enabled (port-group-policy-enabled = 1) to configure thereliability counter.

StructurePATCH <base_URI>/running/brocade-access-gateway/n-port-settings/reliability-counter/reliability-counter-value

URIPATCH https://10.10.10.10/rest/running/brocade-access-gateway/n-port-settings/reliability-

counter/30


Broadcom


Request BodyNo request body is required.Response BodyWhen the operation is successful, the response contains an empty message body and a “204 No Content”status appears in the header.Enabling Failover for an N_PortThe following example uses the PATCH request to enable failover for N_Port 0/40.StructurePATCH <base_URI>/running/brocade-access-gateway/n-port-mapURIPATCH https://10.10.10.10/rest/running/brocade-access-gateway/n-port-map

Request Body

<n-port-map>



</n-port-map>

Response BodyWhen the operation is successful, the response contains an empty message body and a “204 No Content”status appears in the header.Enabling Failback for an N_PortThe following example uses the PATCH request to enable failback for N_Port 0/42.StructurePATCH <base_URI>/running/brocade-access-gateway/n-port-mapURIPATCH https://10.10.10.10/rest/running/brocade-access-gateway/n-port-map

Request Body

<n-port-map>



</n-port-map>

Response BodyWhen the operation is successful, the response contains an empty message body and a “204 No Content”status appears in the header.Viewing the List of Devices Logged On to the Access Gateway SwitchThe following example uses a GET request to view a list of devices logged on to the Access Gateway switchand the device's mapping with the F_Port, N_Port, and FCID.


Broadcom


StructureGET <base_URI>/running/brocade-access-gateway/device-listURIGET https://10.10.10.10/rest/running/brocade-access-gateway/device-list



<Response>

<device-list>

<wwn>10:10:10:eb:1a:b7:77:bc</wwn>

<fcid>0x021002</fcid>



</device-list>

</Response>

History


Fabric OS 8.2.0a This API call was introduced.

Fabric OS 8.2.1 This API was modified to add the device-list parameter to the module.

Fabric OS 9.0.0 This API was modified to add the preferred-f-ports parameter to the n-port-map list.


Broadcom


brocade-chassisThis module provides a detailed view of configuration and runtime information of the Fabric OS switch or director.

Module Tree

This is the tree view of the module from the brocade-chassis.yang-tree.txt file. See YANG Module Overview for YANGnode field definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-chassis

+--rw brocade-chassis

+--rw chassis

| +--rw chassis-user-friendly-name? string

| +--ro chassis-wwn? fibrechannel:wwn-type

| +--ro license-id? fibrechannel:wwn-type

| +--ro manufacturer? fru:manufacturer-type

| x--ro part-number? fru:part-number-type

| +--ro serial-number? fru:serial-number-type

| +--ro max-blades-supported? uint16

| x--ro vendor-serial-number? string

| x--ro vendor-part-number? string

| x--ro vendor-revision-number? string

| +--ro product-name? string

| +--rw vf-enabled? boolean {fibrechannel:fibrechannel_switch_platform}?

| +--ro vf-supported? boolean {fibrechannel:fibrechannel_switch_platform}?

| +--rw fcr-enabled? boolean

| +--ro fcr-supported? boolean {fibrechannel:fibrechannel_switch_platform}?

| +--ro date? string

+--ro ha-status

+--ro active-cp? string

+--ro standby-cp? string

+--ro active-slot? uint16

+--ro standby-slot? uint16

+--ro recovery-type? string

+--ro standby-health? string

+--ro ha-enabled? boolean

+--ro heartbeat-up? boolean

+--ro ha-synchronized? boolean

URI Format

The URI format for this module takes the following forms:

• <base_URI>/running/brocade-chassis/chassis followed by the leafs as listed in the module tree to retrieveinformation about the chassis.

• <base_URI>/running/brocade-chassis/ha-status followed by the leafs as listed in the module tree to retrievethe detailed High Availability (HA) status.


Broadcom


Parametersbrocade-chassis

Description: The top-level container for this module that provides a detailed view of configuration and runtimeinformation of the chassis.Flag: read-writeThis container has the following leafs:chassis

Description: The complete details of the chassis.Flag: read-writeKey: <key>This list has the following leafs:chassis-user-friendly-name

Description: An ASCII name assigned to the switch chassis by the administrator. A chassisname must begin with a letter and can consist of letters, numbers, hyphens (-), and underscores(_). The name is not case-sensitive.NOTEIn FICON mode, the name is limited to 1 to 24 alphanumeric characters plus hyphens (-) andunderscores (_).Flag: read-writeType: stringValue: 1 to 31 alphanumeric characters plus hyphens (-) and underscores (_). A chassis namemust begin with a letter. Spaces are not allowed.Optional: Yes

chassis-wwnDescription: The WWN of the chassis.Flag: read-onlyType: fibrechannel:wwn-typeConfig: falseValue: A vaild WWN.Optional: Yes

license-idDescription: The WWN used to generate the license.Flag: read-onlyType: fibrechannel:wwn-typeConfig: falseValue: A vaild WWN.Optional: Yes

serial-numberDescription: A printable ASCII string that specifies the serial number of the chassis.Flag: read-onlyType: fru:serial-number-typeConfig: falseValue: 0 to 15 printable ASCII characters.Optional: Yes

manufacturerDescription: The manufacturer of the chassis.Flag: read-onlyType: fru:manufacturer-typeConfig: falseValue: 1 to 63 characters.


Broadcom


Optional: Yespart-number

Description: This parameter is deprecated. The part number for the physical element assignedby the manufacturer.Refer to the 'brocade-fru.yang'. Use the 'list wwn' and 'part-number' leafs instead.Flag: read-onlyType: fru:part-number-typeConfig: falseValue: 0 to 15 characters.Optional: Yes

max-blades-supportedDescription: The maximum number of blades that can fit in the physical chassis. This includesswitch, control processor, application, and core routing blades.Flag: read-onlyType: uint16Config: falseValue: 1 = 1 blade (fixed-port switch). 8 = 8 blades. 12 = 12 blades.Optional: Yes

vendor-serial-numberDescription: This parameter is deprecated. Refer to 'brocade-fru.yang'. Use the 'list wwn' and'vendor-serial-number' leafs instead. The serial number of the chassis assigned by the vendor.Flag: read-onlyType: stringConfig: falseValue: 0 to 20 characters.Optional: Yes

vendor-part-numberDescription: This parameter is deprecated. Refer to 'brocade-fru.yang'. Use the 'list wwn' and'vendor-part-number' leafs instead. The part number of the chassis assigned by the vendor.Flag: read-onlyType: stringConfig: falseValue: 0 to 20 characters.Optional: Yes

vendor-revision-numberDescription: This parameter is deprecated. Refer to 'brocade-fru.yang'. Use the 'list wwn' and'vendor-revision-number' leafs instead. The revision number of the chassis assigned by thevendor.Flag: read-onlyType: stringConfig: falseValue: 0 to 4 characters.Optional: Yes

product-nameDescription: The product name of the chassis.Flag: read-onlyType: stringConfig: falseValue: 1 to 255 characters.Optional: Yes


Broadcom


vf-enabledDescription: Whether Virtual Fabrics is enabled on the chassis.NOTEVirtual Fabrics requires that Fibre Channel switch native mode be supported.NOTEEnabling Virtual Fabrics is a disruptive operation that requires a reboot to take effect.Flag: read-writeType: booleanValue: true = Virtual Fabrics is enabled on the chassis. false = Virtual Fabrics is not enabled onthe chassis.Optional: Yes

vf-supportedDescription: Whether Virtual Fabrics is supported on the chassis.NOTEVirtual Fabrics requires that Fibre Channel switch native mode be supported.Flag: read-onlyType: booleanConfig: falseValue: true = Virtual Fabrics is supported on the chassis. false = Virtual Fabrics is not supportedon the chassis.Optional: Yes

fcr-enabledDescription: Enables or disables FCR. This parameter is available only when FCR is supported(fcr-supported = true).Flag: read-onlyType: booleanValue: true = Enables FCR. false = Disables FCR.Optional: Yes

fcr-supportedDescription: Whether FCR is supported on the chassis. The switch must be an FC switch inNative mode.Flag: read-onlyType: booleanConfig: falseValue: true = FCR is supported. false = FCR is not supported.Optional: Yes

dateDescription: The current date of the switch.Flag: read-onlyType: stringConfig: falseValue: standard IETF date-time outputOptional: Yes

ha-statusDescription: The control processor (CP) status, which includes the following information:• Local CP state (slot number and CP ID) and warm or cold• Remote CP state (slot number and CP ID)• High Availability (enabled or disabled)• Heartbeat (up or down)• Health of standby CP• HA synchronization status


Broadcom


Flag: read-onlyConfig: falseThis container has the following leafs:active-cp

Description: The ID of the active CP.Flag: read-onlyType: stringValue: cp0 or cp1Optional: Yes

standby-cpDescription: The ID of the standby CP.Flag: read-onlyType: stringValue: cp0 or cp1Optional: Yes

active-slotDescription: The slot number of the active CP.Flag: read-onlyType: uint16Value: 0 through 12Optional: Yes

standby-slotDescription: The slot number of the standby CP.Flag: read-onlyType: uint16Value: 0 through 12Optional: Yes

recovery-typeDescription: The recovery status of the switch.Flag: read-onlyType: stringValue: cold or warmOptional: Yes

standby-healthDescription: The health status of the standby CP.Flag: read-onlyType: stringValue: The health status of the standby CP.• healthy = The standby CP is running, and the background health diagnostic has notdetected any errors.• faulted = The standby CP is running, but the background health diagnostic hasdiscovered a problem with the blade. Check the logs to determine the appropriate action.Failover is disabled until the standby CP is repaired.• unknown = The standby CP health state is unknown because of one of the followingreasons: the standby CP does not exist, the heartbeat is down, or the Health Monitor hasdetected a configuration file error.• non-redundant = There is no standby CP.• not-available = The standby CP health status is not available.Optional: Yes


Broadcom


ha-enabledDescription: Whether High Availability (HA) is enabled or disabled.Flag: read-onlyType: booleanValue: true = HA is enabled. false = HA is disabled.Optional: Yes

heartbeat-upDescription: Whether the heartbeat to the standby CP is up or down.Flag: read-onlyType: booleanValue: true = The heartbeat to the standby CP is up. false = The heartbeat to thestandby CP is down.Optional: Yes

ha-synchronizedDescription: Whether HA is in a synchronized state. When HA is in a synchronized stateand a failover becomes necessary, it is nondisruptive.Flag: read-onlyType: booleanValue: true = HA is synchronized. false = HA is not synchronized.Optional: Yes

Supported Methods

Only the GET, PATCH, HEAD, and OPTIONS operations are supported in this module.

Viewing the Chassis DataThe following example uses the GET request to retrieve information about the chassis.StructureGET <base_URI>/running/brocade-chassis/chassisURIGET https://10.10.10.10/rest/running/brocade-chassis/chassis

Request BodyNo request body is required.Response Body


<Response>

<chassis>

<chassis-user-friendly-name>BrocadeX6-4</chassis-user-friendly-name>

<license-id>10:00:c4:f5:7c:4a:ac:6c</license-id>

<chassis-wwn>10:00:c4:f5:7c:4a:ac:eb</chassis-wwn>

<serial-number>EZB2520M004</serial-number>

<manufacturer>Brocade Communications Systems LLC</manufacturer>

<part-number>60-1003194-02</part-number>

<vf-enabled>false</vf-enabled>

<vf-supported>true</vf-supported>

<fcr-enabled>true</fcr-enabled>

<fcr-supported>true</fcr-supported>

<max-blades-supported>8</max-blades-supported>


Broadcom


<vendor-revision-number>25</vendor-revision-number>

<vendor-part-number>SLKWRM0000X4S</vendor-part-number>

<vendor-serial-number>123654</vendor-serial-number>

<product-name>x6-4</product-name>

<date>03/09/2020-15:24:02</date>

</chassis>

</Response>

Viewing the Chassis NameThe following example uses the GET request to view the administrator-assigned name of the chassis.StructureGET <base_URI>/running/brocade-chassis/chassis/chassis-user-friendly-nameURIGET https://10.10.10.10/rest/running/brocade-chassis/chassis/chassis-user-friendly-name



<Response>

<chassis>


</chassis>

</Response>

Viewing the Chassis World Wide NameThe following example uses the GET request to view the WWN the chassis.StructureGET <base_URI>/running/brocade-chassis/chassis/chassis-wwnURIGET https://10.10.10.10/rest/running/brocade-chassis/chassis/chassis-wwn



<Response>

<chassis>

<chassis-wwn>10:00:c1:f1:1c:1a:ac:eb</chassis-wwn>

</chassis>

</Response>


Broadcom


Enabling Virtual Fabrics on the ChassisThe following example uses the PATCH request to enable Virtual Fabrics on the chassis. To enable a specificVirtual Fabric, refer to the brocade-fibrechannel-logical-switch.

NOTEEnabling Virtual Fabrics on a chassis is a disruptive operation and the device automaticallyreboots after running this request.

StructurePATCH <base_URI>/running/brocade-chassis/chassis/vf-enabled/trueURIPATCH https://10.10.10.10/rest/running/brocade-chassis/chassis/vf-enabled/true

Request BodyNo request body is required.Response BodyWhen the operation is successful, the response contains an empty message body and a “204 No Content”status appears in the header.Viewing the High Availability StatusThe following example uses the GET request to view the High Availability (HA) status .StructureGET <base_URI>/running/brocade-chassis/ha-statusURIGET https://10.10.10.10/rest/running/brocade-chassis/ha-status

Request BodyNo request body is required.Response Body<?xml version="1.0"?>

<Response>

<ha-status>

<active-cp>cp0</active-cp>

<standby-cp>cp1</standby-cp>

<active-slot>1</active-slot>

<standby-slot>2</standby-slot>

<recovery-type>warm</recovery-type>

<standby-health>healthy</standby-health>

<ha-enabled>true</ha-enabled>

<heartbeat-up>true</heartbeat-up>

<ha-synchronized>true</ha-synchronized>

</ha-status>

</Response>

Determining if HA Is EnabledThe following example uses the GET request to determine the HA status of the switch.StructureGET <base_URI>/running/brocade-chassis/ha-status/ha-enabled


Broadcom


URIGET https://10.10.10.10/rest/running/brocade-chassis/ha-status/ha-enabled



<Response>

<ha-status>

<ha-enabled>true</ha-enabled>

</ha-status>

</Response>

Determining the HA Synchronized StatusThe following example uses the GET request to determine whether HA is synchronized between the activeand standby CPs.StructureGET <base_URI>/running/brocade-chassis/ha-status/ha-synchronizedURIGET https://10.10.10.10/rest/running/brocade-chassis/ha-status/ha-synchronized



<Response>

<ha-status>

<ha-synchronized>false</ha-synchronized>

</ha-status>

</Response>

History



Fabric OS 9.0.0 Added the following leafs: license-id, serial-number, fcr-enabled, and fcr-supported.Deprecated the following leafs:• part-number - Use brocade-fru/wwn/part-number instead.• vendor-serial-number - Use brocade-fru/wwn/vendor-serial-number instead.• vendor-part-number - Use brocade-fru/wwn/vendor-part-number instead.

• vendor-revision-number - Use brocade-fru/wwn/vendor-revision-number instead.


Broadcom


brocade-fabricThis module is used to retrieve information on the switches in a fabric. If virtual fabrics are enabled, the request caninclude a query parameter (vf-id) for the desired virtual fabric. If no query parameter is specified and virtual fabrics areenabled, then the default virtual fabric name is returned.

Module Tree

This is the tree view of the module from the brocade-fabric.yang-tree.txt file. See YANG Module Overview for YANG nodefield definitions and possible values, and see Supported Data Types for data type descriptions.module: brocade-fabric

+--ro brocade-fabric

+--ro fabric-switch* [name] {fibrechannel:fibrechannel_switch_platform}?

| +--ro name fibrechannel:wwn-type

| +--ro switch-user-friendly-name? string

| +--ro chassis-wwn? fibrechannel:wwn-type

| +--ro chassis-user-friendly-name? string

| +--ro domain-id? fibrechannel:domain-id-type

| +--ro principal? uint8

| x--ro fcid? fibrechannel:fcid-type

| +--ro fcid-hex? fibrechannel:fcid-hex-string-type

| +--ro ip-address? inet:ipv4-address

| +--ro fcip-address? inet:ipv4-address

| +--ro ipv6-address? inet:ipv6-address

| +--ro firmware-version? string

| x--ro path-count? uint32

+--ro access-gateway* [switch-wwn] {fibrechannel:fibrechannel_switch_platform}?

+--ro switch-wwn fibrechannel:wwn-type

+--ro user-friendly-name? string

+--ro firmware-version? string

+--ro ip-addresses

| +--ro ip-address* inet:ip-address

+--ro is-edge-ag? boolean

URI Format

The URI format for this module takes one of the following forms:

• <base_URI>/running/brocade-fabric/fabric-switch/ followed by the leafs as listed in the module tree toretrieve information on all the switches in a fabric.

• <base_URI>/running/brocade-fabric/fabric-switch/name/name followed by the leafs as listed in themodule tree to retrieve information on a specific switch in a fabric.

• <base_URI>/running/brocade-fabric/fabric-switch/access-gateway to view the Access Gatewaysettings.

Parameters

NOTEThe top-level container name changed from "fabric" to "brocade-fabric". The previous top-level container name"fabric" is still supported in this release. However, new features (9.0.0 or later) are not supported in the previoustop-level container name "fabric".


Broadcom


brocade-fabricDescription: Fabric state parameters. Requests are made using queries specifying the vf-id of the specificfabric. The switch must be an FC switch in Native mode.Flag: read-onlyOptional: NoThis container has the following leafs:fabric-switch

Description: The list of configured switches in the fabric. The switch must be an FC switch in Nativemode.Flag: read-onlyOptional: NoKey: nameThis container has the following leafs:name

Description: The Fibre Channel WWN of the switch.Flag: read-onlyType: fibrechannel:wwn-typeConfig: falseValue: A valid WWN name.Optional: No

switch-user-friendly-nameDescription: The ASCII name assigned to the switch by the administrator.Flag: read-onlyType: stringConfig: falseValue: 1 to 30 alphanumeric characters plus hyphens, periods, and underscore characters.Spaces are not allowed. A switch name can begin with either a letter or number, but a switchname that begins with a numeric (0-9) character must also have at least an underscore (_),hyphen (-), period (.) or alphabetic (A-Z, a-z) character. A switch name with only numericcharacters is not valid.Optional: Yes

chassis-wwnDescription: The chassis WWN.Flag: read-onlyType: fibrechannel:wwn-typeConfig: falseValue: A valid WWN name.Optional: Yes

chassis-user-friendly-nameDescription: The ASCII name assigned to the switch chassis by the administrator.Flag: read-onlyType: stringConfig: falseValue: 1 to 31 alphanumeric characters plus hyphens (-), periods (.), and underscore (_)characters. A chassis name must begin with a letter. Spaces are not allowed.Optional: Yes

domain-idDescription: The highest level in the three-level addressing hierarchy used in the Fibre Channeladdress identifier. A domain typically is associated with a single Fibre Channel switch.Flag: read-only


Broadcom


Type: fibrechannel:domain-id-typeConfig: falseValue: 1 through 239. Default: 1Optional: Yes

principalDescription: Indicates if this switch is the fabric's principal switch.Flag: read-onlyType: uint8Config: falseValue: 1 = This is the fabric's principal switch. 0 = This is not the fabric's principal switch.Optional: Yes

fcidDescription: This parameter is deprecated. Use the fcid-hex parameter. The destination FibreChannel ID (D_ID) of the switch (decimal format).Flag: read-onlyType: fibrechannel:fcid-typeConfig: falseValue: A valid destination FCID value.Optional: Yes

fcid-hexDescription: The destination Fibre Channel ID (D_ID) of the switch (hexadecimal format).Flag: read-onlyType: fibrechannel:fcid-hex-string-typeConfig: falseValue: A valid destination FCID value.Optional: Yes

ip-addressDescription: The IPv4 address for the switch.Flag: read-onlyType: inet:ipv4-addressConfig: falseValue: A valid IPv4 address.Optional: Yes

fcip-addressDescription: The IPv4 address the switch is using for Fibre Channel over IP.Flag: read-onlyType: inet:ipv4-addressConfig: falseValue: A valid IPv4 address.Optional: Yes

ipv6-addressDescription: The IPv6 address for the switch.Flag: read-onlyType: inet:ipv6-addressConfig: falseValue: A valid IPv6 address.Optional: Yes

firmware-versionDescription: A human-readable string identifying the firmware version running on the switch.Flag: read-only


Broadcom


Type: stringConfig: falseValue: A Brocade-defined 11-character string identifying the software release installed on theswitch.Optional: Yes

path-countDescription: This parameter is deprecated. Use the path-count parameter from the /brocade-fibrechannel-switch/topology-domain list instead. The number of paths available to each remotedomain.Flag: read-onlyType: uint32Value: 0 to 16.Optional: Yes

access-gatewayDescription: A list of all the Access Gateway devices connected to the fabric. Retrieve this list byquerying any switch that is part of the Fabric. The switch must be an FC switch in Native mode.Flag: read-onlyKey: switch-wwnConfig: falseOptional: NoThis list has the following leafs:switch-wwn

Description: The world wide name (WWN) of the connected Access Gateway.Flag: read-onlyType: fibrechannel:wwn-typeValue: A valid WWN.Optional: No

user-friendly-nameDescription: The ASCII name assigned to the Access Gateway by the administrator. 1 to 30alphanumeric characters plus hyphens, periods, and underscores. Spaces are not allowed. Aswitch name can begin with a letter or number, but a switch name that begins with a numericcharacter (0-9) must also have at least an underscore (_), hyphen (-), period (.), or alphabeticcharacter (A-Z, a-z). A switch name with only numeric characters is not valid.Flag: read-onlyType: stringValue: A printable ASCII String that specifies the name assigned to the Access Gateway by theadministratorOptional: Yes

firmware-versionDescription: A human readable string identifying the firmware version running on the AccessGateway switch.Flag: read-onlyType: stringValue: The firmware version running on the Access Gateway switch.Optional: Yes

ip-addressesDescription: A list of out-of-band IP addresses assigned to the Ethernet port on the AccessGateway.Flag: read-onlyOptional: No


Broadcom


This list has the following leaf:ip-address

Description: An out-of-band IP address assigned to the Ethernet port of the switch.Flag: read-onlyType: inet:ip-addressValue: A valid IP address.Optional: Yes

is-edge-agDescription: Whether the connected Access Gateway switch is a Core AG or Edge AG.Flag: read-onlyType: booleanValue: true = The device is an edge AG device. false = The device is not an edge AG device.Optional: Yes

Supported Methods

Only the GET, OPTIONS, and HEAD operations are supported in this module.

Examples

Comparable Fabric OS CLI commands include switchshow, fabricshow, wwn, chassisname, and ipaddrshow. Refer tothe Brocade Fabric OS Command Reference Manual for information and examples of these commands.

Retrieving Switch Information

This example uses a GET request to retrieve the switch information for a switch.

Structure

GET <base_URI>/running/brocade-fabric/fabric-switch

URI Request

GET https://10.10.10.10/rest/running/brocade-fabric/fabric-switch

Request Body


Response Body

When the operation is successful, the response has a message body similar to the following, and a “200 OK” status in theheaders.<?xml version="1.0"?>

<Response>

<fabric-switch>

<name>10:00:c4:f5:7c:4a:ac:6c</name>

<chassis-wwn>10:00:c1:f1:1c:1a:ac:ab</chassis-wwn>


<fcid>16776235</fcid>


<switch-user-friendly-name>66-243_X6-4_Venator</switch-user-friendly-name>






Broadcom


<ipv6-address>2620:100:4:fa01:c6f5:7cff:fe4a:ac6c</ipv6-address>


<path-count>0</path-count>

</fabric-switch>

...

<fabric-switch>

<name>10:00:c4:f5:7c:01:68:60</name>

<chassis-wwn>10:00:c4:f5:7c:01:68:9f</chassis-wwn>


<fcid>16776430</fcid>

<fcid-hex>0xfffcee</fcid-hex>

<switch-user-friendly-name>66-238_G720_Cassian</switch-user-friendly-name>

<chassis-user-friendly-name>G8000</chassis-user-friendly-name>




<ipv6-address>2620:100:4:fa01:c6f5:7cff:fe01:6860</ipv6-address>



</fabric-switch>

</Response>

Retrieving Switch Information From a Virtual Fabric

This example uses a GET request to retrieve the switch information for a switch in the virtual fabric with an VFID of 10.

Structure

GET <base_URI>/running/brocade-fabric/fabric-switch?vf-id=<vf-id#>

URI Request

GET https://10.10.10.10/rest/running/brocade-fabric/fabric-switch?vf-id=10

Request Body


Response Body


<Response>

<fabric-switch>

<name>10:10:14:15:1c:9e:3b:44</name>

<chassis-wwn>10:10:14:15:1c:9e:3c:aa</chassis-wwn>


<fcid>16776100</fcid>

<switch-user-friendly-name>G610_21</switch-user-friendly-name>

<chassis-user-friendly-name>BrocadeG610</chassis-user-friendly-name>

<firmware-version>v820</firmware-version>

<vf-id>1</vf-id>



<ipv6-address>::</ipv6-address>



Broadcom



</fabric-switch>

<fabric-switch>

<name>10:10:14:15:1c:a2:1f:40</name>

<chassis-wwn>10:10:14:15:1c:a2:1f:af</chassis-wwn>


<fcid>16776101</fcid>




<vf-id>1</vf-id>






</fabric-switch>

</Response>

Viewing Attached Access Gateway Switches

This example uses a GET request to view a list of the Access Gateway switches attached to the fabric in non-AccessGateway mode.

Structure

GET <base_URI>/running/brocade-fabric/access-gateway/switch-wwn/{switch-wwn}/

URI

GET https://10.10.10.10/rest/running/brocade-fabric/access-gateway/switch-wwn/10:00:10:10:10:1e:10:40

Request Body

The request body is not required.

Response Body


<Response>

<access-gateway>

<switch-wwn>10:00:10:10:10:1e:10:40</switch-wwn>

<user-friendly-name>66-62_G620_Wedge</user-friendly-name>

<ip-addresses>


<ip-address>2020:100:4:ff01:c2f2:7cff:fed2:9be3</ip-address>

</ip-addresses>


<is-edge-ag>false</is-edge-ag>

</access-gateway>

</Response>


Broadcom


History

Release version History


Fabric OS 8.2.1 Refined the switch-user-friendly-name and chassis-user-friendly-name regularexpressions. Increased the firmware-version length.

Fabric OS 8.2.1b The top-level container name changed from "fabric" to "brocade-fabric". The previous top-level container name "fabric" is still supported in this release.Added the path-count parameter.

Fabric OS 9.0.0 The path-count parameter is deprecated. Use the path-count parameter from the /brocade-fibrechannel/topology-domain list insteadAdded the access-gateway parameters.


Broadcom


brocade-fabric-traffic-controllerThe Fabric Traffic Controller (FTC) acts as a central point of processing to translate Fabric Performance Impacts(FPI) into notifications and signaling to end devices throughout the Fabric. The FTC uses signals and notifications tocommunicate the type and relative severity of impacting behaviors to the affected members of the Fabric. The FTCrecords information regarding diagnostic Extended Link Service (ELS) registration, FPI conditions, and related statistics;storing the information per device (per N_Port).

Module Tree

This is the tree view of the module from the brocade-fabric-traffic-controller.yang-tree.txt file. See YANG Module Overviewfor YANG node field definitions and possible values, and see Supported Data Types for data type descriptions.module: brocade-fabric-traffic-controller

+--rw brocade-fabric-traffic-controller

+--ro fabric-traffic-controller-device* [n-port-id] {fibrechannel:fibrechannel_switch_platform}?

+--ro n-port-id fibrechannel:fcid-hex-string-type

+--ro n-port-wwn? fibrechannel:wwn-type

+--ro f-port-wwn? fibrechannel:wwn-type

+--ro port-index? fibrechannel:user-port-number-type

+--ro rdf-registrations

| +--ro rdf-registration* els-descriptor-type

+--ro congestion-states

| +--ro congestion-state* congestion-state-type

+--ro edc-owner? fibrechannel:fcid-hex-string-type

+--ro fpin-send-statistics

| +--ro peer-congestion-count? yang:counter32

| +--ro congestion-count? yang:counter32

| +--ro link-integrity-count? yang:counter32

| +--ro delivery-count? yang:counter32

+--ro fpin-receive-statistics

| +--ro peer-congestion-count? yang:counter32

| +--ro congestion-count? yang:counter32

| +--ro link-integrity-count? yang:counter32

| +--ro delivery-count? yang:counter32

+--ro n-port-diagnostic-capabilities

| +--ro tx-signal-capability? congestion-detection-signal-type

| +--ro tx-signal-cycle? congestion-detection-signal-cycles-type

| +--ro tx-signal-scale? congestion-detection-signal-scale-type

| +--ro rx-signal-capability? congestion-detection-signal-type

| +--ro rx-signal-cycle? congestion-detection-signal-cycles-type

| +--ro rx-signal-scale? congestion-detection-signal-scale-type

| +--ro degrade-activate-threshold? uint32

| +--ro degrade-deactivate-threshold? uint32

| +--ro fec-degrade-interval? uint32

+--ro f-port-diagnostic-capabilities

| +--ro tx-signal-capability? congestion-detection-signal-type

| +--ro tx-signal-cycle? congestion-detection-signal-cycles-type

| +--ro tx-signal-scale? congestion-detection-signal-scale-type

| +--ro rx-signal-capability? congestion-detection-signal-type

| +--ro rx-signal-cycle? congestion-detection-signal-cycles-type

| +--ro rx-signal-scale? congestion-detection-signal-scale-type

| +--ro degrade-activate-threshold? uint32

| +--ro degrade-deactivate-threshold? uint32


Broadcom


| +--ro fec-degrade-interval? uint32

+--ro applied-signaling-capabilities

+--ro tx-signal-capability? congestion-detection-signal-type

+--ro tx-signal-cycle? congestion-detection-signal-cycles-type

+--ro tx-signal-scale? congestion-detection-signal-scale-type

+--ro rx-signal-capability? congestion-detection-signal-type

+--ro rx-signal-cycle? congestion-detection-signal-cycles-type

+--ro rx-signal-scale? congestion-detection-signal-scale-type

URI Format


• <base_URI>/running/brocade-fabric-traffic-controller/fabric-traffic-controller-device todisplay the retrieve FTC diagnostic information for the device to which the request is sent.

• <base_URI>/running/brocade-fabric-traffic-controller/fabric-traffic-controller-device/[n-port-id] to display the device information for the specified N_Port ID.

Parametersbrocade-fabric-traffic-controller

Description: The top-level container for the Fabric Traffic Controller. The data model contains informationregarding diagnostic capabilities, Extended Link Service (ELS) registration status, Fabric Performance Impact(FPI) notification and signaling, and any relevant statistics.Flag: read-onlyOptional: NoThis container has the following lists:fabric-traffic-controller-device

Description: A list of device entries applicable to Fabric Traffic Controller. The switch must be an FCswitch in Native mode.Type: stringKey: n-port-idConfig: falseOptional: NoThis list has the following leafs:n-port-id

Description: The N_Port ID (Fibre Channel address) of the device.Type: fibrechannel:fcid-hex-string-typeValue: A valid N_Port ID (Fibre Channel address) of the device.Optional: No

n-port-wwnDescription: The N_Port worldwide name of the device.Type: fibrechannel:wwn-typeValue: A valid N_Port worldwide name of the device.Optional: No

f-port-wwnDescription: The F_Port worldwide name of the F_Port to which the N_Port is attached.Type: fibrechannel:wwn-typeValue: A valid F_Port worldwide name of the F_Port to which the N_Port is attached.Optional: No


Broadcom


port-indexDescription: The user port index.Type: fibrechannel:user-port-number-typeValue: The port index number.Optional: No

rdf-registrationsDescription: A container of ELS-to-ELS-descriptor pairs that have been registered via theRegister Diagnostic Functions (RDF) ELS exchange.Optional: NoThis container contains the following leaf-list:rdf-registration

Description: An RDF-registered ELS-to-ELS-descriptor pair.Type: els-descriptor-typeValue: An RDF-registered ELS-to-ELS-descriptor pair.Optional: No

congestion-statesDescription: A container of congestion symptoms, or 'states', exhibited on the port.Optional: NoThis container contains the following leaf-list:congestion-state

Description: A congestion state entry (such as, credit stalled or oversubscribed).Type: congestion-state-typeValue: A congestion state entry (such as, credit stalled or oversubscribed).Optional: No

edc-ownerDescription: The N_Port ID of the device that owns the EDC (diagnostic capabilities) informationthat applies to this N_Port. The value may or may not match the value of the associated 'port-id' leaf of a given list entry. If the N_Port has not initiated an EDC ELS exchange, then the valuereturned is '0x000000'.Type: fibrechannel:fcid-hex-string-typeValue: A valid N_Port ID of the device that owns the EDC (diagnostic capabilities) informationthat applies to this N_Port.Optional: No

fpin-send-statisticsDescription: The quantitative data pertaining to Fabric Performance Impact Notification (FPIN)ELS exchanges originated by the switch.Optional: NoThis container contains the following leafs:peer-congestion-count

Description: The FPIN Peer-Congestion descriptor count.Type: yang:counter32Value: The FPIN Peer-Congestion descriptor count.Optional: No

congestion-countDescription: The FPIN Congestion descriptor count.Type: yang:counter32Value: The FPIN Congestion descriptor count.Optional: No


Broadcom


link-integrity-countDescription: The FPIN Link Integrity descriptor count.Type: yang:counter32Value: The FPIN Link Integrity descriptor count.Optional: No

delivery-countDescription: The FPIN Delivery descriptor count.Type: yang:counter32Value: The FPIN Delivery descriptor count.Optional: No

fpin-receive-statisticsDescription: The quantitative data pertaining to FPIN ELS exchanges received by the switch.Optional: NoThis container contains the following leafs:peer-congestion-count

Description: The FPIN Peer-Congestion descriptor count.Type: yang:counter32Value: The FPIN Peer-Congestion descriptor count.Optional: No

congestion-countDescription: The FPIN Congestion descriptor count.Type: yang:counter32Value: The FPIN Congestion descriptor count.Optional: No

link-integrity-countDescription: The FPIN Link Integrity descriptor count.Type: yang:counter32Value: The FPIN Link Integrity descriptor count.Optional: No

delivery-countDescription: The FPIN Delivery descriptor count.Type: yang:counter32Value: The FPIN Delivery descriptor count.Optional: No

n-port-diagnostic-capabilitiesDescription: The diagnostic capabilities of the N_Port (device).Optional: NoThis container contains the following leafs:tx-signal-capability

Description: The transmit congestion detection signal capabilities of the port.Type: congestion-detection-signal-typeValue: The transmit congestion detection signal capabilities of the port.Optional: No

tx-signal-cycleDescription: The transmit congestion detection cycle applicable to the port.Type: congestion-detection-signal-cycles-typeValue: The transmit congestion detection cycle applicable to the port.Optional: No


Broadcom


tx-signal-scaleDescription: The transmit congestion detection scale applicable to the port.Type: congestion-detection-signal-scale-typeValue: The transmit congestion detection scale applicable to the port.Optional: No

rx-signal-capabilityDescription: The receive congestion detection signal capabilities of the port.Type: congestion-detection-signal-typeValue: The receive congestion detection signal capabilities of the port.Optional: No

rx-signal-cycleDescription: The receive congestion detection cycle applicable to the port.Type: congestion-detection-signal-cycles-typeValue: The receive congestion detection cycle applicable to the port.Optional: No

rx-signal-scaleDescription: The receive congestion detection scale applicable to the port.Type: congestion-detection-signal-scale-typeValue: The receive congestion detection scale applicable to the port.Optional: No

degrade-activate-thresholdDescription: The value of a 32-bit register that specifies a symbol error count. This valuecontrols the threshold that activates the Remote Degrade Bit that is sent in the AlignmentMarker field.Type: uint32Value: 0..maxOptional: No

degrade-deactivate-thresholdDescription: The The value of a 32-bit register that specifies a symbol error count. Thisvalue controls the threshold that deactivates the Remote Degrade Bit that is sent in theAlignment Marker field.Type: uint32Value: 0..maxOptional: No

fec-degrade-intervalDescription: The value of a 32-bit register that specifies the number of RS-FEC codewords that make up a Degrade Interval.Type: uint32Value: 0..maxOptional: No

f-port-diagnostic-capabilitiesDescription: The diagnostic capabilities of the F_Port (switch).Optional: NoThis container contains the following leafs:tx-signal-capability



Broadcom







degrade-activate-thresholdDescription: The value of a 32-bit register that specifies a symbol error count. This valuecontrols the threshold that activates the Remote Degrade Bit that is sent in the AlignmentMarker field.Type: uint32Value: 0..maxOptional: No

degrade-deactivate-thresholdDescription: The The value of a 32-bit register that specifies a symbol error count. Thisvalue controls the threshold that deactivates the Remote Degrade Bit that is sent in theAlignment Marker field.Type: uint32Value: 0..maxOptional: No

fec-degrade-intervalDescription: The value of a 32-bit register that specifies the number of RS-FEC codewords that make up a Degrade Interval.Type: uint32Value: 0..maxOptional: No

applied-signaling-capabilitiesDescription: The congestion detection signal capabilities that are common between the N_Port(device) and F_Port (switch). The values are presented from the perspective of the switch, andrepresent the set of values that are actually programmed in hardware.


Broadcom


Optional: Notx-signal-capability







Supported Methods

The GET, OPTIONS, and HEAD operations are supported in this module.

Examples

This section provides basic examples for using the brocade-fabric-traffic-controller module.

Retrieving Fabric Traffic Controller Information

This example uses a GET request to retrieve FTC diagnostic information for the device to which the request is sent.

Structure

GET <base_URI>/running/brocade-fabric-traffic-controller/fabric-traffic-controller-device

URI

GET https://10.10.10.10/rest/running/brocade-fabric-traffic-controller/fabric-traffic-controller-device

Request Body


Broadcom


The request body is empty.

Response Body

<Response>

<fabric-traffic-controller-device>

<n-port-id>0x030300</n-port-id>

<n-port-wwn>30:10:50:eb:1a:bb:6c:fd</n-port-wwn>

<f-port-wwn>20:02:00:27:f8:f0:3a:76</f-port-wwn>

<port-index>2</port-index>

<rdf-registrations>

<rdf-registration>fpin-congestion</rdf-registration>

<rdf-registration>fpin-peer-congestion</rdf-registration>

<rdf-registration>fpin-link-integrity</rdf-registration>

<rdf-registration>fpin-delivery</rdf-registration>

</rdf-registrations>

<congestion-states>

<congestion-state>none</congestion-state>

</congestion-states>

<edc-owner>0x030300</edc-owner>

<fpin-send-statistics>

<peer-congestion-count>0</peer-congestion-count>

<congestion-count>0</congestion-count>

<link-integrity-count>0</link-integrity-count>

<delivery-count>0</delivery-count>

</fpin-send-statistics>

<fpin-receive-statistics>





</fpin-receive-statistics>

<n-port-diagnostic-capabilities>

<tx-signal-capability>warning</tx-signal-capability>

<tx-signal-cycle>100</tx-signal-cycle>

<tx-signal-scale>milliseconds</tx-signal-scale>

<rx-signal-capability>warning</rx-signal-capability>

<rx-signal-cycle>100</rx-signal-cycle>

<rx-signal-scale>milliseconds</rx-signal-scale>

<degrade-activate-threshold>20</degrade-activate-threshold>

<degrade-deactivate-threshold>10</degrade-deactivate-threshold>

<fec-degrade-interval>2</fec-degrade-interval>

</n-port-diagnostic-capabilities>

<f-port-diagnostic-capabilities>

<tx-signal-capability>none</tx-signal-capability>


<tx-signal-scale>none</tx-signal-scale>

<rx-signal-capability>none</rx-signal-capability>


<rx-signal-scale>none</rx-signal-scale>





Broadcom


</f-port-diagnostic-capabilities>

<applied-signaling-capabilities>







</applied-signaling-capabilities>

</fabric-traffic-controller-device>

</Response>

Retrieving Fabric Traffic Controller Information for a Specific N_Port

This example uses a GET request to retrieve FTC diagnostic information for the 0x030300 N_Port ID on the device towhich the request is sent.

Structure

GET <base_URI>/running/brocade-fabric-traffic-controller/fabric-traffic-controller-device/n-port-id/<n_port_id>

URI

GET https://10.10.10.10/rest/running/brocade-fabric-traffic-controller/fabric-traffic-controller-device/n-

port-id/0x030300

Request Body

The request body is empty.

Response Body

<Response>

<fabric-traffic-controller-device>

<n-port-id>0x030300</n-port-id>

<n-port-wwn>30:10:50:eb:1a:bb:6c:fd</n-port-wwn>

<f-port-wwn>20:02:00:27:f8:f0:3a:76</f-port-wwn>


<rdf-registrations>

<rdf-registration>fpin-congestion</rdf-registration>

<rdf-registration>fpin-peer-congestion</rdf-registration>

<rdf-registration>fpin-link-integrity</rdf-registration>

<rdf-registration>fpin-delivery</rdf-registration>

</rdf-registrations>

<congestion-states>

<congestion-state>none</congestion-state>

</congestion-states>

<edc-owner>0x030300</edc-owner>

<fpin-send-statistics>





</fpin-send-statistics>

<fpin-receive-statistics>


Broadcom






</fpin-receive-statistics>

<n-port-diagnostic-capabilities>

<tx-signal-capability>warning</tx-signal-capability>


<tx-signal-scale>milliseconds</tx-signal-scale>

<rx-signal-capability>warning</rx-signal-capability>


<rx-signal-scale>milliseconds</rx-signal-scale>




</n-port-diagnostic-capabilities>

<f-port-diagnostic-capabilities>










</f-port-diagnostic-capabilities>

<applied-signaling-capabilities>







</applied-signaling-capabilities>

</fabric-traffic-controller-device>

</Response>

History




Broadcom


brocade-fdmiThis module retrieves Fabric Device Management Interface (FDMI) information for the specified switch. FDMI enablesdiscovery of devices such as Fibre Channel host bus adapters (HBAs). If virtual fabrics are enabled, the request caninclude a query parameter (vf-id) for the desired virtual fabric. If no query parameter is specified and virtual fabrics areenabled, the information for the switch in the default virtual fabric is returned.

It assumes a knowledge of FDMI as performed in Fabric OS. For information on that topic, refer to the fdmiShowcommand in the Brocade Fabric OS Command Reference.

NOTEThe brocade-fdmi module is supported in Fabric OS 8.2.0a and later.

Module Tree

This is the tree view of the module from the brocade-fdmi.yang-tree.txt file. See YANG Module Overview for YANG nodefield definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-fdmi

+--ro brocade-fdmi

+--ro hba* [hba-id]

| +--ro hba-id fibrechannel:wwn-type

| +--ro domain-id? fibrechannel:domain-id-type

| +--ro manufacturer? string

| +--ro serial-number? string

| +--ro model? string

| +--ro model-description? string

| +--ro node-name? fibrechannel:wwn-type

| +--ro node-symbolic-name? string

| +--ro hardware-version? string

| +--ro driver-version? string

| +--ro option-rom-version? string


| +--ro os-name-and-version? string

| +--ro max-ct-payload? uint32

| +--ro vendor-id? string

| +--ro vendor-specific-info? fibrechannel:brocade-hex-string-type

| +--ro number-of-ports? uint32

| +--ro fabric-name? fibrechannel:wwn-type

| +--ro boot-bios-version? string

| +--ro boot-bios-enabled? uint8

| +--ro hba-port-list

| +--ro wwn* fibrechannel:wwn-type

+--ro port* [port-name]

+--ro port-name fibrechannel:wwn-type

+--ro hba-id? fibrechannel:wwn-type

+--ro domain-id? fibrechannel:domain-id-type

+--ro port-symbolic-name? string

+--ro port-id? fibrechannel:fcid-hex-string-type

+--ro port-type? fibrechannel:port-type-string-type

+--ro supported-class-of-service? fibrechannel:class-of-service-type

+--ro supported-fc4-type? fibrechannel:fc4-type-type

+--ro active-fc4-type? fibrechannel:fc4-type-type

+--ro supported-speed? fibrechannel:speed-type


Broadcom


+--ro current-port-speed? fibrechannel:speed-type

+--ro maximum-frame-size? uint32

+--ro os-device-name? string

+--ro host-name? string

+--ro node-name? fibrechannel:wwn-type

+--ro fabric-name? fibrechannel:wwn-type

+--ro port-state? fibrechannel:brocade-hex-string-type

+--ro number-of-discovered-ports? uint32

+--ro vsa-service-category? string

+--ro vsa-guid? string

+--ro vsa-version? string

+--ro vsa-product-name? string

+--ro vsa-port-info? string

+--ro vsa-qos-supported? string

+--ro vsa-security? string

+--ro vsa-storage-array-family? string

+--ro vsa-storage-array-name? string

+--ro vsa-storage-array-system-model? string

+--ro vsa-storage-array-os? string

+--ro vsa-storage-array-node-count? uint32

+--ro vsa-storage-array-nodes

| +--ro nodes* string

+--ro vsa-connected-ports

+--ro wwns* fibrechannel:wwn-type

+--ro vsa-end-to-end-version? string

URI Format


• <base_URI>/running/brocade-fdmi/hba to display the FDMI information for the HBA.

• <base_URI>/running/brocade-fdmi/port to display all HBA ports in the FDMI database.

Parametersbrocade-fdmi

Description: A detailed view of the Fabric Device Management Interface (FDMI).Flag: read-onlyConfig: falseThis container has the following leafs:hba

Description: List of HBA attributes registered with FDMI.Key: hba-idFlag: read-onlyThis list has the following leafs:hba-id

Description: A 64-bit Name_Identifier that is uniquely associated with the HBA among allHBAs in the same Fibre Channel interaction space (see FC-FS). The HBA identifier for anHBA may be the same as the Name_Identifier of an Nx_Port on the HBA if the requiredpersistence is satisfied. Once an HBA has registered a Name_Identifier as its HBA identifier, thatName_Identifier persists (for example, across power cycles) as the HBA identifier for the HBA.


Broadcom


Flag: read-onlyType: fibrechannel:wwn-typeValue: A valid WWN name.Optional: No

domain-idDescription: The domain directly attached to the HBA.Flag: read-onlyType: fibrechannel:domain-id-typeValue: 1 through 239. Default: 1Optional: No

manufacturerDescription:A printable ASCII string that specifies the manufacturer of the host adapter. The value may matchthe name by which the manufacturer identifies itself in a telephone directory.Flag: read-onlyType: stringValue: 0 to 63 printable ASCII characters.Optional: Yes

serial-numberDescription: A printable ASCII string that specifies the serial number of the host adapter. Thevalue should match a serial number engraved or printed on the host bus adapter, if there is any.Flag: read-onlyType: stringValue: 0 to 63 printable ASCII characters.Optional: Yes

modelDescription: A printable ASCII string that specifies the model of the host adapter. The valuemay match an encoded string used on purchase orders to identify the host adapter model. Somemanagement applications limit this attribute to 63 bytes.Flag: read-onlyType: stringValue: 0 to 255 printable ASCII characters.Optional: Yes

model-descriptionDescription: A printable ASCII string that describes the model of the host adapter. The valuemay provide more detailed or human-oriented identification of the model of the host bus adapterthan the model resource does.Flag: read-onlyType: stringValue: 0 to 255 printable ASCII characters.Optional: Yes

node-nameDescription: An 8-byte value that identifies the node that contains the Nx_Ports on the hostadapter. If all Nx_Ports on the host bus adapter have the same node name, the node-nameresource returned for the host bus adapter matches the node-name resource for its Nx_Ports. Ifnot all Nx_Ports on the host bus adapter have the same node name, the node-name resource isnot returned for the host bus adapter.Flag: read-onlyType: fibrechannel:wwn-type


Broadcom


Value: A valid WWN (colon-separated hexadecimal octets, most significant bit first, with leadingzeros.)Optional: Yes

node-symbolic-nameDescription: The name registered with the Name Server as a Name Server Symbolic NodeName object, which is subject to all the description and constraints of that object. If not allNx_Ports on the host bus adapter have the same node name, the node-symbolic-name resourcewill not be returned for the host bus adapter.Flag: read-onlyType: stringValue: 4 to 255 printable ASCII characters.Optional: Yes

hardware-versionDescription: A printable ASCII string that identifies the hardware version level of the hostadapter. Some management applications limit this to a length of 63 characters.Flag: read-onlyType: stringValue: 0 to 255 printable ASCII characters.Optional: Yes

driver-versionDescription: A printable ASCII string that identifies the version level of the driver software thatcontrols a host adapter. If a host bus adapter is concurrently under the control of multiple driversoftware modules with different versions, this resource may indicate the versions for more thanone driver module.Flag: read-onlyType: stringValue: 0 to 255 printable ASCII characters.Optional: Yes

option-rom-versionDescription: A printable ASCII string that identifies the Option ROM or BIOS version of a hostadapter.Flag: read-onlyType: stringValue: 0 to 255 printable ASCII characters.Optional: Yes

firmware-versionDescription: A printable ASCII string that identifies the version of firmware executed by a hostadapter. If a host bus adapter contains and has the capability to execute multiple firmwaremodules with different versions, this attribute may indicate the versions for more than onefirmware module.Flag: read-onlyType: stringValue: 0 to 255 printable ASCII characters.Optional: Yes

os-name-and-versionDescription: A printable ASCII string that describes the type and version of the operating systemthat controls the host bus adapter.Flag: read-onlyType: stringValue: 0 to 255 printable ASCII characters.


Broadcom


Optional: Yesmax-ct-payload

Description: A 32-bit unsigned integer equal to the maximum size CT payload in 32-bit words,including all CT headers but no FC frame header(s) that may be sent or received by applicationsoftware resident in the host in which the host bus adapter is installed. If the host bus adapterdoes not support generic CT capability for application software on the host in which it is installed,this attribute will not be returned.Flag: read-onlyType: uint32Value: 0 to the maximum size CT payload in 32-bit words.Optional: Yes

vendor-idDescription: The T10 vendor ID of the manufacturer of the HBA, or an OEM of the HBA.Flag: read-onlyType: stringValue: 1 to 8 printable ASCII characters.Optional: Yes

vendor-specific-infoDescription: A value with vendor-specific use.Flag: read-onlyType: fibrechannel:brocade-hex-string-typeValue: 0 to 10 hexidecimal string.Optional: Yes

number-of-portsDescription: The number of Nx_Ports on the HBA.Flag: read-onlyType: uint32Value: The number of Nx_Ports on the HBA.Optional: Yes

fabric-nameDescription: An 8-byte binary value equal to the Fabric_Name of the fabric associated with theHBA. If the HBA is associated with more than one fabric, fabric-name will not be provided.Flag: read-onlyType: fibrechannel:wwn-typeValues: A valid WWN name.Optional: Yes

boot-bios-versionDescription: A printable ASCII string that describes the identification and version of a boot BIOSprovided by the HBA.Flag: read-onlyType: stringValue: 4 to 255 printable ASCII characters.Optional: Yes

boot-bios-enabledDescription: Whether a boot BIOS provided by the HBA is enabled or disabled. boot-bios-enabled is true if the HBA provides a boot BIOS and the boot BIOS is enabled. boot-bios-enabledis false if the HBA provides a boot BIOS and the boot BIOS is disabled.Flag: read-onlyType: uint8Values: 1 = Boot-BIOS is enabled. 0 = Boot-BIOS is disabled.


Broadcom


Optional: Yeshba-port-list

Description: A list of port WWNs associated with the HBA. This list corresponds with the port-name resource under the port list.Flag: read-onlyOptional: YesThis list has the following leaf:wwn

Description: The WWN of the port on the HBA. This corresponds to the port-nameresource under the port list.Flag: read-onlyType: fibrechannel:wwn-typeValues: A valid WWN name.Optional: Yes

portDescription: A list of HBA port attributes registered with FDMI.Flag: read-onlyKey: port-nameThis list has the following leafs:port-name

Description: A WWN that identifies the port associated with the host bus adapter specified bythe hba-id resource.Flag: read-onlyType: fibrechannel:wwn-typeValue: A valid fibre channel WWN.Optional: No

hba-idDescription: A 64-bit Name_Identifier that is uniquely associated with the HBA among allHBAs in the same Fibre Channel interaction space (see FC-FS). The HBA identifier for anHBA may be the same as the Name_Identifier of an Nx_Port on the HBA if the requiredpersistence is satisfied. Once an HBA has registered a Name_Identifier as its HBA identifier, thatName_Identifier persists (for example, across power cycles) as the HBA identifier for the HBA.This corresponds to the hba-id resource under the hba list.Flag: read-onlyType: fibrechannel:wwn-typeValue: A valid fibre channel WWN.Optional: No

domain-idDescription: The domain directly attached to the HBA port.Flag: read-onlyType: fibrechannel:domain-id-typeValue: A FCID domain identifier.Optional: No

port-symbolic-nameDescription: The Port Symbolic Name object registered with the Name Server, which is subjectto all the description and constraints of that object defined in FC-GS.Flag: read-onlyType: stringValue: A valid port symbolic name.Optional: Yes


Broadcom


port-idDescription: The Port Identifier object registered with the Name Server, which is subject to all thedescription and constraints of that object defined in FC-GS.Flag: read-onlyType: fibrechannel:fcid-hex-string-typeValue: A vaild fibre channel ID (FCID) in hexadecimal format.Optional: Yes

port-typeDescription: The Name Server port type object registered with the Name Server, which issubject to all the description and constraints of that object defined in FC-GS.Flag: read-onlyType: fibrechannel:port-type-string-typeValue: The port type.n-port = (0x01)nl-port = (0x02)f/nl-port = (0x03)nx-port = (0x7F)f-port = (0x81)fl-port = (0x82)e-port = (0x84)b-port = (0x85)a-port = (0x86)0xnn = (Unknown/Reserved <hexadecimal value>)Optional: Yes

supported-class-of-serviceDescription: The Class of Service object registered with the Name Server, which is subject to allthe description and constraints of that object defined in FC-GS.Flag: read-onlyType: fibrechannel:class-of-service-typeValue: The class of service type.class-f = (bit 0)class-1 = (bit 1)class-2 = (bit 2)class-3 = (bit 3)Optional: Yes

supported-fc4-typeDescription: The FC-4 types attribute registered with the HBA Management Server as a portattribute. An Nx_Port registers a supported FC-4 types value that indicates "support" for any FC-4type that it is able to be configured to support.Flag: read-onlyType: fibrechannel:fc4-type-typeValue: The FC-4 type.IPFC = (0x05)FCP = (0x08)FCP-Features = (0x0A)SATA-Tunnel = (0x14)SBCCS = (0x18)SBCCS-Channel = (0x1B)SBCCS-Control-Unit =(0x1C)FC-CT = (0x20)FC-SW = (0x22)FC-IFR = (0x25)


Broadcom


FC-NVMe = (0x28)HIPPI-FP = (0x40)MIL-STD-1553 = (0x48)ASM = (0x49)FC-VI = (0x58)Application-Services = (0x60)Generic-FC-Features = (0xDE)RNID-Topology-Discovery = (0xDF)Optional: Yes

active-fc4-typesDescription: The Port active FC-4 types attribute registered with the Name Server, which issubject to all the description and constraints of that object defined in FC-GS. An Nx_Port registersa supported FC-4 types value that indicates "support" for any FC-4 type that it is able to beconfigured to support.Flag: read-onlyType: fibrechannel:fc4-type-typeValue: The FC-4 type. The same values as the supported-fc4-type.Optional: Yes

supported-speedDescription: The supported transmission speeds of the Nx_Port.Flag: read-onlyType: fibrechannel:speed-typeValues:speed-1-gfc = (Mask Value (hex): 0000 0001)speed-2-gfc = (Mask Value (hex): 0000 0002)speed-10-gfc = (Mask Value (hex): 0000 0004)speed-4-gfc = (Mask Value (hex): 0000 0008)speed-8-gfc = (Mask Value (hex): 0000 0010)speed-16-gfc = (Mask Value (hex): 0000 0020)speed-32-gfc = (Mask Value (hex): 0000 0040)speed-20-gfc = (Mask Value (hex): 0000 0080)speed-40-gfc = (Mask Value (hex): 0000 0100)speed-128-gfc = (Mask Value (hex): 0000 0200)speed-64-gfc = (Mask Value (hex): 0000 0400)speed-256-gfc = (Mask Value (hex): 0000 0800)speed-not-established = (Mask Value (hex): 0000 8000)speed-10-ge = (Mask Value (hex): 0001 0000)speed-40-ge = (Mask Value (hex): 0002 0000)speed-100-ge = (Mask Value (hex): 0004 0000)speed-25-ge = (Mask Value (hex): 0008 0000)speed-50-ge = (Mask Value (hex): 0010 0000)speed-400-ge = (Mask Value (hex): 0020 0000)Optional: Yes

current-port-speedDescription: The Current Port Speed attribute returned by the HBA Management Server as aport attribute if either it has been registered or it has been determined by the HBA ManagementServer. If the HBA Management Server is able to determine a speed, the value returned for theCurrent Port Speed attribute indicates the speed determined by the HBA Management Server,regardless of any value registered.Flag: read-onlyType: fibrechannel:speed-type


Broadcom


Value: The current port speed in gigabits per second (Gb/s). The same values as thesupported-speed.Optional: Yes

maximum-frame-sizeDescription: The Maximum Frame Size attribute registered with the HBA Management Server asa Port attribute. Maximum Frame Size attribute does not include the FC header but does includeany optional headers.Flag: read-onlyType: uint32Value: The maximum FC frame payload in bytes.Optional: Yes

os-device-nameDescription: The OS Device Name attribute registered with the HBA Management Server as aport attribute. The OS Device Name attribute contains a printable ASCII character string that isrecognized as a reference to the Nx_Port by the OS that controls it. If there are several such OSdevice names that reference the same Nx_Port, this attribute may be a comma-separated list ofas many such names as fit in 255 bytes. If the software that registers Nx_Port attributes cannotdetermine any such OS Device Name, it does not register this attribute.Flag: read-onlyType: stringValue: 0 to 255 printable ASCII characters.Optional: Yes

host-nameDescription: The Host Name attribute registered with the HBA Management Server as a Portattribute. If there are several such names that reference the same host, this attribute may be acomma-separated list of as many such names as fit in 255 bytes. If the software that registersNx_Port attributes is unable to determine any such Host Name, it does not register this attribute.Flag: read-onlyType: stringValue: The host associated with the Nx_Port. 0 to 255 printable ASCII characters.Optional: Yes

node-nameDescription: The Node Name attribute registered with the Name Server for the Nx_Port. Theformat of the Node_Name attribute is the format of the Name_Identifier described in FC-FS.Flag: read-onlyType: fibrechannel:wwn-typeValue: A fibre channel WWN that identifies the node that contains the Nx_Port.Optional: Yes

fabric-nameDescription: The Port Fabric Name attribute registered with the HBA Management Server as anNx_Port attribute. The Port Fabric Name attribute contains an 8-byte binary value equal to theFabric_Name of the fabric associated with the Nx_Port (see FC-SW). Registration of the PortFabric Name attribute is optional, and may be registered automatically by the fabric for Nx_Portsthat are registered with the Fabric Name Server.Flag: read-onlyType: fibrechannel:wwn-typeValue: A fibre channel WWN.Optional: Yes


Broadcom


port-stateDescription: The Port State (see SM-HBA) for the specified Nx_Port. The Port State is an integerwhere the value indicates the current state of the Nx_Port. The sequence and timing of PortStates that are exhibited due to errors or transient conditions are vendor specific.Flag: read-onlyType: fibrechannel:brocade-hex-string-typeValues:0x0 = Undefined0x1 = Unknown0x2 = Fully Operational0x3 = Administratively offline0x4 = Bypassed0x5 = In Diagnostics Mode0x6 = Link down0x7 = Phy error0x8 = Loopback0x9 = Degraded, but Operational ModeOptional: Yes

number-of-discovered-portsDescription: The number of FC_Ports that are visible to the Nx_Port identified in the request. Ata minimum, this is the number of FC_Ports mapped to a device, but it may not reflect all nodes ona network.Flag: read-onlyType: uint32Value: The number of FC_Ports that are visible to the specified Nx_Port.Optional: Yes

vsa-service-categoryDescription: The vendor-specific service category resource.Flag: read-onlyType: stringValue: 0 to 255 printable ASCII characters.Optional: Yes

vsa-guidDescription: The vendor-specific guid resource.Flag: read-onlyType: stringValue: 0 to 34 printable ASCII characters.Optional: Yes

vsa-versionDescription: The vendor-specific version resource.Flag: read-onlyType: stringValue: 0 to 255 printable ASCII characters.Optional: Yes

vsa-product-nameDescription: The vendor-specific product name resource.Flag: read-onlyType: stringValue: 0 to 255 printable ASCII characters.Optional: Yes


Broadcom


vsa-port-infoDescription: The vendor-specific port information resource.Flag: read-onlyType: stringValue: 0 to 63 printable ASCII characters.Optional: Yes

vsa-qos-supportedDescription: The vendor-specific QOS supported resource.Flag: read-onlyType: stringValue: 0 to 63 printable ASCII characters.Optional: Yes

vsa-securityDescription: The vendor-specific security resource.Flag: read-onlyType: stringValue: 0 to 63 printable ASCII characters.Optional: Yes

vsa-storage-array-familyDescription: The vendor-specific storage array family.Flag: read-onlyType: stringValue: 0 to 63 printable ASCII characters.Optional: Yes

vsa-storage-array-nameDescription: The vendor-specific storage array name.Flag: read-onlyType: stringValue: 0 to 63 printable ASCII characters.Optional: Yes

vsa-storage-array-system-modelDescription: The vendor-specific storage array system model.Flag: read-onlyType: stringValue: 0 to 63 printable ASCII characters.Optional: Yes

vsa-storage-array-osDescription: The vendor-specific storage array operating system.Flag: read-onlyType: stringValue: 0 to 63 printable ASCII characters.Optional: Yes

vsa-storage-array-node-countDescription: The vendor-specific storage array node count.Flag: read-onlyType: uint32Value: The storage array node count.Optional: Yes


Broadcom


vsa-storage-array-nodesDescription: A list of vendor-specific storage array nodes.Flag: read-onlyOptional: YesThis container has the following leaf.nodes*

Description: The vendor-specific storage array node resource.Flag: read-onlyType: stringValue: 0 to 255 printable ASCII characters.Optional: Yes

vsa-connected-portsDescription: A list of vendor-specific connected ports.Flag: read-onlyOptional: YesThis container has the following leaf.wwns*

Description: The vendor-specific connected port resource.Flag: read-onlyType: fibrechannel:wwn-typeValue: A valid fibre channel WWN.Optional: Yes

vsa-end-to-end-versionDescription: The vendor-specific end-to-end management version. The registration of thisattribute is optional.Flag: read-onlyType: stringValue: The vendor-specific end-to-end management version.Optional: Yes

Supported Methods

The GET, OPTIONS, and HEAD operations are supported in this module.

ExamplesRetrieving FDMI Information From an HBAThis example uses a GET request to retrieve FDMI information for the HBA to which the request is sent.StructureGET <base_URI>/running/brocade-fdmi/hbaURIGET https://10.10.10.10/rest/running/brocade-fdmi/hba

Request BodyThe request body is empty.Response Body


<Response>


Broadcom


<hba>

<hba-id>21:00:00:0e:1e:1b:f9:10</hba-id>


<hba-port-list>

<wwn>21:00:00:0e:1e:1b:f9:10</wwn>

</hba-port-list>

<node-name>20:00:00:0e:1e:1b:f9:10</node-name>

<manufacturer>QLogic Corporation</manufacturer>

<serial-number>BFE1425K14446</serial-number>

<model>QLE2672</model>

<model-description>QLE2672 QLogic 2-port 16Gb Fibre Channel Adapter</model-description>

<hardware-version>HW VERSION</hardware-version>

<driver-version>2.1.46.0</driver-version>

<option-rom-version>3.40</option-rom-version>

<firmware-version>8.03.06 (d0d5)</firmware-version>

<os-name-and-version>VMware ESXi-6.5.0 (Releasebuild-4564106)</os-name-and-version>

<max-ct-payload>2048</max-ct-payload>

<node-symbolic-name>QLE2672 FW:v8.03.06 DVR:v2.1.46.0</node-symbolic-name>

<vendor-specific-info>0x00001077</vendor-specific-info>

<number-of-ports>1</number-of-ports>

<fabric-name>20:00:00:0e:1e:1b:f9:10</fabric-name>

<boot-bios-version>3.40</boot-bios-version>

<boot-bios-enabled>1</boot-bios-enabled>

<vendor-id>QLogic</vendor-id>

</hba>

<hba>

<hba-id>21:00:00:0e:1e:18:99:71</hba-id>


<hba-port-list>

<wwn>21:00:00:0e:1e:18:99:71</wwn>

</hba-port-list>

<node-name>20:00:00:0e:1e:18:99:71</node-name>

<manufacturer>QLogic Corporation</manufacturer>

<serial-number>BFE1346E15893</serial-number>

<model>QLE2672</model>

<model-description>QLE2672 QLogic 2-port 16Gb Fibre Channel Adapter</model-description>

<hardware-version>HW VERSION</hardware-version>

<driver-version>2.1.46.0</driver-version>

<option-rom-version>3.40</option-rom-version>

<firmware-version>8.03.06 (d0d5)</firmware-version>

<os-name-and-version>VMware ESXi-6.5.0 (Releasebuild-4564106)</os-name-and-version>

<max-ct-payload>2048</max-ct-payload>

<node-symbolic-name>QLE2672 FW:v8.03.06 DVR:v2.1.46.0</node-symbolic-name>

<vendor-specific-info>0x00001077</vendor-specific-info>

<number-of-ports>1</number-of-ports>

<fabric-name>20:00:00:0e:1e:18:99:71</fabric-name>

<boot-bios-version>3.40</boot-bios-version>

<boot-bios-enabled>1</boot-bios-enabled>

<vendor-id>QLogic</vendor-id>

</hba>

</Response>


Broadcom


Retrieving HBA Port AttributesThis example uses a GET request to retrieve port attributes.StructureGET <base_URI>/running/brocade-fdmi/portURIGET https://10.10.10.10/rest/running/brocade-fdmi/port

Request BodyThe request body is empty.Response Body


<Response>

<port>

<port-name>21:00:00:0e:1e:07:03:48</port-name>

<hba-id>21:00:00:0e:1e:07:03:48</hba-id>


<port-symbolic-name>QLE2670 FW:v6.02.00 DVR:v9.2.9.23</port-symbolic-name>

<port-id>0x2baa00</port-id>

<port-type>n-port</port-type>

<supported-class-of-service>class-3</supported-class-of-service>

<supported-fc4-type>FCP</supported-fc4-type>

<active-fc4-type>FCP</active-fc4-type>

<supported-speed>speed-4-gfc speed-8-gfc speed-16-gfc</supported-speed>

<current-port-speed>speed-16-gfc</current-port-speed>

<maximum-frame-size>2048</maximum-frame-size>

<os-device-name>QLogic Adapter</os-device-name>

<host-name>W16-BRM68164</host-name>

<node-name>20:00:00:0e:1e:07:01:41</node-name>

<fabric-name>10:00:c1:f5:1c:1a:ac:1c</fabric-name>

<port-state>0x2</port-state>

<number-of-discovered-ports>0</number-of-discovered-ports>

</port>

...

<port>

<port-name>10:00:00:10:1b:1f:1b:c1</port-name>

<hba-id>10:00:00:10:1b:1f:1b:c1</hba-id>


<port-symbolic-name>Emulex PPN-10:00:00:10:1B:1F:1B:C1</port-symbolic-name>

<port-id>0x2bad00</port-id>


<supported-class-of-service>class-3</supported-class-of-service>

<supported-fc4-type>0x01 FCP FC-CT FC-NVMe</supported-fc4-type>

<active-fc4-type>0x01 FCP FC-CT</active-fc4-type>

<supported-speed>speed-8-gfc speed-16-gfc speed-32-gfc</supported-speed>

<current-port-speed>speed-32-gfc</current-port-speed>

<maximum-frame-size>2048</maximum-frame-size>

<host-name>W16-68166</host-name>

<node-name>20:00:00:10:1b:1f:1b:c1</node-name>

<fabric-name>20:ad:c1:f1:1c:1a:ac:1c</fabric-name>


Broadcom


<port-state>0x2</port-state>

<number-of-discovered-ports>3</number-of-discovered-ports>

<vsa-end-to-end-version>ELXE2EM:0001</vsa-end-to-end-version>

</port>

</Response>

History



Fabric OS 9.0.0 This API call was modified to add the vsa-end-to-end-version parameter to the port list.


Broadcom


brocade-fibrechannel-configurationThis module enables you to configure a switch or director.

Module Tree

This is the tree view of this module from the brocade-fibrechannel-configuration.yang-tree.txt file. SeeYANG Module Overview for YANG node field definitions and possible values, and see Supported Data Types for data typedescriptions.

module: brocade-fibrechannel-configuration

+--rw brocade-fibrechannel-configuration

+--rw switch-configuration

| +--rw trunk-enabled? boolean

| +--rw wwn-port-id-mode? boolean {fibrechannel:fibrechannel_switch_platform}?

| +--rw edge-hold-time? uint16

| +--rw area-mode? uint8 {fibrechannel:fibrechannel_chassis_platform}?

| +--rw xisl-enabled? boolean

+--rw f-port-login-settings

| +--rw max-logins? uint16

| +--rw max-flogi-rate-per-switch? uint16

| +--rw stage-interval? uint16

| +--rw free-fdisc? uint16

| +--rw enforce-login? uint16

| +--rw max-flogi-rate-per-port? uint16

+--rw port-configuration

| +--rw portname-mode? string

| +--rw dynamic-portname-format? string {fibrechannel:fibrechannel_switch_platform}?

| +--rw dynamic-d-port-enabled? boolean

| +--rw on-demand-d-port-enabled? boolean {fibrechannel:fibrechannel_switch_platform}?

+--rw zone-configuration {fibrechannel:fibrechannel_switch_platform}?

| +--rw node-name-zoning-enabled? boolean {fibrechannel:fibrechannel_switch_platform}?

| +--rw fabric-lock-timeout? uint16

+--rw fabric

| +--rw insistent-domain-id-enabled? boolean {fibrechannel:fibrechannel_switch_platform}?

| +--rw principal-selection-enabled? boolean

| +--rw principal-priority? fibrechannel:brocade-hex-string-type

+--rw chassis-config-settings

+--rw firmware-synchronization-enabled? boolean

+--rw http-session-ttl? uint32

+--rw ezserver-enabled? boolean {fibrechannel:fibrechannel_switch_platform}?

URI Format


• <base_URI>/running/brocade-fibrechannel-configuration/switch-configuration to view or configurethe preconfigured parameters of the switch.

• <base_URI>/running/brocade-fibrechannel-configuration/f-port-login-settings to view orconfigure the F_Port login parameters.

• <base_URI>/running/brocade-fibrechannel-configuration/port-configuration to view or configurepreconfigured port parameters.


Broadcom


• <base_URI>/running/brocade-fibrechannel-configuration/zone-configuration to view or configurezoning parameters.

• <base_URI>/running/brocade-fibrechannel-configuration/chassis-config-settings to view orconfigure chassis-level settings.

Parametersbrocade-fibrechannel-configuration

Description: This module enables you to configure a switch or director.Flag: read-writeThis container has the following leafs:switch-configuration

Description: Provides switch configuration parameters.Flag: read-writeThis container has the following leafs:trunk-enabled

Description: Enables or disables trunking on all ports in the logical switch. To enable or disabletrunking on individual ports, see the trunk-port-enabled leaf in the brocade-fibrechannel module.Note that this operation is persistent and disruptive for all ports in the logical switch. Notethat while you can enable or disable trunking through a PATCH request you cannot retrieveinformation about this parameter in a GET request.Flag: read-writeType: booleanValue: true = Trunking is enabled on all ports in the logical switch. false = Trunking is disabled onall ports in the logical switch.Optional: Yes

wwn-port-id-modeDescription: Indicates whether WWN-based persistent PID is enabled on a switch. WWN portID mode supports both dynamic and static WWN-based PID assignment. Every time the devicelogs on to the switch, the device is guaranteed the same PID. This parameter is not valid whenthe logical switch is configured as a base switch, and it cannot be set to true when the area-modeleaf is set to 2.Flag: read-writeType: booleanValue: true = WWN port ID mode is enabled on the switch. false = WWN port ID mode isdisabled on the switch.Optional: Yes

edge-hold-timeDescription: The maximum time, in milleseconds, that a frame can wait after it is received on theingress port and before it is delivered to the egress port.Flag: read-writeType: uint16Value: For a default switch, valid values can be 80 to 500. Note that user-defined values areallowed only on a default switch. For a non-default logical switch, valid values include: 80 = EdgeHold Time, Low (80 ms); 220 = Edge Hold Time, Medium (220 ms); 500 = Edge Hold Time,Medium (500 ms).Optional: Yes

area-modeDescription: The area mode. Area mode has a different meaning (see Value below) in a defaultswitch and non-default, non-FICON switch. Note that the switch must be in disabled state for thissetting (fibrechannel-switch:enabled-state = 3).


Broadcom


Flag: read-writeType: uint8Value: For a default switch, valid values include: 0 = 10-bit addressing mode (default); 1 = Zero-based area assignment (8-bit addressing mode).For a nondefault and non-FICON logical switch, valid values include: 0 = 10-bit addressing mode(default); 1 = Zero-based area assignment; 2 = Port-based area assignment. A non-default logicalswitch with FICON mode enabled is not supported.Optional: Yes

xisl-enabledDescription: Enables or disables the XISL feature. By default, XISL is enabled on the switch.Disabling XISL requires a confirmation because it removes all LISLs when complete.Flag: read-writeType: booleanValues: true : Enables XISLs on the switch. false : Disables XISLs on the switch.Optional: Yes

f-port-login-settingsDescription: Provides parameters for F_Port login settings. Note that the switch must be in adisabled state to configure F_Port login settings (fibrechannel-switch:enabled-state = 3).Flag: read-writeThis container has the following leafs:max-logins

Description: The maximum number of allowed logins for the switch.Flag: read-writeType: uint16Value: 0 to the maximum. The maximum value is determined by multiplying 126 by thenumber of ports in the switch (126 * number_of_ports_in_switch). The initial default valueis 16 * number_of_ports_in_switch.Optional: Yes

max-flogi-rate-per-switchDescription: The maximum number of fabric logins (FLOGIs) allowed, per second, on aswitch.Flag: read-writeType: uint16Value: 0 to the maximum.Optional: Yes

stage-intervalDescription: The interval setting, in milliseconds, for the rate at which F_Ports areenabled.Flag: read-writeType: uint16Value: 0 to 10000 milliseconds.Optional: Yes

free-fdiscDescription: The number of logins allowed before staging. This parameter, if nonzero,enables staging of FDISC logins by rejecting the FDISC requests with logical busy, whenthe requests are more than the number of configured logins per second.Flag: read-writeType: uint16Value: 0 = Disables the staging of FDISC logins. 1 to 255 = Enables staging and allowsthe specified number of logins.


Broadcom


Optional: Yesenforce-login

Description: The precedence for login when two devices with same the port WWN(PWWN) compete for login. All modes are for NPIV and non-NPIV F_Ports.Flag: read-writeType: uint16Value: 0 = The first login takes precedence over the second login. 1 = The second loginoverrides the first login. 2 = For FDISC, the second FDISC login takes precedence. ForFLOGI, the first FLOGI takes precedence.Optional: Yes

max-flogi-rate-per-portDescription: The maximum number of logins allowed, per second, on a given port. If thenumber is exceeded, the port is fenced.Flag: read-writeType: uint16Value: 0 to 100 logins per second.Optional: Yes

port-configurationDescription: Provides the port configuration parameters.Flag: read-writeThis container has the following leafs:portname-mode

Description: The current port name mode (off, default, fdmi or dynamic).Flag: read-writeType: stringValue: off = No port name configuration. default = The port name corresponds tothe port index. fdmi = The port name corresponds to the attached FDMI host name.dynamic = The port name corresponds to the format defined by the dynamic-portname-format leaf. Note that fdmi and dynamic modes are not available in Access Gatewaymode.Optional: Yes

dynamic-portname-formatDescription: The format of a dynamic port name is composed of fields that are mappedusing the following characters:S = Switch nameT = Port typeI = Port index (note that I and C are mutually exclusive)C = Slot number/port number (only applicable on the chassis)A = Alias nameF = FDMI host nameR = Remote switch nameMultiple unique fields may be specified, separated by hyphens (-), periods (.), orunderscores (_). Fields may not be repeated, and field separators must be the same. Theswitch must be an FC switch in Native mode.Flag: read-writeType: stringValue: 0 to 13 alphanumeric characters.Optional: Yes


Broadcom


dynamic-d-port-enabledDescription: The port has D_Port capability, but it is not explicitly configured. Enablinga dynamic D_Port switch-wide configuration forces the ports on that switch or chassisto respond to D_Port requests from the other end of the connection. Basically, the portresponds to a remote port request to change its mode to D_Port mode and run diagnostictests automatically.Flag: read-writeType: booleanValue: true = Dynamic D_Port configuration is enabled. false = Dynamic D_Portconfiguration is disabled.Optional: Yes

on-demand-d-port-enabledDescription: The port has D_Port capability, but it is not explicitly configured. Enablingan on-demand D_Port switch-wide configuration forces the ports on that switch orchassis to respond to an internal request within the switch as a result of certain events(slot power off or on, persistent disable or enable, and so on). Basically, the switchresponds to an internal request to change a port mode to D_Port mode, and rundiagnostic tests automatically. The D_Ports change to normal port mode after successfulcompletion of the tests.Flag: read-writeType: booleanValue: true = On-demand D_Port configuration is enabled. false = On-demand D_Portconfiguration is disabled.Optional: Yes

zone-configurationDescription: Provides zoning configuration parameters. The switch must be an FC switch inNative mode.Flag: read-writeThis container has the following leafs:node-name-zoning-enabled

Description: Indicates whether node name checking for zoning is enabled. The switchmust be an FC switch in Native mode. The switch must be disabled to change this value.Flag: read-writeType: booleanValue: true = Node name checking for zoning is enabled. false = Node name checkingfor zoning is disabled.Optional: Yes

fabric-lock-timeoutDescription: The zone fabric lock timeout duration in minutes.Flag: read-writeType: uint16Values: 5 to 30 minutes. The default value is 5 minutes.Optional: Yes

fabricDescription: Provides attributes applicable for a switch.Flag: read-writeThis container has the following leaf:insistent-domain-id-enabled

Description: Indicates whether Insistent Domain ID (IDID) is enabled. Typically, thefabric automatically resolves domain ID conflicts during fabric merges or builds unless


Broadcom


IDID is configured. If IDID is enabled, switches that cannot be programmed with a uniquedomain ID will segment from the fabric. Check each switch that has IDID configured, andmake sure that their domain IDs are unique within the configuration. The switch must bean FC switch in Native mode.NOTEFor FICON switches, the insistent-domain-id-enabled leaf is read only.Flag: read-writeType: booleanValue: true = IDID is enabled. false = IDID is disabled.Optional: Yes

principal-selection-enabledDescription: Enables or disables principal switch selection.Flag: read-writeType: booleanValues: true = Enables principal switch selection mode. false = Disables principal switchselection mode.Optional: Yes

principal-priorityDescription: Sets the principal selection priority of the switch. This parameter is available onlywhen pricipal selection is enabled on the switch. Not all of these values can be assigned. Thismechanism provides a preference for a switch requesting to be the principal switch in a fabric, butthey do not provide an absolute guarantee that a switch requesting to be the principal switch isgranted this status.Flag: read-writeType: fibrechannel:brocade-hex-string-typeValues: 0x01 = Highest and default priority (if priority not given). 0x02 = Avoid this priority asthis is an internal priority given during fabric rebuild. 0x03-0xFE = Priority value range. Highernumbers mean lower priority. 0xFF = Switch is not capable of acting as a principal switch.Optional: Yes

chassis-config-settingsDescription: Changes chassis-level system configuration settings.Flag: read-writeOptional: YesThis container/list has the following leafs:firmware-synchronization-enabled

Description: Enables the firmware from the active CP to automatically synchronize withthe standby CP.Flag: read-writeType: booleanValue: Enables the firmware from the active CP to automatically synchronize with thestandby CP.Optional: Yes

http-session-ttlDescription: The timeout value for BNA, SANNav, REST API, and PyFOS.Flag: read-writeType: uint32Value: 60 to 432000 seconds.Optional: Yes


Broadcom


ezserver-enabledDescription: Enables or disables the EZServer. The switch must be an FC switch inNative mode.Flag: read-writeType: booleanValue: true = Enables the EZServer. false = Disables the EZServer.Optional: Yes

Supported Methods

Only the OPTIONS, GET, PATCH, and HEAD operations are supported in this module.

Examples

Viewing Switch Parameters

The following example uses the GET request to view existing parameters for a switch.

Structure

GET <base_URI>/running/brocade-fibrechannel-configuration/switch-configuration

URI

GET https://10.10.10.10/rest/running/brocade-fibrechannel-configuration/switch-configuration

Request Body


Response Body

When the operation is successful, the response has a message body similar to the following, and a “200 OK” status in theheaders.


<Response>

<switch-configuration>

<area-mode>1</area-mode>

<wwn-port-id-mode>false</wwn-port-id-mode>

<edge-hold-time>500</edge-hold-time>

</switch-configuration>

</Response>

Viewing F_Port Login Settings

The following example uses the GET request to view existing parameters for F_Port login.

Structure

GET <base_URI>/running/brocade-fibrechannel-configuration/f-port-login-settings

URI

GET https://10.10.10.10/rest/running/brocade-fibrechannel-configuration/f-port-login-settings

Request Body



Broadcom


Response Body



<Response>

<f-port-login-settings>

<max-logins>5120</max-logins>

<max-flogi-rate-per-switch>0</max-flogi-rate-per-switch>

<stage-interval>0</stage-interval>

<free-fdisc>0</free-fdisc>

<enforce-login>0</enforce-login>

<max-flogi-rate-per-port>100</max-flogi-rate-per-port>

</f-port-login-settings>

</Response>

Configuring the Maximum Number of Logins Allowed on a Port

The following example uses the PATCH request to configure the maximum number of logins allowed per second on a port.

Structure

PATCH <base_URI>/running/brocade-fibrechannel-configuration/f-port-login-settings

URI

PATCH https://10.10.10.10/rest/running/brocade-fibrechannel-configuration/f-port-login-settings

Request Body

<f-port-login-settings>

<max-flogi-rate-per-port>100</max-flogi-rate-per-port>

</f-port-login-settings>

Response Body


Viewing the Port Configuration

The following example uses the GET request to view the existing port configuration.

Structure

GET <base_URI>/running/brocade-fibrechannel-configuration/port-configuration

URI

GET https://10.10.10.10/rest/running/brocade-fibrechannel-configuration/port-configuration

Request Body


Response Body



Broadcom



<Response>

<port-configuration>

<portname-mode>default</portname-mode>

<dynamic-portname-format>S.T.I</dynamic-portname-format>

<dynamic-d-port-enabled>true</dynamic-d-port-enabled>

<on-demand-d-port-enabled>false</on-demand-d-port-enabled>

</port-configuration>

</Response>

Configuring the Dynamic Port Name Format

The following example uses the PATCH request to configure the dynamic port name format as S.T.I.A, which representsswitch_name.port_type.port_index.alias_name. The format of a dynamic port name is composed of fields that are mappedusing the following characters:

S = Switch name

T = Port type

I = Port index

C = Slot number/port number (only applicable on a chassis)

A = Alias name

F = FDMI host name

R = Remote switch name

Multiple unique fields may be specified, separated by hyphens (-), periods (.), or underscores (_). Fields may not berepeated, and field separators must be the same. The switch must be an FC switch in Native mode.

Structure

PATCH <base_URI>/running/brocade-fibrechannel-configuration/port-configuration/dynamic-portname-format

URI

PATCH https://10.10.10.10/rest/running/brocade-switch/brocade-fibrechannel-configuration/port-configuration

Request Body

<port-configuration>

<dynamic-portname-format>S.T.I.A</dynamic-portname-format>

</port-configuration>

Response Body

When the operation is successful, the response contains an empty message body and a “204 No Content" status appearsin the header.

Enabling Node Name Checking for Zoning

The following example uses the PATCH request to enable using the node WWN when specifying nodes for zoning.

Structure

PATCH <base_URI>/running/brocade-fibrechannel-configuration/zone-configuration/node-name-zoning-enabled


Broadcom


URI

PATCH https://10.10.10.10/rest/running/brocade-switch/brocade-fibrechannel-configuration/zone-configuration

Request Body

<zone-configuration>

<node-name-zoning-enabled>true</node-name-zoning-enabled>

</zone-configuration>

Response Body


Modifying the Fabric Lock Timeout

This example uses a PATCH request to modify the fabric lock timeout duration to 6 minutes.

Structure

PATCH <base_URI>/running/brocade-fibrechannel-configuration/zone-configuration/fabric-lock-timeout/6

URI

PATCH https://10.10.10.10/rest/running/brocade-fibrechannel-configuration/zone-configuration/fabric-lock-timeout/6

Request Body


Response Body


Enabling Insistent Domain ID on a Device

The following example uses the PATCH request to enable Insistent Domain ID on a device.

Structure

PATCH <base_URI>/running/brocade-fibrechannel-configuration/fabric

URI

PATCH https://10.10.10.10/rest/running/brocade-switch/brocade-fibrechannel-configuration/fabric

Request Body

<fabric>

<insistent-domain-id-enabled>true</insistent-domain-id-enabled>

</fabric>

Response Body



Broadcom


Configuring the Fabric

This example uses a PATCH request to display the fabric data for a switch.

Structure

PATCH base_URI/running/brocade-fibrechannel-configuration/fabric

URI

PATCH https://10.10.10.10/rest/running/brocade-fibrechannel-configuration/fabric

Request Body

<fabric>

<insistent-domain-id-enabled>false</insistent-domain-id-enabled>

<principal-selection-enabled>false</principal-selection-enabled>

<principal-priority>0x00</principal-priority>

</fabric>

Response Body

When the operation is successful, the response contains an empty message body and a “204 No Content” status in theheaders.

Configuring the Chassis Settings

This example uses a PATCH request to configure the chassis settings.

Structure

PATCH base_URI/running/brocade-fibrechannel-configuration/fabric

URI

PATCH https://10.10.10.10/rest/running/brocade-fibrechannel-configuration/fabric

Request Body

<chassis-config-settings>

<firmware-synchronization-enabled>false</firmware-synchronization-enabled>

<http-session-ttl>7200</http-session-ttl>

<ezserver-enabled>true</ezserver-enabled>

</chassis-config-settings>

Response Body


History



Fabric OS 9.0.0 this API call was modified to add the fabric-lock-timeout parameter to the zone-configuration container, add the chassis-config-settings container, and add the principal-selection-enabled and principal-priority parameters to the fabric container.


Broadcom


brocade-fibrechannel-diagnosticsThis module provides support for ClearLink diagnostic port configuration and diagnostic port results. It expects that theswitch is configured with an actual online diagnostics port (D_Port).

For information on diagnostics, refer to the Brocade Fabric OS Troubleshooting and Diagnostics Guide.

Module Tree

This is the tree view of the module from the brocade-fibrechannel-diagnostics.yang-tree.txt file. SeeYANG Module Overview for YANG node field definitions and possible values, and see Supported Data Types for data typedescriptions.module: brocade-fibrechannel-diagnostics

+--rw brocade-fibrechannel-diagnostics

+--rw fibrechannel-diagnostics* [name]

+--rw name string

+--rw diagnostic-control? uint32

+--ro mode? enumeration

+--ro state? string

+--ro distance? int32

+--ro remote-switch-wwn? fibrechannel:wwn-type

+--ro remote-port-index? fibrechannel:user-port-number-type

+--ro electrical-loopback-test

| +--ro result? result-type

| +--ro comments? comments-type

| +--ro start-time? fibrechannel:time-24hr-extended-type

| +--ro estimate-time? fibrechannel:time-24hr-extended-type

+--ro optical-loopback-test





+--ro link-traffic-test





+--ro start-time? yang:date-and-time

+--rw frame-count? yang:counter32

+--rw frame-size? uint32

+--rw time? string

+--rw payload-pattern

| +--rw pattern? string

| +--rw payload? string

+--rw fec

| +--rw enable? enumeration

| +--ro active? enumeration

| +--ro option? enumeration

+--ro rt-latency? uint32

+--ro buffers-required? string

+--ro end-time? yang:date-and-time

+--rw cr

| +--rw enable? enumeration


Broadcom


| +--ro active? enumeration

| +--ro option? enumeration

+--ro failure-report

| x--ro errors-detected-local? enumeration

| x--ro errors-detected-remote? enumeration

+--ro failure-report-local-errors

| +--ro error* error-stats-type

+--ro failure-report-remote-errors

| +--ro error* error-stats-type

+--ro egress-power-loss

| +--ro tx? decimal64

| +--ro rx? decimal64

| +--ro loss? decimal64

| +--ro comments? string

+--ro ingress-power-loss

+--ro tx? decimal64

+--ro rx? decimal64

+--ro loss? decimal64

+--ro comments? string

URI Format


<base_URI>/running/brocade-fibrechannel-diagnostics/fibrechannel-diagnostics/ followed by theleafs as listed in the module tree.

Parameters

NOTEThe top-level container name changed from "diagnostics" to "brocade-fibrechannel-diagnostics". The previoustop-level container name "diagnostics" is still supported in this release. However, new features (Fabric OS 9.0.0or later) are not supported in the previous top-level container name "diagnostics".

brocade-fibrechannel-diagnosticsDescription: The top-level container for this module.This module allows you to manually start, restart, or stop a test running on a diagnostic port (D_Port). The portdporttest --show command displays the result of the D_Port tests. The port must be configured asa D_Port and physically connected to a second D_Port on a remote switch. Refer to the Brocade Fabric OSCommand Reference Manual for more information. The portdporttest --start command only needs to beissued on one end of the link. You can perform the following diagnostics via REST:• An electrical loopback test (supported only on 16Gp/s and 32Gp/s SFPs capable of electrical loopback).• An optical loopback test (supported only on 16Gp/s and 32Gp/s SFPs capable of optical loopback).• A link traffic test.• A link distance measurement.

NOTEOnly Dynamic D_Ports are supported by this module.

Flag: read-writeThis container has the following leafs:fibrechannel-diagnostics

Description: The list of diagnostic ports on the specified device.Flag: read-write


Broadcom


Optional: NoKey: nameThis container has the following leafs:name

Description: The name of the interface.Flag: read-writeType: stringValues: The slot and port number of the port, in “slot/port” format. This supports a maximum of 12slots and a maximum of 1024 ports.Optional: No

diagnostic-controlDescription: Manually start the test, re-initiate the test, or stop the test on a diagnostic port(D_Port).

NOTEThis is a write-only parameter and does not display in a GET request.

Flag: read-writeType: uint32Values: 0 = Terminates the diagnostics on the D_Port. 1 = Initiates the diagnostics on the D_Port.2 = Restarts the D Port diagnostic tests with the configured parameters. Option 2 is not supportedfor D_Port HBA connections.Optional: Yes

modeDescription: This indicates whether the test was started manually or automatically.Flag: read-onlyType: enumerationConfig: falseValues: manual = Test started manually (manually restarted using either the CLI or the API).automatic = Test started automatically (initiated due to a “port online” event).Optional: Yes

stateDescription: The overall test status.Flag: read-onlyType: stringConfig: falseValues:PASSED = The diagnostic test succeeded. (On the link initiator or link responder.)FAILED = The diagnostic test has failed. (On the link initiator or link responder.)FAILED (protocol error) = The diagnostic test has failed with a protocol error. (On the linkinitiator only.)IN PROGRESS = The diagnostic test is in progress. (On the link initiator only.)NOT STARTED = The diagnostic test has not started. (On the link initiator only.)SKIPPED = One or more of the three tests was skipped. (On the link initiator only.)STOPPED = The diagnostic test was stopped. (On the link initiator or link responder.)RESPONDER = The port is in “responder” state. Test results are only available at the initiator porton the remote side of the link.Optional: Yes

distanceDescription: The estimated physical distance of the length of the interswitch link in metres.


Broadcom


The link distance accuracy for SPFs or ICL ports which do not support electrical wrap or opticalwrap functionality is +/- 50 meters for 8Gp/s LWL SFPs, 8Gp/s ELWL SFPs, 10Gp/s SFPs, andICL ports, and +/- 5 meters for 16Gp/s and 16Gp/s SFPs and QSFPs.Flag: read-onlyType: int32Config: falseUnits: meterValues: -1 through 4294967295. A value of -1 indicates an unknown distance.Optional: Yes

remote-switch-wwnDescription: The WWN of the remote switch connected to this D_Port.Flag: read-onlyType: fibrechannel:wwn-typeConfig: falseValues: A valid WWN.Optional: Yes

remote-port-indexDescription: The user port index of the remote port connected to this D_Port.Flag: read-onlyType: fibrechannel:user-port-number-typeConfig: falseValues: The user port index of the remote port connected to this D_Port.Optional: Yes

electrical-loopback-testDescription: An electrical loopback test.This is supported only on 16Gp/s and 32Gp/s SFPs capable of electrical loopback.Config: falseThis container has the following leafs:result

Description: The completion status of this test.Flag: read-onlyType: stringValues:PASSED = The diagnostic test succeeded. (On the link initiator or link responder.)FAILED = The diagnostic test has failed. (On the link initiator or link responder.)IN PROGRESS = The diagnostic test is in progress. (On the link initiator only.)NOT STARTED = The diagnostic test has not started. (On the link initiator only.)SKIPPED = One or more of the three tests was skipped. (On the link initiator only.)STOPPED = The diagnostic test was stopped. (On the link initiator or link responder.)RESPONDER = The port is in “responder” state. Test results are only available at theinitiator port on the remote side of the link.UNKNOWN = The result could not be determined.Optional: Yes

commentsDescription: Additional textual information elaborating on the completion status whentest is skipped or fails.Flag: read-onlyType: comments-typeValues: Responses may include: Test failed; No SFP or chip support; See remote portresults; Remote port is not ready to start the test; Too many offline events; Remote porttest failed; Remote port WWN changed; Slot or port offline; Protocol error; Unable to


Broadcom


start/restart the test; D-Port mode mismatch, Not D-Port; Module removed; No remoteSFP or chip support; No remote port support or skipped; E_WRAP/O_WRAP set failed;User opted to skip; Test skipped due to SFP loopback error; or Test timed out. An emptystring is returned when there are no valid comments.Optional: Yes

start-timeDescription: The electrical loopback test start time.Flag: read-onlyType: fibrechannel:time-24hr-extended-typeValues: The electrical loopback test start time.Optional: YEs

estimate-timeDescription: The estimated completion time of the electrical loopback test.Flag: read-onlyType: fibrechannel:time-24hr-extended-typeValues: The estimated completion time of the electrical loopback test.Optional: Yes

optical-loopback-testDescription: An optical loopback test.This is supported only on 16Gp/s and 32Gb/s SFPs that are capable of optical loopback.Config: falseThis container has the following leafs:result

Description: The completion status of this test.Flag: read-onlyType: stringValues:PASSED = The diagnostic test succeeded. (On the link initiator or link responder.)FAILED = The diagnostic test has failed. (On the link initiator or link responder.)STOPPED = The diagnostic test was stopped. (On the link initiator or link responder.)IN PROGRESS = The diagnostic test is in progress. (On the link initiator only.)NOT STARTED = The diagnostic test has not started. (On the link initiator only.)SKIPPED = One or more of the three tests was skipped. (On the link initiator only.)RESPONDER = The port is in “responder” state. Test results are only available at theinitiator port on the remote side of the link.UNKNOWN = The result could not be determined.Optional: Yes

commentsDescription: Additional textual information elaborating on the completion status whentest is skipped or fails.Flag: read-onlyType: comments-typeValues: Responses may include: Test failed; No SFP or chip support; See remote portresults; Remote port is not ready to start the test; Too many offline events; Remote porttest failed; Remote port WWN changed; Slot or port offline; Protocol error; Unable tostart/restart the test; D-Port mode mismatch, Not D-Port; Module removed; No remoteSFP or chip support; No remote port support or skipped; E_WRAP/O_WRAP set failed;User opted to skip; Test skipped due to SFP loopback error; or Test timed out. An emptystring is returned when there are no valid comments.Optional: Yes


Broadcom


start-timeDescription: The optical loopback test start time.Flag: read-onlyType: fibrechannel:time-24hr-extended-typeValues: The optical loopback test start time.Optional: Yes

estimate-timeDescription: The estimated completion time of the optical loopback test.Flag: read-onlyType: fibrechannel:time-24hr-extended-typeValues: The estimated completion time of the optical loopback test.Optional: Yes

link-traffic-testDescription: The results of the link traffic test and any comments appended to those results.Config: falseThis container has the following leafs:result

Description: The completion status of this test.Flag: read-onlyType: result-typeValues:PASSED = The diagnostic test succeeded. (On the link initiator or link responder.)FAILED = The diagnostic test has failed. (On the link initiator or link responder.)IN PROGRESS = The diagnostic test is in progress. (On the link initiator only.)NOT STARTED = The diagnostic test has not started. (On the link initiator only.)SKIPPED = One or more of the three tests was skipped. (On the link initiator only.)STOPPED = The diagnostic test was stopped. (On the link initiator or link responder.)RESPONDER = The port is in “responder” state. Test results are only available at theinitiator port on the remote side of the link.UNKNOWN = The result could not be determined.Optional: Yes

commentsDescription: Additional textual information elaborating on the completion status whentest is skipped or fails.Flag: read-onlyType: comments-typeConfig: falseValues: Responses may include: Test failed; No SFP or chip support; See remote portresults; Remote port is not ready to start the test; Too many offline events; Remote porttest failed; Remote port WWN changed; Slot or port offline; Protocol error; Unable tostart/restart the test; D-Port mode mismatch, Not D-Port; Module removed; No remoteSFP or chip support; No remote port support or skipped; E_WRAP/O_WRAP set failed;User opted to skip; Test skipped due to SFP loopback error; or Test timed out. An emptystring is returned when there are no valid comments.Optional: Yes

start-timeDescription: The link traffic test start time.Flag: read-onlyType: fibrechannel:time-24hr-extended-typeValues: The link traffic test start time.Optional: Yes


Broadcom


estimate-timeDescription: The estimated completion time of the link traffic test.Flag: read-onlyType: fibrechannel:time-24hr-extended-typeValues: The estimated completion time of the link traffic test.Optional: yes

start-timeDescription: Time that the diagnostics run was started.Flag: read-onlyConfig: falseType: yang:date-and-timeUnits: secondsValues: Standard IETF date and time (Refer to the ietf-yang-types.yang file for formatinformation.)Optional: Yes

frame-countDescription: Number of frames sent for the link traffic test in millions. The default value is 1 for1 million frames. If more than the maximum number of frames is specified, the test uses only theinitial 65535 million frames.Note: This is mutually exclusive with the “time” leaf. A request can have only one of these leafs.Flag: read-writeType: yang:counter32Units: frame countValues: 1 through 65535. Default: 1 (1 million frames)Optional: Yes

frame-sizeDescription: The size in bytes of the diagnostics test frame.Flag: read-writeType: uint32Units: bytesValues: 36 through 2112. The frame size should be specified in multiples of 4 (4, 8, 12, 16…); ifthe value is not a multiple of 4, the nearest higher multiple of 4 value will be taken as the framesize. Default: 1024Optional: Yes

timeDescription: Specifies the time duration (in HH:MM format) for which the frame traffic test shouldrun.Note: This is mutually exclusive with the “frame-count” leaf. A request can have only one of theseleafs.Flag: read-writeType: stringUnits: secondsValues: 00:00 to 99:59 in the format <Hours><Hours>:<Minutes><Minutes>.Optional: Yes

payload-patternThe diagnostic frame payload and pattern.This container has the following mutually-exclusive leafs:pattern

Description: The name of the system-defined industry pattern to be used in the payload.Flag: read-write


Broadcom


Type: stringValues: A system-defined industry pattern name. Valid patterns are: BYTE_NOT,QUAD_NOT, WORD_NOT, BYTE_RAMP, QUAD_RAMP, WORD_RAMP, BYTE_LFSR,RANDOM, CRPAT, CSPAT, CHALF_SQ, CQTR_SQ,RDRAM_PAT, jCRPAT, jCJTPAT,jCSPAT, PRED_RAND, SMI_TEST, CJPAT, QUAD_NOTP, JSPAT, JTSPAT. Use theFabric OS datatypeshow command to get the frame pattern details as a list. Default:jCRPATOptional: Yes

payloadDescription: The user-defined payload pattern. The payload range should be0x1-0xffffffff.Flag: read-writeType: stringValues: 32 hexadecimal characters.Optional: Yes

fecDescription: Switch forward error correction (FEC) status for diagnostic testing.This option is not supported on ports configured with Dense Wavelength Division Multiplexing(DWDM).This container has the following leafs:enable

Description: FEC status on the specified switch.When FEC is enabled on a port, the sender adds systematically generated error-correcting code (ECC) to its data transmission. This mechanism allows the receiver todetect and correct errors without needing to get additional information from the sender.This leaf only supports enabling FEC for D_Port testing. It is not possible to disable FECthrough REST.Flag: read-writeType: enumerationValues: yes = FEC is enabled. no = FEC is disabled.Optional: Yes

activeDescription: FEC state on the specified switch.The FEC state can be active or inactive. Active indicates that FEC is enabled and actuallyrunning. Inactive can indicate either of two conditions: FEC is enabled but not runningdue to some error condition (for example, FEC may not be enabled on both ends of thelink), or FEC is disabled and therefore inactive.Flag: read-onlyType: enumerationConfig: falseValues: yes = FEC is active. no = FEC is not active or is disabled.Optional: Yes

optionDescription: Indicates whether the D_Port diagnostic test is using FEC.Flag: read-onlyType: enumerationConfig: falseValues: yes = FEC is used in D_Port tests. no = FEC is not used in D_Port tests.Optional: Yes


Broadcom


rt-latencyDescription: Roundtrip link latency is the time required for light to travel from a given port to theport at the remote side of the link and back.Flag: read-onlyType: uint32Units: nanosecondsConfig: falseValues: 0 to 4294967295.Optional: Yes

buffers-requiredDescription: Number of buffers required for the given distance and speed.No matter what size of the test frame is, the number of buffers required is calculated for 2112-byteframes.Flag: read-onlyType: stringConfig: falseUnits: buffer countValues: A text string recording 1 to the maximum number of buffers supported by the platform.Default: Based on the existing switch configuration.Optional: Yes

end-timeDescription: Time that the diagnostics run ended.Flag: read-onlyConfig: falseType: yang:date-and-timeUnits: secondsValues: Standard date and time (Refer to the ietf-yang-types.yang file for format information.)Optional: Yes

crDescription: Switch Credit Recovery status. This leaf only supports enabling Credit Recovery forD_Port testing.This container has the following leafs:enable

Description: Credit Recovery feature status on the specified switch.Flag: read-writeType: enumerationValues: yes = Credit Recovery is enabled. no = Credit Recovery is disabled.Optional: Yes

activeDescription: Credit Recovery state on the specified switch.Flag: read-onlyType: enumerationConfig: falseValues: yes = Credit Recovery is active. no = Credit Recovery is not active.Optional: Yes

optionDescription: Indicates whether the D_Port diagnostic test is using Credit Recovery.Flag: read-onlyType: enumerationConfig: false


Broadcom


Values: yes = Credit Recovery is used in D_Port tests. no = Credit Recovery is not usedin D_Port tests.Optional: Yes

failure-reportDescription: Displays if there are errors on the local port and remote port.Config: falseThis list has the following leafs:errors-detected-local

Description: This parameter is deprecated. Use the failure-report-local-details listinstead. Errors detected on the local port.Flag: read-onlyType: enumerationValues: yYes = Errors were detected on the local port. no = Errors were not detected onthe local port.Optional: Yes

errors-detected-remoteDescription: This parameter is deprecated. Use the failure-report-remote-details listinstead. Errors detected on the remote port.Flag: read-writeType: enumerationValues: yes = Errors were detected on the remote port. no = Errors were not detected onthe remote port.Optional: Yes

failure-report-local-errorsDescription: A list of the local port errors.Flag: read-onlyConfig: falseOptional: NoThis container has the following leaf:error

Description: An error statisic on the local port.Flag: read-onlyType: error-stats-typeConfig: falseValues: none = Errors were not detected on the port. generic = Generic errorencountered in the test. enc-in = Encoding errors inside of frames. crc-err =Frames with CRC errors. trunc-frame = Frames shorter than the minimum.frame-too-long = Frames longer than the maximum. bad-eof = Frames withbad end-of-frame. enc-out = Encoding error outside of frames. bad-os = Invalidordered set. c3-discard = Class 3 frames discarded. rx-c3-timeout = Class3 receive frames discarded due to timeout. tx-c3-timeout = Class 3 transmitframes discarded due to timeout. unroutable = Frames that are unroutable.unreachable = Frames with an unreachable destination. other-discard =Other C3 frame discards. link-failure = Link failures. sync-loss = Loss ofsynchronization. signal-loss = Loss of signal. prim-seq-proto = Primitivesequence protocol error. inv-tx-word = Invalid transmit frames. invalid-crc =CRC error with good EOF. delimiter-err = Frame delimiter errors. addr-id-err= Address ID errors. link-reset-in = Link resets received. link-reset-out = Linkresets transmitted. port-ols-in = OLS primitives received. port-ols-out = OLSprimitives transmitted. inv-arb = Invalid ARB. single-credit-loss = Single vcrdy/frame loss on link. multi-credit-loss = Multiple vcrdy/frame loss on link. fec-


Broadcom


uncorrected = FEC uncorrected errors. pcs-block-error = PCS block errors.unknown-error = Maximum number of error statistics.Optional: No

failure-report-remote-errorsDescription: A list of the remote port errors.Flag: read-onlyConfig: falseOptional: NoThis container has the following leaf:error

Description: An error statisic on the remote port.Flag: read-onlyType: error-stats-typeConfig: falseValues: none = Errors were not detected on the port. generic = Generic errorencountered in the test. enc-in = Encoding errors inside of frames. crc-err =Frames with CRC errors. trunc-frame = Frames shorter than the minimum.frame-too-long = Frames longer than the maximum. bad-eof = Frames withbad end-of-frame. enc-out = Encoding error outside of frames. bad-os = Invalidordered set. c3-discard = Class 3 frames discarded. rx-c3-timeout = Class3 receive frames discarded due to timeout. tx-c3-timeout = Class 3 transmitframes discarded due to timeout. unroutable = Frames that are unroutable.unreachable = Frames with an unreachable destination. other-discard =Other C3 frame discards. link-failure = Link failures. sync-loss = Loss ofsynchronization. signal-loss = Loss of signal. prim-seq-proto = Primitivesequence protocol error. inv-tx-word = Invalid transmit frames. invalid-crc =CRC error with good EOF. delimiter-err = Frame delimiter errors. addr-id-err= Address ID errors. link-reset-in = Link resets received. link-reset-out = Linkresets transmitted. port-ols-in = OLS primitives received. port-ols-out = OLSprimitives transmitted. inv-arb = Invalid ARB. single-credit-loss = Single vcrdy/frame loss on link. multi-credit-loss = Multiple vcrdy/frame loss on link. fec-uncorrected = FEC uncorrected errors. pcs-block-error = PCS block errors.unknown-error = Maximum number of error statistics.Optional: No

egress-power-lossDescription: The power values and power loss in the transmitting (outbound) path.The following values are displayed: power transmitted from the local side of the link (Tx), powerreceived on the remote side of the link (Rx), the power loss, that is, the relative difference inpower (Diff), and the status of the cable power loss (No loss, within tolerable limits, or outside oftolerable limits).Config: falseThis container has the following leafs:tx

Description: The power transmitted from the local side of the link (Tx). If the D_Port testis failing or not started, the transmit value is not available and this parameter does notdisplay.Flag: read-onlyType: decimal64Units: dBmValues: -9.99 to 9.99Optional: Yes


Broadcom


rxDescription: The power received on the remote side of the link (Rx). If the D_Port testis failing or not started, the transmit value is not available and this parameter does notdisplay.Flag: read-onlyType: decimal64Units: dBmValues: -9.99 to 9.99Optional: Yes

lossDescription: The power lost in transmission (the relative difference in power) on thispath. If the value is not available, this parameter does not display.Flag: read-onlyType: decimal64Units: dBmValues: -9.99 to 9.99Optional: Yes

commentsDescription: Status of the power loss. If the value is not available, this parameter doesnot display.Flag: read-onlyType: stringValues: No Loss, Cable power loss is within tolerable limits, or Cable power loss isoutside tolerable limits.Optional: Yes

ingress-power-lossDescription: The power values and power loss in the receiving (inbound) path.The following values are displayed: power transmitted from the local side of the link (Tx), powerreceived on the remote side of the link (Rx), the power loss, that is, the relative difference inpower (Diff), and the status of the cable power loss (No loss, within tolerable limits, or outside oftolerable limits).Config: falseThis container has the following leafs:tx

Description: Power transmitted from the remote side of the link (Tx). If the D_Port testis failing or not started, the transmit value is not available and this parameter does notdisplay.Flag: read-onlyType: decimal64Units: dBmValues: -9.99 to 9.99Optional: Yes

rxDescription: The power received on the local side of the link (Rx). If the D_Port testis failing or not started, the transmit value is not available and this parameter does notdisplay.Flag: read-onlyType: decimal64Units: dBmValues: -9.99 to 9.99Optional: Yes


Broadcom


lossDescription: The power lost in transmission (the relative difference in power) on thispath. If the value is not available, this parameter does not display.Flag: read-onlyType: decimal64Units: dBmValues: -9.99 to 9.99Optional: Yes

commentsDescription: The status of the power loss. If the value is not available, this parameterdoes not display.Flag: read-onlyType: stringValues: No Loss, Cable power loss is within tolerable limits, or Cable power loss isoutside tolerable limits.Optional: Yes

Supported Methods

The GET, HEAD, PATCH, and OPTIONS are supported in this module.

ExamplesRetrieving Diagnostic Port DetailsThis example uses a GET request to retrieve the details of the diagnostic port.StructureGET <base_URI>/running/brocade-fibrechannel-diagnostics/fibrechannel-diagnosticsURIGET https://10.10.10.10/rest/running/brocade-fibrechannel-diagnostics/fibrechannel-diagnostics


<Response>

<fibrechannel-diagnostics>

<name>0/0</name>

<diagnostic-control>0</diagnostic-control>

<mode>Manual</mode>

<state>PASSED </state>

<distance>1</distance>

<electrical-loopback>

<Result>PASSED</Result>

<Comments>----------</Comments>

</electrical-loopback>

<optical-loopback>

<Result>SKIPPED</Result>



Broadcom


</optical-loopback>

<remote-loopback>



</remote-loopback>

<start-time>Sun Oct 1 22:13:01 2017</start-time>

<frame-count>2</frame-count>

<frame-size>2112</frame-size>

<time></time>

<payload-pattern>

<Pattern>0</Pattern>

<Payload>0</Payload>

</payload-pattern>

<fec>

<Enable>yes</Enable>

<Active>no</Active>

</fec>

<cr>


<Active>no</Active>

</cr>

<rt-latency>303</rt-latency>

<required-buffers>Buffers required: 1 (for 2112 byte frames at 16Gbps speed)</required-

buffers>

<failure-report>

<errors-detected-local>No</errors-detected-local>

<errors-detected-remote>No</errors-detected-remote>

</failure-report>

<end-time>Sun Oct 1 22:13:35 2017</end-time>

<egress-powerloss>

<TX>-4.2</TX>

<RX>-3.5</RX>

<LOSS>0.0</LOSS>

<COMMENTS>No Loss</COMMENTS>

</egress-powerloss>

<ingress-powerloss>

<TX>-2.2</TX>

<RX>-2.8</RX>

<LOSS>0.6</LOSS>

<COMMENTS>Cable power loss is within tolerable limits</COMMENTS>

</ingress-powerloss>

</fibrechannel-diagnostics>


<name>0/1</name>


<mode>Manual</mode>

<state>PASSED</state>

<distance>1</distance>

<electrical-loopback>



</electrical-loopback>

<optical-loopback>


Broadcom


<Result>SKIPPED</Result>


</optical-loopback>

<remote-loopback>



</remote-loopback>

<start-time>Wed Mar 1 22:13:01 2017</start-time>



<time></time>

<payload-pattern>

<Pattern>0</Pattern>

<Payload>0</Payload>

</payload-pattern>

<fec>


<Active>no</Active>

</fec>

<cr>


<Active>no</Active>

</cr>


<required-buffers>Buffers required: 1 (for 2112 byte frames at 16Gbps speed)</required-

buffers>

<failure-report>

<errors-detected-local>No</errors-detected-local>

<errors-detected-remote>No</errors-detected-remote>

</failure-report>

<end-time>Sun Oct 1 22:13:35 2017</end-time>

<egress-powerloss>

<TX>-2.2</TX>

<RX>-2.8</RX>

<LOSS>0.6</LOSS>

<COMMENTS>Cable power loss is within tolerable limits</COMMENTS>

</egress-powerloss>

<ingress-powerloss>

<TX>-4.2</TX>

<RX>-3.5</RX>

<LOSS>0.0</LOSS>

<COMMENTS>No Loss</COMMENTS>

</ingress-powerloss>


</Response>

Retrieving the Test Status of a Diagnostic PortThis example uses a GET request to discover the status of the diagnostic port at the address “0/1”.StructureGET <base_URI>/running/brocade-fibrechannel-diagnostics/fibrechannel-diagnostics/name/<port_ID>/state


Broadcom


URINotice that the slash character in the name resource is encoded as “%2f”.GET https://10.10.10.10/rest/running/brocade-fibrechannel-diagnostics/fibrechannel-diagnostics/

name/0%2f1/state



<Response>


<name>0/1</name>

<state>PASSED</state>


</Response>

Starting a Diagnostic Port TestThis example uses a PATCH request to start a diagnostic port test on port “0/1” with a frame count of 2 and aframe size of 2112 bytes.StructurePATCH <base_URI>/running/brocade-fibrechannel-diagnostics/fibrechannel-diagnostics/name/<portID>/diagnostic-control/<instruction>URIPATCH https://10.10.10.10/rest/running/brocade-fibrechannel-diagnostics/fibrechannel-diagnostics/

name/0%2f1/diagnostic-control/1

Request Body


Response BodyWhen the operation is successful, the response contains an empty message body and a “204 No Content”status in the headers.Stopping a Diagnostic Port TestThis example uses a PATCH request to stop the diagnostic port test on port “0/1”.StructurePATCH <base_URI>/running/brocade-fibrechannel-diagnostics/fibrechannel-diagnostics/name/<port_ID>/diagnostic-control/<instruction>URIPATCH https://10.10.10.10/rest/running/brocade-fibrechannel-diagnostics/fibrechannel-diagnostics/

name/0%2f1/diagnostic-control/0



Broadcom


Response BodyWhen the operation is successful, the response contains an empty message body and a “204 No Content”status in the headers.

History



Fabric OS 8.2.1b The top-level container name changed from "diagnostics" to "brocade-fibrechannel-diagnostics". The previous top-level container name "diagnostics" is still supported in thisrelease. However, new features (Fabric OS 9.0.0 or later) are not supported in the previoustop-level container name "fabric".

Fabric OS 9.0.0 This API call was modified to add the remote-switch-wwn and remote-port-indexparameters to the 'brocade-fibrechannel-diagnostics' container; add the start-time andestimate-time parameters to the electrical-loopback-test, optical-loopback-test, and link-traffic-test containers; add the failure-report-local-errors and failure-report-remote-errorscontainers to the failure-report container.


Broadcom


brocade-fibrechannel-logical-switchThis module retrieves information of all logical switches in a operational chassis. This module also provides a logicalswitch configuration.

It assumes a knowledge of Virtual Fabrics and logical switches as performed in Fabric OS. For more information, refer toManaging Virtual Fabrics in the Brocade Fabric OS Administrator's Guide.

NOTEThe brocade-fibrechannel-logical-switch module is supported in Fabric OS 8.2.0a and later.

Module Tree

This is the tree view of the module from the brocade-fibrechannel-logical-switch.yang-tree.txt file. See YANG ModuleOverview for YANG node field definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-fibrechannel-logical-switch

+--rw brocade-fibrechannel-logical-switch

+--rw fibrechannel-logical-switch* [fabric-id]

+--rw fabric-id uint32

+--ro switch-wwn? fibrechannel:wwn-type

+--rw base-switch-enabled? uint8

+--ro default-switch-status? uint8

+--rw logical-isl-enabled? uint8

+--rw ficon-mode-enabled? uint8

+--rw port-member-list

| +--rw port-member* fibrechannel:slot-port-name-type

+--rw ge-port-member-list

+--rw port-member* fibrechannel:slot-port-name-type

URI Format


<base_URI>/running/brocade-fibrechannel-logical-switch/fibrechannel-logical-switch to retrievelogical switch information or configure a logical switch.

Parameters

NOTEThe top-level container name changed from "logical-switch" to "brocade-fibrechannel-logical-switch". Theprevious top-level container name "logical-switch" is still supported in this release. However, new features(Fabric OS 9.0.0 or later) are not supported in the previous top-level container name "logical-switch".

brocade-fibrechannel-logical-switchDescription: The base container for this module.Flag: read-writeThis container has the following leafs:fibrechannel-logical-switch

Description: Provides logical switch state parameters of all configured logical switches.Flag: read-writeKey: fabric-idThis container has the following leafs:


Broadcom


fabric-idDescription: The virtual fabric identification (VFID) of the logical switch.Flag: read-writeType: uint32Value: 1 to 128 alpha characters.Optional: No

switch-wwnDescription: The switch WWN, which is a unique numeric identifier for the switch assigned bythe chassis.Flag: read-onlyType: fibrechannel:wwn-typeValue: A valid WWN for the switch.Config: falseOptional: Yes

base-switch-enabledDescription: The logical switch that is the base switch in the chassis. You can configure the baseswitch when creating a logical switch. Only available when XISL and ficon are disabled.Flag: read-writeType: uint8Value: 0 = Disabled. 1 = Enabled. Default is 0.Optional: Yes

default-switch-statusDescription: The logical switch is the default switch in the chassis.Flag: read-onlyType: uint8Value: 0 = Disabled. 1 = Enabled.Config: falseOptional: Yes

logical-isl-enabledDescription: Enables logical ISLs (LISLs) on a logical switch. You can only disable LISLs whenyou create a logical switch. Only available when base switch is disabled (base-switch-enabled=0).Flag: read-writeType: uint8Value: 0 = Disabled. 1 = Enabled. Default is 1.Optional: Yes

ficon-mode-enabledDescription: Indicates the FICON mode. Only available when base switch is disabled (base-switch-enabled=0) and default switch status is disabled (default-switch-status=0). You cannotdisable FICON mode in a logical switch.Flag: read-writeType: uint8Value: 0 = Disabled. 1 = Enabled. Default is 0.Optional: Yes

port-member-listDescription: A list of logical switch port interface (fibre channel and flex) names.Flag: read-writeThis container has the following leaf:port-member

Description: The name of the fibre channel interface including the slot and port number(slot/port). This list only contains fibre channel ports and flex ports.


Broadcom


Flag: read-writeType: fibrechannel:slot-port-name-typeValue: The fibre channel or flex port name (slot/port_name).Optional: Yes

ge-port-member-listDescription: A list of logical switch port interface Gigabit Ethernet (GE) names.Flag: read-writeThis container has the following leaf:port-member

Description: The name of the Gigabit Ethernet (GE) interface including the slot and portnumber (slot/port). This list only contains GE ports.Flag: read-writeType: fibrechannel:slot-port-name-typeValue: The GE port name (slot/port_name).Optional: Yes

Supported methods

The GET, POST, PATCH, DELETE, OPTIONS, and HEAD operations are supported in this module.

ExamplesRetrieving Logical Switch InformationThis example uses a GET request to retrieve the logical switch information.StructureGET <base_URI>/running/brocade-fibrechannel-logical-switch/fibrechannel-logical-switchURIGET https://10.10.10.10/rest/running/brocade-fibrechannel-logical-switch/fibrechannel-logical-

switch

Request BodyNo request body is required.Response BodyWhen the operation is successful, the response has a message body similar to the following, and a “200 OK”status appears in the headers.


<Response>

<fibrechannel-logical-switch>

<fabric-id>128</fabric-id>

<base-switch-enabled>0</base-switch-enabled>

<switch-wwn>10:00:00:05:1e:b7:44:00</switch-wwn>

<default-switch-status>1</default-switch-status>

<logical-isl-enabled>1</logical-isl-enabled>

<ficon-mode-enabled>0</ficon-mode-enabled>

<port-member-list>

<port-member>7/0</port-member>





Broadcom









</port-member-list>

<ge-port-member-list/>

</fibrechannel-logical-switch>








<port-member-list>





</port-member-list>










<port-member-list/>










<port-member-list/>










<port-member-list/>


Broadcom











<port-member-list/>



</Response>

Retrieving Information for a Logical Switch InstanceThis example uses a GET request to retrieve logical switch information for fabric ID 10.StructureGET <base_URI>/running/brocade-fibrechannel-logical-switch/fibrechannel-logical-switch/fabric-id/fabric_idURIGET https://10.10.10.10/rest/running/brocade-fibrechannel-logical-switch/fibrechannel-logical-

switch/fabric-id/10

No request body is required.Response BodyWhen the operation is successful, the response has a message body similar to the following, and a “200 OK”status appears in the headers.


<Response>








<port-member-list>





</port-member-list>



</Response>

Creating a Logical SwitchThis example uses a POST request to create logical switch "20".


Broadcom


NOTEREST requests time out after 3 minutes; therefore, it is recommended that you do not createmore than 3 logical switches in one POST request.

StructurePOST <base_URI>/running/brocade-fibrechannel-logical-switch/fibrechannel-logical-switchURIPOST https://10.10.10.10/rest/running/brocade-fibrechannel-logical-switch/fibrechannel-logical-

switch

Request Body




Response BodyWhen the operation is successful, there is no response, and a “201 Created” status appears in the headers.Assigning Ports to a Logical SwitchYou can use a POST or PATCH request to assign ports to a logical switch. You must use POST to assign portsto a new logical switch. You can use both a POST or PATCH request to assign ports to an existing logicalswitch. However, when you use a PATCH request to assign ports to an existing logical switch, the PATCHrequest replaces the existing port list with the new port list.

NOTEYou cannot use a PATCH request to assign ports to the default logical switch. You cannotuse a PATCH or POST request to send an empty port list to a logical switch.

This example uses a POST request to assign three ports to a logical switch "20".StructurePOST <base_URI>/running/brocade-fibrechannel-logical-switch/fibrechannel-logical-switchURIPOST https://10.10.10.10/rest/running/brocade-fibrechannel-logical-switch/fibrechannel-logical-

switch

Request Body



<port-member-list>




</port-member-list>


Response BodyWhen the operation is successful, there is no response, and a “201 Created” status appears in the headers.


Broadcom


Creating a FICON Logical SwitchThis example uses a POST request to create FICON logical switch "20", enable FICON mode, and assignports to the new FICON logical switch.

NOTEREST requests time out after 3 minutes; therefore, it is recommended that you do not createmore than 3 logical switches in one POST request.

StructurePOST <base_URI>/running/brocade-fibrechannel-logical-switch/fibrechannel-logical-switchURIPOST https://10.10.10.10/rest/running/brocade-fibrechannel-logical-switch/fibrechannel-logical-

switch

Request Body




<port-member-list>




</port-member-list>


Response BodyWhen the operation is successful, there is no response, and a “201 Created” status appears in the headers.To complete the FICON configuration and configure FICON CUP, refer to the Brocade Fabric OS FICONConfiguration Guide. The brocade-ficon module allows management of some FICON Control Unit Port (CUP)and FICON logical switch parameters as well as providing FICON-related information from the ManagementServer (such as RNID, LIRR, and RLIR data). To use the brocade-ficon module, refer to brocade-ficon.Deleting a Logical SwitchThis example uses a DELETE request to delete a logical switch "23".

NOTEYou cannot delete the default logical switch.

StructureDELETE <base_URI>/running/brocade-fibrechannel-logical-switch/fibrechannel-logical-switchURIDELETE https://10.10.10.10/rest/running/brocade-fibrechannel-logical-switch/fibrechannel-logical-

switch

Request Body





Broadcom


Response BodyWhen the operation is successful, there is no response, and a “204 No Content” status appears in theheaders.Removing Ports From a Logical SwitchThis example uses a DELETE request to remove 2 ports from logical switch "20".StructureDELETE <base_URI>/running/brocade-fibrechannel-logical-switch/fibrechannel-logical-switchURIDELETE https://10.10.10.10/rest/running/brocade-fibrechannel-logical-switch/fibrechannel-logical-

switch

Request Body



<port-member-list>



</port-member-list>


Response BodyWhen the operation is successful, there is no response, and a “204 No Content” status appears in theheaders.Enabling the Base SwitchYou must use a POST request to enable a new logical switch as the base switch. You must use a PATCHrequest to enable an existing logical switch as the base switch.

NOTEOnly one logical switch can be configured as the base switch per chassis.

This example uses a POST request to enable a new logical switch "23" as the base switch.StructurePOST <base_URI>/running/brocade-fibrechannel-logical-switch/fibrechannel-logical-switchURIPOST https://10.10.10.10/rest/running/brocade-fibrechannel-logical-switch/fibrechannel-logical-

switch

Request Body







Broadcom


Disabling the Base SwitchYou must use a PATCH request to disable an existing logical switch as the base switch. This example uses aPATCH request to disable logical switch "23" as the base switch.StructurePATCH <base_URI>/running/brocade-fibrechannel-logical-switch/fibrechannel-logical-switchURIPATCH https://10.10.10.10/rest/running/brocade-fibrechannel-logical-switch/fibrechannel-logical-

switch

Request Body





Response BodyWhen the operation is successful, there is no response, and a “204 No Content” status appears in theheaders.Enabling the FICON Mode on a Logical SwitchYou must use a POST request to enable FICON mode on a new logical switch. You must use a PATCHrequest to enable FICON mode on an existing logical switch. This example uses a POST request to createnew logical switch "23" with FICON mode enabled.StructurePOST <base_URI>/running/brocade-fibrechannel-logical-switch/fibrechannel-logical-switchURIPOST https://10.10.10.10/rest/running/brocade-fibrechannel-logical-switch/fibrechannel-logical-

switch

Request Body





Response BodyWhen the operation is successful, there is no response, and a “201 Created” status appears in the headers.Enabling the Logical ISL on a Logical SwitchLogical ISLs can be disabled during logical switch creation with the POST request, and later enabled with aPATCH request. This example uses a PATCH request to enable logical ISLs on logical switch "23".StructurePATCH <base_URI>/running/brocade-fibrechannel-logical-switch/fibrechannel-logical-switchURIPATCH https://10.10.10.10/rest/running/brocade-fibrechannel-logical-switch/fibrechannel-logical-

switch


Broadcom


Request Body





Response BodyWhen the operation is successful, there is no response, and a “204 No Content” status appears in theheaders.Disabling Logical ISL on a Logical SwitchYou can only disable logical ISL during logical switch creation. You must use a POST request to disable logicalISL and create a new logical switch.

NOTEYou cannot disable logical ISL on an existing logical switch.

This example uses a POST request to disable logical ISL on new logical switch "24".StructurePOST <base_URI>/running/brocade-fibrechannel-logical-switch/fibrechannel-logical-switchURIPOST https://10.10.10.10/rest/running/brocade-fibrechannel-logical-switch/fibrechannel-logical-

switch

Request Body




<port-member-list>




</port-member-list>



History



Fabric OS 8.2.1b The top-level container name changed from "logical-switch" to "brocade-fibrechannel-logical-switch". The previous top-level container name "logical-switch" is still supported inthis release.


Broadcom


brocade-fibrechannel-routingThe Fibre Channel Routing module enables you to configure FC routing between two or more fabrics without mergingthose fabrics.

Module Tree

This is the tree view of the module from the brocade-brocade-fibrechannel-routing.yang-tree.txt file. See YANG ModuleOverview for YANG node field definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-fibrechannel-routing

+--rw brocade-fibrechannel-routing

+--rw routing-configuration {fibrechannel:fibrechannel_switch_platform}?

| +--rw maximum-lsan-count? uint32

| +--rw backbone-fabric-id? fibrechannel:fabric-id-type

| +--rw shortest-ifl? boolean

| +--rw lsan-enforce-tags

| | +--rw tag* string

| +--rw lsan-speed-tag? string

+--ro lsan-zone* [] {fibrechannel:fibrechannel_switch_platform}?

| +--ro edge-fabric-id? fibrechannel:fabric-id-type

| +--ro zone-name? zone:zoning-name-type

| +--ro members

| +--ro member* fibrechannel:wwn-type

+--ro lsan-device* [] {fibrechannel:fibrechannel_switch_platform}?

| +--ro source-fabric-id? fibrechannel:fabric-id-type

| +--ro device-wwn? fibrechannel:wwn-type

| +--ro proxy-pid? fibrechannel:fcid-hex-string-type

| +--ro imported-fabric-id? fibrechannel:fabric-id-type

| +--ro physical-pid? fibrechannel:fcid-hex-string-type

| +--ro device-status? fcr-device-state

+--rw edge-fabric-alias* [edge-fabric-id] {fibrechannel:fibrechannel_switch_platform}?

+--rw edge-fabric-id fibrechannel:fabric-id-type

+--rw alias-name? string

URI Format


• <base_URI>/running/brocade-fibrechannel-routing/routing-configuration followed by the leafs aslisted in the module tree.

• <base_URI>/running/running/brocade-fibrechannel-routing/routing-configuration to configureFC routing.

• <base_URI>/running/brocade-fibrechannel-routing/lsan-zone to view the LSAN zone information.• <base_URI>/running/brocade-fibrechannel-routing/lsan-device to view the LSAN zone device

information.• <base_URI>/running/brocade-fibrechannel-routing/edge-fabric-alias to configure the alias name

for the edge fabric.• <base_URI>/running/brocade-chassis/chassis to enable or disable FC routing, if FC routing is supported.• <base_URI>/running/brocade-interface/fibrechannel to configure the edge fabric ID and preferred

domain ID, enabled the EX_Port, and view the IP address of the switch connected to the EX_Port.


Broadcom


Parametersbrocade-fibrechannel-routing

Description: The top-level container for FC routing information for both Backbone and EX_Ports..Flag: read-writeOptional: NoThis container has the following leafs:routing-configuration

Description: A list of FC routing configuration parameters. Note that the switch must be an FC switch inNative mode.Flag: read-writeOptional: NoThis list has the following leafs:maximum-lsan-count

Description: The maximum LSAN count.Flag: read-writeType: uint32Value: The valid values are 3000, 5000, and 7500. The default is 3000.Optional: No

backbone-fabric-idDescription: The backbone fabric identifier. The backbone fabric ID uniquely identifies a fabricfor FC router configurations. The backbone fabric is the fabric attached to the U_Ports of theswitch, for example, E_Ports or F_Ports. The backbone fabric ID must be unique across allfabrics connected to the FC Router.Flag: read-writeType: fibrechannel:fabric-id-typeValue: The backbone fabric identifier.Optional: No

shortest-iflDescription: Enables or disables the shortest IFL (inter-fabric link) mode in the FC router.When the shortest IFL mode is enabled, the FC router can choose a lowest-cost IFL path in thebackbone fabric.Flag: read-writeType: booleanValue: true: Enables the shortest IFL mode. false: Disables the shortest IFL mode.Optional: No

lsan-enforce-tagsDescription: A list of LSAN enforcement tags.Optional: Notag

Description: A valid LSAN enforcement tag. Accepts only the LSANs from the edgefabric that matches the specified tag string into the local FCR database. A valid tag is astring with a maximum of eight characters. The maximum configurable enforce tags iseight. If a speed tag is configured, you can only configure seven enforce tags. Empty tagsare not allowed.Type: stringValue: An LSAN enforcement tag.Optional: No


Broadcom


lsan-speed-tagDescription: The LSAN speed tag. Allows the FCR to always import these target devices to thehosts specified in the LSANs that match the speed tag. Only one speed tag is allowed per FCrouter. Empty tags are not allowed.Type: stringValue: The LSAN speed tag.Optional: No

lsan-zoneDescription: A list of LSAN zone members in a particular zone. if-feature"fibrechannel:fibrechannel_switch_platform"Optional: Noedge-fabric-id

Description: The identifier of the fabric in which the LSAN zone was created.Type: fibrechannel:fabric-id-typeValue: A fabric ID.Optional: No

zone-nameDescription: The name of the zone.Type: zone:zoning-name-typeValue: A zone name.Optional: No

membersDescription: A list of LSAN zone members of a particular zone.Optional: Nomember

Description: The WWN of the zone member.Type: fibrechannel:wwn-typeValue: The WWN of the zone memberOptional: No

lsan-deviceDescription: The LSAN information for each LSAN device. An LSAN device can be a physicaldevice, meaning that it physically exists in the fabric, or it can be a proxy device. if-feature"fibrechannel:fibrechannel_switch_platform"Config: falseOptional: Nosource-fabric-id

Description: The fabric in which the device is physically present.Type: fibrechannel:fabric-id-typeValue: The fabric in which the device is physically present.Optional: No

device-wwnDescription: The WWN of the device.Type: fibrechannel:wwn-typeValue: The WWN of the device.Optional: No

proxy-pidDescription: The port ID (PID) of the proxy device. when '../device-status = imported';Type: fibrechannel:fcid-hex-string-typeValue: The PID of the proxy device.


Broadcom


Optional: Noimported-fabric-id

Description: The imported fabric ID of the proxy device. when '../device-status = imported';Type: fibrechannel:fabric-id-typeValue: The imported fabric ID of the proxy device.Optional: No

physical-pidDescription: The port ID of the physical device. when '../device-status = imported or ../device-status = exist';Type: fibrechannel:fcid-hex-string-typeValue: The port ID of the physical device.Optional: No

device-statusDescription: The status of the LSAN device.Type: fcr-device-stateValue: Valid values include:

• configured: The device is configured to be in an LSAN, but the device is neither imported norexists in this fabric.

• initializing: The device is in an intermediate state. It is not yet imported into the fabric.• exist: The device exists in the fabric (the fabric of the zone entry).• imported: The device has been imported (proxy created) into the fabric.

Optional: Noedge-fabric-alias

Description: The alias name associated with the edge fabric ID. if-feature"fibrechannel:fibrechannel_switch_platform";Key: edge-fabric-idOptional: Noedge-fabric-id

Description: The ID of the fabric in which the LSAN zone was created.Type: fibrechannel:fabric-id-typeValue: The ID of the fabric in which the LSAN zone was created.Optional: No

alias-nameDescription: The alias name for the specific edge fabric ID.Type: stringValue: The alias name for the specific edge fabric ID.Optional: No

Supported Methods

The GET, OPTIONS, PATCH, POST, DELETE, and HEAD operations are supported in this module.

Examples

This section provides basic examples for using the brocade-fibrechannel-routing module.

Viewing the FC-FC Routing Configuration

This example uses a GET request to retrieve the FC-FC routing configuration for the device to which the request is sent.


Broadcom


Structure

GET <base_URI>/running/brocade-fibrechannel-routing/routing-configuration

URI

GET https://10.10.10.10/rest/running/brocade-fibrechannel-routing/routing-configuration

Request Body


Response Body



<Response>

<routing-configuration>

<maximum-lsan-count>7500</maximum-lsan-count>

<backbone-fabric-id>100</backbone-fabric-id>

<shortest-ifl>true</shortest-ifl>

<lsan-enforce-tags/>

<lsan-speed-tag/>

</routing-configuration>

</Response>

Configuring FC-FC Routing

NOTEBefore you set or modify the backbone-fabric-id, the switch and FCR must be disabled.

This example uses a PATCH request to configure the following options for FC-FC routing.

• Set the maximum LSAN count to 7500.• Set the backbone fabric ID to 100.• Enable the shortest IFL mode.

Structure

PATCH <base_URI>/running/brocade-fibrechannel-routing/routing-configuration

URI

PATCH https://10.10.10.10/rest/running/brocade-fibrechannel-routing/routing-configuration

Request Body






Response Body

When the operation is successful, the response contains an empty message body and a “201 Created” status appears inthe header.


Broadcom


Setting the Maximum LSAN Count

This example uses a PATCH request to set the maximum LSAN count to 3000.

Structure


URI


Request Body




Response Body


Assigning a Backbone Fabric ID

This example uses a PATCH request to assign a backbone fabric ID to 101.

NOTEYou must disable the switch to change the backbone fabric ID.

Structure


URI


Request Body




Response Body


Enabling Shortest IFL Mode

You can direct traffic flow to take the shortest path between host and target when multiple FC routers in the backbone areconnected to an edge fabric.

This example uses a PATCH request to enable the shortest IFL mode.

Structure



Broadcom


URI


Request Body




Response Body


Disabling Shortest IFL Mode

This example uses a PATCH request to disable the shortest IFL mode.

Structure


URI


Request Body




Response Body


Configuring Enforce LSAN Tags

Use the Enforce tag to achieve better scalability in the FC router by limiting the number of LSAN zones that are enforcedin that FC router.

This example uses a POST request to configure a enforce LSAN tags for lsan_abc, lsan_xyz, and lsan_fab1.

NOTEYou must disable the switch to change the LSAN enforce tags.

Structure

POST <base_URI>/running/brocade-fibrechannel-routing/routing-configuration

URI

POST https://10.10.10.10/rest/running/brocade-fibrechannel-routing/routing-configuration

Request Body


Broadcom



<lsan-enforce-tags>

<lsan_abc>

<lsan_xyz>

<lsan_fab1>

</lsan-enforce-tags>


Response Body


Configuring a Speed LSAN Tag

Use the Speed tag to speed up the discovery process by importing devices into the remote edge fabrics when the devicescome online, regardless of the state of the host.

This example uses a PATCH request to set the maximum LSAN count.

Structure


URI


Request Body


<lsan-speed-tag>mcdt</lsan-speed-tag>


Response Body


Deleting an LSAN Tag

This example uses a DELETE request to delete the test LSAN tag.

NOTEYou must disable the switch to remove the LSAN enforce tags.

Structure

DELETE <base_URI>/running/brocade-fibrechannel-routing/routing-configuration/lsan-enforce-tag/tags/<tag_name>

URI

DELETE https://10.10.10.10/rest/running/brocade-fibrechannel-routing/routing-configuration/lsan-enforce-tags/

tags/test

Request Body



Broadcom


Response Body


Viewing the LSAN Zone Information

This example uses a GET request to retrieve LSAN zone data for the device to which the request is sent.

Structure

GET <base_URI>/running/brocade-fibrechannel-routing/lsan-zone

URI

GET https://10.10.10.10/rest/running/brocade-fibrechannel-routing/lsan-zone

Request Body


Response Body



<Response>

<lsan-zone>

<edge-fabric-id>100</edge-fabric-id>

<zone-name>lsan_68162_Violin</zone-name>

<members>

<member>10:00:1c:2c:ff:14:ec:00</member>

<member>10:00:1c:2c:ff:14:ec:01</member>

<member>10:00:1c:2c:ff:14:d8:03</member>

<member>21:00:00:1b:17:18:da:f4</member>

</members>

</lsan-zone>

...

<lsan-zone>



<members>

<member>10:00:00:00:c9:f8:04:05</member>

<member>10:00:00:00:c9:f8:04:06</member>

<member>21:00:00:1b:10:11:d8:07</member>


</members>

</lsan-zone>

<lsan-zone>



<members>

<member>21:00:00:0e:1e:07:03:09</member>

<member>21:00:00:0e:1e:07:04:10</member>

<member>21:00:00:1b:10:11:d8:11</member>


</members>


Broadcom


</lsan-zone>

</Response>

Viewing the LSAN Device Information

This example uses a GET request to retrieve LSAN data for the device to which the request is sent.

Structure

GET <base_URI>/running/brocade-fibrechannel-routing/lsan-device

URI

GET https://10.10.10.10/rest/running/brocade-fibrechannel-routing/lsan-device

Request Body


Response Body



<Response>

<lsan-device>

<source-fabric-id>100</source-fabric-id>

<device-wwn>10:00:00:0e:1e:17:04:01</device-wwn>

<physical-pid>0xec0500</physical-pid>

<device-status>exist</device-status>

</lsan-device>

<lsan-device>


<device-wwn>21:00:00:0e:1e:17:03:02</device-wwn>

<physical-pid>0x2baa00</physical-pid>


</lsan-device>

...

<lsan-device>


<device-wwn>21:00:00:1b:10:11:da:f3</device-wwn>

<physical-pid>0xeb2901</physical-pid>


</lsan-device>

...

<lsan-device>


<device-wwn>20:af:00:a0:10:9f:76:a4</device-wwn>

<physical-pid>0xed0203</physical-pid>

<proxy-pid>0xcbf001</proxy-pid>

<imported-fabric-id>128</imported-fabric-id>

<device-status>imported</device-status>

</lsan-device>

...

<lsan-device>



Broadcom


<device-wwn>21:00:00:1b:10:11:d8:05</device-wwn>

<physical-pid>0xeb0001</physical-pid>

<proxy-pid>0xcbf401</proxy-pid>

<imported-fabric-id>128</imported-fabric-id>

<device-status>imported</device-status>

</lsan-device>

</Response>

Configuring an Alias for an Edge Fabric

This example uses a PATCH request to configure test11 as an alias name for the edge fabric ID 100.

Structure

PATCH <base_URI>/running/brocade-fibrechannel-routing/edge-fabric-alias

URI

PATCH https://10.10.10.10/rest/running/brocade-fibrechannel-routing/edge-fabric-alias

Request Body

<edge-fabric-alias>


<alias-name>test11</alias-name>

</edge-fabric-alias>

Response Body

When the operation is successful, the response has an empty response body, and a “204 No Content” status appears inthe header.

Enabling FC Routing

This example uses a PATCH request to enable FC routing on the device to which the request is sent.

Structure

PATCH <base_URI>/running/brocade-chassis/chassis/fcr-enabled/true

URI

PATCH https://10.10.10.10/rest/running/brocade-chassis/chassis/fcr-enabled/true

Request Body


Response Body


Disabling FC Routing

This example uses a PATCH request to disable FC routing on the device to which the request is sent.

Structure


Broadcom


PATCH <base_URI>/running/brocade-chassis/chassis/chassis/fcr-enabled/false

URI

PATCH https://10.10.10.10/rest/running/brocade-chassis/chassis/chassis/fcr-enabled/false

Request Body


Response Body


Configuring the Fabric ID for the Edge Fabric

This example uses a PATCH request to to configure the edge fabric ID to 49. Note that the EX_Port must be enabledbefore you can configure the Fabric ID for the edge fabric.

Structure

PATCH <base_URI>/running/brocade-interface/fibrechannel/edge-fabric-id/fabric_id

URI

PATCH https://10.10.10.10/rest/running/brocade-interface/fibrechannel/49

Request Body


Response Body


Enabling a Port as an EX_Port

This example uses a PATCH request to to enable the EX_Port for the edge fabric. Note that Fibre Channel switch Nativemode must be supported.

Structure

PATCH <base_URI>/running/brocade-interface/fibrechannel/ex-port-enabled/1

URI

PATCH https://10.10.10.10/rest/running/brocade-interface/ex-port-enabled/1

Request Body


Response Body


Configuring the Preferred Domain ID

This example uses a PATCH request to to configure the preferred domain ID to 160. Note that the EX_Port must beenabled before you can configure the Fabric ID for the edge fabric.

Structure


Broadcom


PATCH <base_URI>/running/brocade-interface/fibrechannel/preferred-front-domain-id/preferred_domain_id

URI

PATCH https://10.10.10.10/rest/running/brocade-interface/fibrechannel/preferred-front-domain-id/160

Request Body


Response Body

History




Broadcom


brocade-fibrechannel-switchThis module provides a detailed view of the switch being queried. If Virtual Fabrics are enabled, the request can include aquery parameter (VFID) for the desired Virtual Fabric. If no query parameter is specified and Virtual Fabrics are enabled,the default Virtual Fabric values are returned.

Module Tree

This is the tree view of the module from the brocade-fibrechannel-switch.yang-tree.txt file. See YANG Module Overviewfor YANG node field definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-fibrechannel-switch

+--rw brocade-fibrechannel-switch

+--rw fibrechannel-switch* [name]

| +--rw name fibrechannel:wwn-type

| +--rw domain-id? fibrechannel:domain-id-type

{fibrechannel:fibrechannel_switch_platform}?

| +--rw user-friendly-name? string





| +--ro vf-id? int16 {fibrechannel:fibrechannel_switch_platform}?

| +--ro principal? uint8 {fibrechannel:fibrechannel_switch_platform}?

| x--rw enabled-state? uint32

| +--rw is-enabled-state? boolean

| +--ro operational-status? uint32

| +--ro up-time? yang:timeticks

| +--ro model? string


| +--rw ip-address

| | +--rw ip-address* inet:ip-address

| +--rw ip-static-gateway-list

| | +--rw ip-static-gateway* fru:ip-gateway-type

| +--rw subnet-mask? inet:ipv4-address

| +--rw domain-name? string

| +--rw dns-servers

| | +--rw dns-server* inet:ip-address

| +--rw fabric-user-friendly-name? string {fibrechannel:fibrechannel_switch_platform}?

| +--rw ag-mode? uint8

| +--rw banner? string

| +--rw in-order-delivery-enabled? boolean {fibrechannel:fibrechannel_switch_platform}?

| +--rw dynamic-load-sharing? fibrechannel:dynamic-load-sharing-level


| +--rw advanced-performance-tuning-policy? fibrechannel:advanced-performance-tuning-policy-type


| +--rw lacp-system-priority? uint32

| +--ro lacp-system-mac-address? ietf:mac-address

+--ro topology-domain* [domain-id] {fibrechannel:fibrechannel_switch_platform}?

| +--ro domain-id fibrechannel:domain-id-type

| +--ro path-count? yang:gauge32

| +--ro metric? uint32

| +--ro is-local-translate-domain? boolean


Broadcom


| +--ro out-ports

| +--ro port* fibrechannel:user-port-number-type

+--ro topology-route* [] {fibrechannel:fibrechannel_switch_platform}?

+--ro domain-id? fibrechannel:domain-id-type

+--ro hop-count? uint32

+--ro out-port? fibrechannel:user-port-number-type

+--ro in-ports

+--ro port* fibrechannel:user-port-number-type

URI Format


<base_URI>/running/brocade-fibrechannel-switch followed by the leafs as listed in the module tree.

Parameters

NOTEThe top-level container name changed from "switch" to "brocade-fibrechannel-switch". The previous top-levelcontainer name "switch" is still supported in this release. However, new features (Fabric OS 9.0.0 or later) arenot supported in the previous top-level container name "switch".

brocade-fibrechannel-switchDescription: Switch state parameters.Flag: read-writeOptional: NoThis container has the following leafs:fibrechannel-switch

Description: Switch identification parameters.Requests can also be made using a query that specifies the Virtual Fabric ID of the fabric. This requestalso provides the switch state parameters.Flag: read-writeOptional: NoKey: nameThis list has the following leafs:name

Description: The switch world wide name (WWN).Flag: read-writeType: fibrechannel:wwn-typeValues: A valid WWN name.Optional: No

domain-idDescription: Domain ID of the switch.The highest level in a three-level addressing hierarchy used in the Fibre Channel addressidentifier. A domain typically is associated with a single Fibre Channel switch.Flag: read-writeType: fibrechannel:domain-id-typeValues: 1 through 239.Optional: Yes


Broadcom


user-friendly-nameDescription: The ASCII name assigned to the switch by the administrator.Flag: read-writeType: stringValue: 1 to 30 alphanumeric characters plus hyphens (-), periods (.), and underscores (_).Spaces are not allowed. A switch name can begin with either a letter or number, but a switchname that begins with a numeric (0-9) character must also have at least an underscore (_),hyphen (-), period (.), or alphabetic (A-Z, a-z) character. A switch name with only numericcharacters is not valid.Optional: Yes

fcidDescription: This parameter is deprecated. Use the fcid-hex parameter. The destination ID(D_ID) of the switch (decimal format).Flag: read-onlyType: fibrechannel:fcid-typeConfig: falseValue: A valid destination FCID value.Optional: Yes

fcid-hexDescription: The destination ID (D_ID) of the switch (hexidecimal format).Flag: read-onlyType: fibrechannel:fcid-hex-string-typeConfig: falseValue: A valid D_ID of the port.Optional: Yes

vf-idDescription: The Virtual Fabric identifier (VFID) of the logical switch. The switch must be an FCswitch in Native mode.Flag: read-onlyType: int16Config: falseValue: A valid VFID value from 1 to 128 or -1 = Indicates that the Virtual Fabric feature isunsupported or disabled.Optional: Yes

principalDescription: Indicates the principal switch in the fabric. The switch must be an FC switch inNative mode.Flag: read-onlyType: uint8Config: falseValue: 0 = This is not the principal switch in the fabric. 1 = This is the principal switch in thefabric.Optional: Yes

enabled-stateDescription: This parameter is deprecated. Use the is-enabled-state leaf to configure and theoperational-status leaf to obtain the current state of the switch. The current state of the switch.Flag: read-writeType: uint32Values: 0 = Undefined. 2 = Switch is enabled. 3 = Switch is disabled. 7 = Switch is being tested.This leaf can be set to 2 or 3 only; it cannot be set to 0 or 7.Optional: Yes


Broadcom


is-enabled-stateDescription: The current state of the switch.Flag: read-writeType: booleanValues: true = Switch is enabled. false = Switch is disabled.Optional: Yes

operational-statusDescription: The current state of the switch.Flag: read-writeType: uint32Config: falseValues: 0 = Undefined. 2 = Switch is enabled. 3 = Switch is disabled. 7 = Switch is being tested.Optional: Yes

up-timeDescription: The period of time elapsed since the last reboot of the specified switch.The absolute time interval for which the switch has been up, not the time measured betweenmidnight, January 1, 1970 UTC and the most recent reboot of the switch.Flag: read-onlyType: yang:timeticksConfig: falseUnits: secondsValues: 0 through 4294967296.Optional: Yes

modelDescription: The model name of the switch.Flag: read-onlyType: stringConfig: falseValue: The Brocade switch type of the switch (example: 145).Optional: Yes

firmware-versionDescription: A human-readable string identifying the firmware version running on the switch.Flag: read-onlyType: stringConfig: falseValue: The Brocade-defined firmware version ID.Optional: Yes

ip-addressDescription: A list of out-of-band IP addresses assigned to the Ethernet port on the switch. Thiscontainer is needed by the underlying infrastructure.Flag: read-writeThis container has the following leaf:ip-address

Description: A list of IP addresses assigned to the Ethernet port on the switch.Flag: read-writeType: inet:ip-addressValue: A valid IPv4 or IPv6 address.Optional: No

ip-static-gateway-listDescription: A list of static gateway IPv4 and IPv6 addresses for the switch IP address.


Broadcom


Flag: read-writeThis container has the following leaf:ip-static-gateway

Description: A list of static gateway IP addresses of an IP router that can route packetsto the destination IP address. The gateway address must be on the same IP subnet asone of the port IP addresses. Only one IPv4 static gateway and one IPv6 static gatewayare allowed.Flag: read-writeType: fru:ip-gateway-typeValue: A valid static gateway IPv4 or IPv6 address.Optional: Yes

subnet-maskDescription: The IPv4 subnet mask of the switch IP network.Flag: read-writeType: inet:ipv4-addressValue: A valid IPv4 address.Optional: Yes

domain-nameDescription: The DNS domain name of the switch. Note that leaving this field empty clears theDNS domain name.Flag: read-writeType: stringValue: 4 to 63 alphanumeric characters. The DNS domain name must start with a alphabeticcharacter (a-z, A-Z) and must not contain blank spaces.Optional: Yes

dns-serversDescription: A list of DNS server addresses.Flag: read-writeThis container has the following leaf:dns-server

Description: A list of DNS server addresses which can handle the mapping of thedomain names to the IP address of an internet resource which is needed by variousnetworking protocols. Brocade FC switches support a maximum of two DNS servers.Flag: read-writeType: inet:ip-addressValue: A valid IP address.Optional: Yes

fabric-user-friendly-nameDescription: The human-readable name for the fabric. The fabric name must be unique for eachlogical switch within a chassis. This fabric name applies to all switches within the same fabric.The switch must be an FC switch in Native mode.Flag: read-writeType: stringValue: 1 to 128 ASCII characters. The value is not case-sensitive.Optional: Yes

ag-modeDescription: Indicates the Access Gateway (AG) mode capability and enablement state. Aswitch is capable of AG mode support when this value is not zero.Flag: read-writeType: uint8


Broadcom


Value: 0 = AG mode is not supported by this device. 1 = AG mode is supported and is currentlydisabled. 3 = AG mode is supported and is currently enabled.Optional: Yes

bannerDescription: The text that displays during the log on process.Flag: read-writeType: stringValue: 1 to 1022 alphanumeric characters. If the banner text exceeds the maximum limit, thesoftware truncates the banner text.Optional: Yes

in-order-delivery-enabledDescription: Enables or disables In Order Delivery (IOD) for the switch. The switch must be anFC switch in Native mode.Flag: read-writeType: booleanValue: true = Enables In Order Delivery (IOD) for the switch. false = Disables In Order Delivery(IOD) for the switch.Optional: Yes

dynamic-load-sharingDescription: The Dynamic Load Sharing (DLS) mode in use by the switch. Note that when theAdvanced Performance Tuning policy for the switch is Device-Based or Exchange-Based, youcannot change the DLS setting to disabled. The switch must be an FC switch in Native mode.Flag: read-writeType: fibrechannel:dynamic-load-sharing-levelValue: disabled = Disables the Dynamic Load Sharing (DLS) capability. dls = Enables only thebase Dynamic Load Sharing (DLS) capability. lossless-dls = Enables the Dynamic Load Sharing(DLS) and LosslessDLS capability. two-hop-lossless-dls = Enables the Two-Hop LosslessDLSenhancement to LosslessDLS.Optional: Yes

advanced-performance-tuning-policyDescription: The current Advanced Performance Tuning (APT) policy for the local switch. TheAPT policy controls how the switch creates the routes used by traffic flowing through the switch.The switch must be an FC switch in Native mode.Flag: read-writeType: fibrechannel:advanced-performance-tuning-policy-typeValue: Valid values are port-based, device-based, and exchange-based.Optional: Yes

lacp-system-priorityDescription: The system priority of this switch. This priority is used for determining the systemthat is responsible for resolving conflicts in the choice of aggregation groups. A lower numericalvalue has a higher priority.Flag: read-writeType: uint32Value: 0 to 65535.Optional: Yes

lacp-system-mac-addressDescription: The LACP system MAC address of the switch.Flag: read-onlyType: ietf:mac-addressConfig: false


Broadcom


Value: A MAC address.Optional: Yes

topology-domainDescription: The topology data for one of the fabric domains, including the Shortest Path First (SPF)path cost (metric), the total number of potential paths that qualify based on the SPF calculations, and alist of the egress (out-ports) that are in use for routing traffic to the domain. The switch must be an FCswitch in Native mode.Flag: read-onlyKey: domain-idConfig: falseThis list has the following leafs:domain-id

Description: The fabric domain for which this topology data applies.Flag: read-onlyType: fibrechannel:domain-id-typeConfig: falseValue: 1 to 239.Optional: No

path-countDescription: The number of currently active paths, with the same cost (metric), to the destinationdomain.Flag: read-onlyType: yang:gauge32Value: The number of currently active paths, with the same cost (metric), to the destinationdomain.Optional: Yes

metricDescription: The cost of reaching the destination domain.Flag: read-onlyType: uint32Value: The cost of reaching the destination domain.Optional: Yes

is-local-translate-domainDescription: Whether the domain is a local translate domain, meaning the domain is a translatedomain, and it is directly connected to this FC Router switch.Flag: read-onlyType: booleanValue: true = The domain is a local translate domain. false = The domain is not a local translatedomain.Optional: Yes

out-portsDescription: A list of egress ports that are programmed for use when routing traffic to use thedomain.Flag: read-onlyOptional: YesThis container has the following leafs:port

Description: An egress port to reach the destination domain.Flag: read-onlyType: fibrechannel:user-port-number-type


Broadcom


Value: An egress port to reach the destination domain.Optional: Yes

topology-routeDescription: A route currently programmed by the local switch. Includes one of the egress (out-ports),any ingress (in-ports), and the number of hops to reach the domain, by the switch. The switch must be anFC switch in Native mode.Flag: read-onlyConfig: falseOptional: Yesdomain-id

Description: The domain ID of the destination switch.Flag: read-onlyType: fibrechannel:domain-id-typeValue: 1 to 239 (valid domain ID).Optional: Yes

hop-countDescription: The greatest number of hops (across all capable paths) to reach the domain as ofthe latest Shortest Path First calculations. Note that the hop count is per destination domain, asopposed to per path. So all out-ports report the same number of hops.Flag: read-onlyType: uint32Value: The greatest number of hops.Optional: Yes

out-portDescription: An egress (out-port) to reach the domain.Flag: read-onlyType: fibrechannel:user-port-number-typeValue: An egress (out-port) to reach the domain.Optional: Yes

in-portsDescription: A list of the user-ports that are ingress (in-ports) using this out-port for any trafficdestined to the identified domain ID.Flag: read-onlyOptional: YesThis container has the following leafs:port

Description: A user-port routed to the identified out-port for any frames destined for theidentified domain.Flag: read-onlyType: fibrechannel:user-port-number-typeValue: An ingress port.Optional: Yes

Supported Methods

Only the GET, OPTIONS, PATCH, and HEAD method operations are supported in this module.


Broadcom


ExamplesRetrieving Switch Resource InformationThis example uses a GET request to retrieve the switch resources.StructureGET <base_URI>/running/brocade-fibrechannel-switch/fibrechannel-switch/URIGET https://10.10.10.10/rest/running/brocade-fibrechannel-switch/fibrechannel-switch/



<Response>




<fcid>16776235</fcid>






<banner/>



<dns-servers>



</dns-servers>


<ip-address>


</ip-address>







<vf-id>-1</vf-id>








Broadcom




</Response>

Retrieving Switch Resource Information From a Virtual FabricThis example uses a GET request to retrieve the switch resource information for a switch in the Virtual Fabricwith an VFID of 20.StructureGET <base_URI>/running/brocade-fibrechannel-switch/fibrechannel-switch?vf-id=<vf-id#>URIGET https://10.10.10.10/rest/running/brocade-fibrechannel-switch/fibrechannel-switch?vf-id=20


<Response>




<fcid>16776235</fcid>






<banner/>



<dns-servers>



</dns-servers>


<ip-address>


</ip-address>







<vf-id>20</vf-id>






Broadcom






</Response>

Setting the User-friendly Name for a SwitchThis example uses a PATCH request to set the user-friendly name for the switch “10:10:10:10:1c:16:98:14” to“My_Switch_1”.StructurePATCH <base_URI>/running/brocade-fibrechannel-switch/fibrechannel-switch/name/switch_name/user-friendly-name/friendly_nameURIPATCH https://10.10.10.10/rest/running/brocade-fibrechannel-switch/fibrechannel-switch/

name/10:10:10:10:1c:16:98:14/user-friendly-name/My_Switch_1

Request BodyNo request body is required.Response BodyWhen the operation is successful, the response contains an empty message body and a “204 No content”status in the header.Setting the Login Banner for a SwitchThis example uses a PATCH request to set the login banner for the switch “10:10:10:10:1c:16:98:14” to “LoginBanner-REST”.StructurePATCH <base_URI>/running/brocade-fibrechannel-switch/fibrechannel-switchURIPATCH https://10.10.10.10/rest/running/brocade-fibrechannel-switch/fibrechannel-switch

Request Body


<name>10:10:10:10:7c:c0:ad:72</name>

<banner>Login Banner-REST</banner>


Response BodyWhen the operation is successful, the response has an empty message body and a “204 No Content” statusmessage.

History



Fabric OS 8.2.1 The API call was modified to add enable and disable support for ag-mode as we as addthe ip-static-gateway-list, subnet-mask, and banner parameters.


Broadcom



Fabric OS 8.2.1b The top-level container name changed from "switch" to "brocade-fibrechannel-switch". Theprevious top-level container name "switch" is still supported in this release. However, newfeatures (Fabric 9.0.0 or later) are not supported in the previous top-level container name"switch".

Fabric OS 9.0.0 The API call was modified to add the in-order-delivery-enabled, dynamic-load-sharing,advanced-performance-tuning-policy, lacp-system-priority, and ro lacp-system-mac-address parameters to the fibrechannel-switch container and to add the topology-domainand topology-route containers.


Broadcom


brocade-fibrechannel-trunkThis module provides a detailed view of all trunks in the switch in native mode as well as the members of the individualtrunks. It can also provide traffic performance and bandwidth information. For F_Port static trunks, you can configure atrunk index that is persistent and has the same value across all members of the trunk. Even if the master port changes,the trunk area is derived from the target index.

It assumes a knowledge of trunking as performed in Fabric OS. For information on that topic, refer to the Brocade FabricOS Administration Guide.

Module Tree

This is the tree view of the module from the brocade-fibrechannel-trunk.yang-tree.txt file. See YANG Module Overview forYANG node field definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-fibrechannel-trunk

+--rw brocade-fibrechannel-trunk

+--ro trunk* [group source-port] {fibrechannel:fibrechannel_switch_platform}?

| +--ro group fibrechannel:user-port-number-type

| +--ro source-port fibrechannel:user-port-number-type

| +--ro master? boolean

| +--ro destination-port? fibrechannel:user-port-number-type

| +--ro neighbor-wwn? fibrechannel:wwn-type

| +--ro neighbor-switch-name? string

| +--ro neighbor-domain-id? fibrechannel:domain-id-type

| +--ro deskew? fibrechannel:deskew-type

| +--ro trunk-type? fibrechannel:fibrechannel-trunk-type

+--ro performance* [group] {fibrechannel:fibrechannel_switch_platform}?

| +--ro group fibrechannel:user-port-number-type

| +--ro tx-bandwidth? uint32

| +--ro tx-throughput? uint64

| +--ro tx-percentage? fibrechannel:percentage-type

| +--ro rx-bandwidth? uint32

| +--ro rx-throughput? uint64

| +--ro rx-percentage? fibrechannel:percentage-type

| +--ro txrx-bandwidth? uint32

| +--ro txrx-throughput? uint64

| +--ro txrx-percentage? fibrechannel:percentage-type

+--rw trunk-area* [trunk-index] {fibrechannel:fibrechannel_switch_platform}?

+--rw trunk-index fibrechannel:user-port-number-type

+--rw trunk-members

| +--rw trunk-member* fibrechannel:slot-port-name-type

+--ro master-port? fibrechannel:slot-port-name-type

+--ro trunk-active? boolean

URI Format


• <base_URI>/running/brocade-interface/fibrechannel/name/fibre_channel_interface_name/trunk-port-enabled/ to view the trunk settings for a physical port or to enable or disable trunking on a port.


Broadcom


• <base_URI>/running/brocade-fibrechannel-trunk/trunk followed by the leafs as listed in the module tree toview trunk data for all trunks on a device.

• <base_URI>/running/brocade-fibrechannel-trunk/performance followed by the leafs as listed in themodule tree to view performance data for trunks on a device.

• <base_URI>/running/brocade-fibrechannel-trunk/trunk-area followed by the leafs as listed in the moduletree to view data for all port trunk area groups on a switch or to create, modify, or delete a trunk area.

Parametersbrocade-fibrechannel-trunk

Description: The module container. This container displays information about the native mode trunk state andperformance and also allows you to configure an F_Port static trunk from a native switch to an Access Gatewayswitch.Flag: read-writeThis container has the following leafs:trunk

Description: A list of configured members in the trunk. The switch must be an FC switch in Native mode.Flag: read-onlyKey: group source-portConfig: falseThis list has the following leafs:group

Description: The unique number on the switch for identifying a Fibre Channel trunk.Flag: read-onlyType: fibrechannel:user-port-number-typeValue: The Fibre Channel user port number (0 to 3400).Optional: Yes

source-portDescription: The user port number of the trunk member of the local switch.Flag: read-onlyType: fibrechannel:user-port-number-typeValue: The Fibre Channel user port number (0 to 3400) of the trunk member of the local switch.Optional: Yes

masterDescription: Whether this link is the trunk master.Flag: read-onlyType: booleanValue: true =This link is the trunk master. false = This link is a subordinate.Optional: Yes

destination-portDescription: The user port number of the trunk member of the adjacent switch.Flag: read-onlyType: fibrechannel:user-port-number-typeValue: The Fibre Channel user port number (0 to 3400) of the trunk member of the adjacentswitch.Optional: Yes

neighbor-wwnDescription: The Fibre Channel WWN of the adjacent switch.Flag: read-onlyType: fibrechannel:wwn-type


Broadcom


Value: A valid port WWN name.Optional: Yes

neighbor-switch-nameDescription: The Fibre Channel user-friendly name of the adjacent switch.Flag: read-onlyType: stringValue: A valid user-friendly name (such as sw0).Optional: Yes

neighbor-domain-idDescription: The highest level in a three-level addressing hierarchy used in the Fibre Channeladdress identifier. A domain typically is associated with a single Fibre Channel switch.Flag: read-onlyType: fibrechannel:domain-id-typeValue: A valid Fibre Channel switch domain identifier.Optional: Yes

deskewDescription: The time difference for traffic to travel over each F_Port trunk as compared to theF_Port trunk with the shortest travel time in the group. The value is expressed in nanosecondsdivided by 10. This parameter determines if ports can be trunked if the variation between differentlinks in a trunk is within range.Flag: read-onlyType: fibrechannel:deskew-typeValue: 1 to 255.Optional: Yes

trunk-typeDescription: The types of links which are bundled together in a trunk.Flag: read-onlyType: fibrechannel:fibrechannel-trunk-typeConfig: falseValues: inter-switch-link = The trunk is a logical bundle of E_Ports on a port blade or astandalone switch. inter-chassis-link = The trunk is a logical bundle of E_Ports on a core blade ina chassis. inter-fabric-link = The trunk is a logical bundle of EX_Ports between two fabrics usingport blades or a standalone switch. f-port = The trunk is a logical bundle of F_Pports on a portblade or a standalone switch. f-port-access-gateway = The trunk is a logical bundle of switch-to-switch links in Access Gateway mode on port blades or a standalone switch.Optional: No

performanceDescription: The performance statistics for each trunk in the switch. The switch must be an FC switch inNative mode.Flag: read-onlyKey: groupThis container has the following leafs:group

Description: A positive number that uniquely identifies a trunk starting from 1 to the maximumnumber of trunks in the switch.Flag: read-onlyType: fibrechannel:user-port-number-typeValue: The Fibre Channel user port number (0 to 3400).Optional: Yes


Broadcom


tx-bandwidthDescription: The transmit bandwidth in gigabits per second (Gb/s).Flag: read-onlyType: uint32Value: The transmit bandwidth in Gb/s.Optional: Yes

tx-throughputDescription: The transmit side frame transmission rate in bits per second (b/s).Flag: read-onlyType: uint64Value: The transmit side frame transmission rate in b/s.Optional: Yes

tx-percentageDescription: The transmit bandwidth as a percentage of the maximum bandwidth.Flag: read-onlyType: fibrechannel:percentage-typeValue: The percentage of the transmit bandwidth.Optional: Yes

rx-bandwidthDescription: The receive bandwidth in gigabits per second (Gb/s).Flag: read-onlyType: uint32Value: The receive bandwidth in Gb/s.Optional: Yes

rx-throughputDescription: The receive side frame reception rate in bits per second (b/s).Flag: read-onlyType: uint64Value: The receive side frame reception rate in b/s.Optional: Yes

rx-percentageDescription: The receive bandwidth as a percentage of the maximum bandwidth.Flag: read-onlyType: fibrechannel:percentage-typeValue: The percentage of the receive bandwidth.Optional: Yes

txrx-bandwidthDescription: The combined (transmit and receive) bandwidth in gigabits per second (Gb/s).Flag: read-onlyType: uint32Value: The combined (transmit and receive) bandwidth in Gb/s.Optional: Yes

txrx-throughputDescription: The combined (transmit and receive) side frame rate in bits per second (bps).Flag: read-onlyType: uint64Value: The combined (transmit and receive) side frame rate in bps.Optional: Yes


Broadcom


txrx-percentageDescription: The combined (transmit and receive) bandwidth as a percentage of the maximumbandwidth.Flag: read-onlyType: fibrechannel:percentage-typeValue: The percentage of the combined (transmit and receive) bandwidth.Optional: Yes

trunk-areaDescription: A list of trunk area groups for a switch. You can configure the trunk index for ports in thesame octet for F_Ports. Note that any changes to the trunk area are persistent and disruptive. The switchmust be an FC switch in Native mode.Flag: read-writeKey: trunk-indexThis container has the following leafs:trunk-index

Description: The persistent trunk area for a range of ports in the F_Port trunk.Flag: read-writeType: fibrechannel:user-port-number-typeValue: The Fibre Channel user port number (0 to 3400).Optional: Yes

trunk-membersDescription: The members of the F_Port trunk group.Flag: read-writeThis container has the following leafs:trunk-member

Description: The individual trunk member of an F_Port trunk. There must be at least onetrunk member.Flag: read-writeType: fibrechannel:slot-port-name-typeValue: The slot and port number of the F_Port trunk in the format slot/port.Optional: Yes

master-portDescription: The user port number of the master port in the trunk.Flag: read-onlyType: fibrechannel:slot-port-name-typeConfig: falseValue: The Fibre Channel user port number of the trunk's master port in the format slot/port.Optional: Yes

trunk-activeDescription: Whether trunking is active on the port.Flag: read-onlyType: booleanConfig: falseValue: true = Trunking is active on the port. false = Trunking is not active on the port.Optional: Yes

Supported Methods

Only the OPTIONS, GET, DELETE, HEAD, and POST operations are supported in this module.


Broadcom


ExamplesViewing Trunk Settings for a PortThe following example uses the GET request to view the trunk settings for port 0/88.StructureGET <base_URI>/running/brocade-interface/fibrechannel/name/fibre_channel_interface_name/trunk-port-enabled/URINotice that the slash character in the name resource is encoded as “%2f”.GET https://10.10.10.10/rest/running/brocade-interface/fibrechannel/name/0%2f88/trunk-port-enabled/



<Response>

<fibrechannel>

<name>0/88</name>

<trunk-port-enabled>1</trunk-portenabled>

</fibrechannel>

</Response>

Enabling Trunking on a PortThe following example uses the PATCH request to enable trunking for port 0/88.StructurePATCH <base_URI>/running/brocade-interface/fibrechannel/name/fibre_channel_interface_name/trunk-port-enabled/1URINotice that the slash character in the name resource is encoded as “%2f”.

PATCH https://10.10.10.10/rest/running/brocade-interface/fibrechannel/name/0%2f88/trunk-port-

enabled/1

Request BodyNo request body is required.Response BodyWhen the operation is successful, the response contains an empty message body and a “204 No Content"status appears in the header.Viewing Trunk Data for a Source PortThe following example uses the GET request to view trunk data for source port 88 in trunk group 1.StructureGET <base_URI>/running/brocade-fibrechannel-trunk/trunk/group/group_number/source-port/port_number


Broadcom


URIGET https://10.10.10.10/rest/running/brocade-fibrechannel-trunk/trunk/group/1/source-port/88



<Response>

<trunk>

<group>1</group>

<source-port>88</source-port>

<destination-port>24</destination-port>

<neighbor-wwn>10:00:c4:f5:7c:00:c5:30</neighbor-wwn>

<neighbor-switch-name>G630_066_232</neighbor-switch-name>

<neighbor-domain-id>232</neighbor-domain-id>

<deskew>15</deskew>

<master>true</master>

<trunk-type>inter-switch-link</trunk-type>

</trunk>

</Response>

Viewing Trunk Performance DataThe following example uses the GET request to view performance data for all trunks on the switch.StructureGET <base_URI>/running/brocade-fibrechannel-trunk/performanceURIGET https://10.10.10.10/rest/running/brocade-fibrechannel-trunk/performance



<Response>

<performance>

<group>1</group>

<tx-bandwidth>32</tx-bandwidth>

<tx-throughput>8000</tx-throughput>

<tx-percentage>0.00</tx-percentage>

<rx-bandwidth>32</rx-bandwidth>

<rx-throughput>0</rx-throughput>

<rx-percentage>0.00</rx-percentage>

<txrx-bandwidth>64</txrx-bandwidth>


Broadcom


<txrx-throughput>8000</txrx-throughput>

<txrx-percentage>0.00</txrx-percentage>

</performance>

<performance>

<group>2</group>










</performance>

<performance>

<group>3</group>










</performance>

</Response>

Viewing Performance Data for a Specific Trunk GroupThe following example uses the GET request to view performance data for trunk group 1.StructureGET <base_URI>/running/brocade-fibrechannel-trunk/performance/group/group_numberURIGET https://10.10.10.10/rest/running/brocade-fibrechannel-trunk/performance/group/1



<Response>

<performance>

<group>1</group>






Broadcom







</performance>

</Response>

Viewing Data for all Trunk Area GroupsThe following example uses the GET request to obtain data for all port trunk area groups on a switch. Thedata includes both active and in-active configured trunk area groups.StructureGET <base_URI>/running/brocade-fibrechannel-trunk/trunk-area/URIGET https://10.10.10.10/rest/running/brocade-fibrechannel-trunk/trunk-area/



<Response>

<trunk-area>

<trunk-index>0</trunk-index>

<trunk-active>true</trunk-active>

<master-port>0/0</master-port>

<trunk-members>

<trunk-member>0/0</trunk-member>



</trunk-members>

</trunk-area>

<trunk-area>

<trunk-index>40</trunk-index>

<trunk-active>false</trunk-active>

<master-port/>

<trunk-members>



</trunk-members>

</trunk-area>

</Response>

Configuring a Trunk Area GroupThe following example uses the POST request to configure a port trunk area group 0 using ports 0/0, 0/6, and0/7. Note that you must specify the trunk members with the POST request or the operation fails.StructurePOST <base_URI>/running/brocade-fibrechannel-trunk/trunk-area/trunk-index/trunk-index-number


Broadcom


URIPOST https://10.10.10.10/rest/running/brocade-fibrechannel-trunk/trunk-area/trunk-index/0

Request Body

<trunk-members>




</trunk-members>

Response BodyWhen the operation is successful, the response contains an empty message body and a “201 Created" statusappears in the header.Deleting a Trunk Area GroupThe following example uses the DELETE request to delete port trunk area group 1 which contains ports 0/1,0/2, and 0/3. To delete an entire port trunk area, all members must be included in the Request Body.StructureDELETE <base_URI>/running/brocade-fibrechannel-trunk/trunk-area/trunk-index/trunk_index_numberURIDELETE https://10.10.10.10/rest/running/brocade-fibrechannel-trunk/trunk-area/trunk-index/1

Request Body

<trunk-members>




</trunk-members>

Response BodyWhen the operation is successful, the response contains an empty message body and a “204 No Content"status appears in the header.Deleting Members From an Existing Trunk Area GroupThe following example uses the DELETE request to remove trunk members 0/6 and 0/7 from trunk area group1 which contains ports 0/1, 0/6, and 0/7. Note that you must specify the trunk members with the DELETErequest or the operation fails.StructureDELETE <base_URI>/running/brocade-fibrechannel-trunk/trunk-area/trunk-index/trunk_index_numberURIDELETE https://10.10.10.10/rest/running/brocade-fibrechannel-trunk/trunk-area/trunk-index/1

Request Body

<trunk-members>




Broadcom


</trunk-members>

Response BodyWhen the operation is successful, the response contains an empty message body and a “204 No Content"status appears in the header.

History



Fabric OS 9.0.0 This API call was modified to add the trunk-type parameter to the trunk list.


Broadcom


brocade-ficonThis module allows the management of some FICON Control Unit Port (CUP) parameters as well as providing FICONrelated information from the Management Server (such as RNID, LIRR, and RLIR data).

To create a FICON logical switch, see brocade-fibrechannel-logical-switch.

Module Tree

This is the tree view of the module from the brocade-ficon.yang-tree.txt file. See YANG Module Overview for YANG nodefield definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-ficon

+--rw brocade-ficon

+--rw cup {fibrechannel:fibrechannel_switch_platform}?

| +--rw fmsmode-enabled? boolean

| +--rw programmed-offline-state-control? boolean

| +--ro user-alert-mode? boolean

| +--rw active-equal-saved-mode? boolean

| +--rw director-clock-alert-mode? boolean

| +--ro mihpto? uint32

| +--rw unsolicited-alert-mode-fru-enabled? boolean

| +--rw unsolicited-alert-mode-hsc-enabled? boolean

| +--rw unsolicited-alert-mode-invalid-attach-enabled? boolean

+--rw logical-path* [link-address channel-image-id] {fibrechannel:fibrechannel_switch_platform}?

| +--rw link-address fibrechannel:brocade-hex-string-type

| +--rw channel-image-id fibrechannel:brocade-hex-string-type

| +--ro operational-state? logical-path-operational-states

| +--rw reporting-path-state? string

+--ro rnid* [link-address] {fibrechannel:fibrechannel_switch_platform}?

| +--ro link-address fibrechannel:brocade-hex-string-type

| +--ro format? fibrechannel:brocade-hex-string-type

| +--ro port-type? fibrechannel:port-type-string-type

| +--ro registered-port-wwn? fibrechannel:wwn-type

| +--ro registered-node-wwn? fibrechannel:wwn-type

| +--ro flags? fibrechannel:brocade-hex-string-type

| +--ro node-parameters? fibrechannel:brocade-hex-string-type

| +--ro type-number? string

| +--ro model-number? string


| +--ro plant? string

| +--ro sequence-number? string

| +--ro tag? fibrechannel:brocade-hex-string-type

+--ro switch-rnid* [switch-address] {fibrechannel:fibrechannel_switch_platform}?

| +--ro switch-address fibrechannel:brocade-hex-string-type

| +--ro switch-wwn? fibrechannel:wwn-type

| +--ro flags? fibrechannel:brocade-hex-string-type

| +--ro node-parameters? fibrechannel:brocade-hex-string-type

| +--ro type-number? string

| +--ro model-number? string


| +--ro plant? string

| +--ro sequence-number? string


Broadcom


| +--ro tag? fibrechannel:brocade-hex-string-type

+--ro lirr* [link-address] {fibrechannel:fibrechannel_switch_platform}?

| +--ro link-address fibrechannel:brocade-hex-string-type

| +--ro format? fibrechannel:brocade-hex-string-type

| +--ro port-type? fibrechannel:port-type-string-type

| +--ro listener-port-wwn? fibrechannel:wwn-type

| +--ro switch-port-wwn? fibrechannel:wwn-type

| +--ro listener-type? string

+--ro rlir* [] {fibrechannel:fibrechannel_switch_platform}?

+--ro link-address? fibrechannel:brocade-hex-string-type

+--ro format? fibrechannel:brocade-hex-string-type



+--ro incident-count? uint8

+--ro time-stamp-format? uint8

+--ro time-stamp? string

+--ro port-status? string

+--ro link-failure-type? string

+--ro registered-port-wwn? fibrechannel:wwn-type

+--ro registered-node-wwn? fibrechannel:wwn-type

+--ro port-flags? fibrechannel:brocade-hex-string-type

+--ro port-node-parameters? fibrechannel:brocade-hex-string-type

+--ro port-type-number? string

+--ro port-model-number? string

+--ro port-manufacturer? string

+--ro port-plant? string

+--ro port-sequence-number? string

+--ro port-tag? fibrechannel:brocade-hex-string-type

+--ro switch-port-wwn? fibrechannel:wwn-type

+--ro switch-node-wwn? fibrechannel:wwn-type

+--ro switch-flags? fibrechannel:brocade-hex-string-type

+--ro switch-node-parameters? fibrechannel:brocade-hex-string-type

+--ro switch-type-number? string

+--ro switch-model-number? string

+--ro switch-manufacturer? string

+--ro switch-plant? string

+--ro switch-sequence-number? string

+--ro switch-tag? fibrechannel:brocade-hex-string-type

URI Format


• <base_URI>/running/brocade-ficon/cup to view or configure FICON CUP.

• <base_URI>/running/brocade-ficon/logical-path[link-address channel-image-id] to view orconfigure the logical path.

• <base_URI>/running/brocade-ficon/rnid[link-address] to view Request Node Identifier (RNID) data.

• <base_URI>/running/brocade-ficon/switch-rnid/[switch-address] to view Switch RNID data.

• <base_URI>/running/brocade-ficon/lirr[link-address] to view Link Incident Registration Record (LIRR)data.


Broadcom


• <base_URI>/running/brocade-ficon/rlir to view Registered Link Incident Record (RLIR) data.

Parametersbrocade-ficon

Description: This module enables you to configure some FICON Control Unit Port (CUP) parameters as well asproviding FICON-related information from the Management server (such as RNID, LIRR, and RLIR data).Flag: read-writeThis container has the following leafs:cup

Description: The FICON CUP configuration parameters. The switch must be an FC switch in Nativemode.Flag: read-writeThis list has the following leafs:fmsmode-enabled

Description: Indicates whether the FICON Management Server (FMS) mode is enabled in thelogical switch.Note: You cannot disable FMS mode through the REST API interface. If a PATCH request isreceived with fmsmode-enabled=false, an error is returned.Flag: read-writeType: booleanValue: false = FMS mode is disabled. true = FMS mode is enabled.Optional: Yes

programmed-offline-state-controlDescription: Indicates whether programmed control of the offline state is allowed or prohibited.Programmed control refers to an IBM host sending the 0xFD Set Offline CCW to the CUP todisable a logical switch.Flag: read-writeType: booleanValue: false = Programmed control is prohibited. true = Programmed control is allowed.Optional: Yes

user-alert-modeDescription: Indicates whether user alert mode is enabled or disabled.When enabled, user alert mode causes the EFC Server to send a general warning indication tothe EFC Server user whenever the EFC Server user attempts an action which will write FICONDirector parameters. The EFC Server user may override this warning. When disabled, thegeneral warning indication does not take place.Flag: read-onlyType: booleanConfig: falseValue: false = User alert mode is disabled. true = User alert mode is enabled.Optional: Yes

active-equal-saved-modeDescription: Indicates whether Active=Saved mode is enabled or disabled. Active=Saved modecontrols updating of the CUP IPL configuration file.When Active=Saved mode is enabled, the IPL file is updated with configuration changes alongwith the active configuration.When Active=Saved mode is disabled, the IPL file is not updated with changes to the activeconfiguration. In this case, a reboot or activating another configuration file will lose configurationchanges made to the active configuration.Flag: read-write


Broadcom


Type: booleanValue: false = Active=Saved mode is disabled. true = Active=Saved mode is enabled.Optional: Yes

director-clock-alert-modeDescription: Indicates whether Director Clock Alert mode is enabled or disabled.When the Director Clock Alert mode is enabled, a general warning displays on the EFC serverwhen a user attempts to set the Time-Stamp clock. When enabled, this mode also causes anerror message to be displayed when a user attempts to activate any function that automaticallysets the Time-Stamp clock.Flag: read-writeType: booleanValue: false = Director Clock Alert mode is disabled. true = Director Clock Alert mode is enabled.Optional: Yes

mihptoDescription: The current value of the missing interrupt handler primary timeout (MIHPTO).This value is only available when FMS mode is enabled. This value cannot be changed throughthe REST API. To change this value, refer to the Brocade Fabric OS FICON Configuration Guide.For definitions of the contents, refer to the IBM PI Specification.Flag: read-onlyType: uint32Config: falseValue: The current value of the MIHPTO.Optional: Yes

unsolicited-alert-mode-fru-enabledDescription: Indicates whether unsolicited alerts for FRU events are enabled.Flag: read-writeType: booleanValue: false = FRU alerts are disabled. true = FRU alerts are enabled.Optional: Yes

unsolicited-alert-mode-hsc-enabledDescription: Indicates whether unsolicited alerts for Health Summary Code (HSC) events areenabled.Flag: read-writeType: booleanValue: false = HSC alerts are disabled. true = HSC alerts are enabled.Optional: Yes

unsolicited-alert-mode-invalid-attach-enabledDescription: Indicates whether unsolicited alerts for invalid attachment events are enabled.Flag: read-writeType: booleanValue: false = Invalid attachment alerts are disabled. true = Invalid attachment alerts areenabled.Optional: Yes

logical-pathDescription: A list of logical paths that are currently established to the Control Unit Port (CUP). Settingthe current reporting path is supported through this interface. To set the current reporting path, you mustsupply the key (link-address and channel-image-id) and a reporting-path-state value of Current. Theswitch must be an FC switch in Native mode.Flag: read-writeKey: link-address channel-image-id


Broadcom


This list has the following leafs:link-address

Description: The link address (first two bytes of the Port Identifier (PID)) of the logical path. Thisis part of the composite key that must be supplied to set the current reporting path.Flag: read-writeType: fibrechannel:brocade-hex-string-typeValue: The link address of the logical path.Optional: Yes

channel-image-idDescription: The Channel Image ID of the logical path. This is part of the composite key thatmust be supplied to set the current reporting path.Flag: read-writeType: fibrechannel:brocade-hex-string-typeValue: The Channel Image ID of the logical path.Optional: Yes

operational-stateDescription: The set of operational states for a logical path.Flag: read-onlyConfig: falseType: stringValue: Reset = The logical path is in a reset state. Oper = The logical path is in an operationalstate.Optional: Yes

reporting-path-stateDescription: The reporting path state of the logical path. To set the current reporting path, thereporting-path-state parameter must be supplied and the only valid value is Current.Flag: read-writeType: stringValue: Primary = The reporting path state is primary. Alternate = The reporting path state isalternate. Current = The reporting path state is current.Optional: Yes

rnidDescription: A list of Request Node Identifier (RNID) records from the FICON database. All RNIDrecords for the entire fabric are returned unless you specify a link-address to return a single RNID record.The RNID records only report the state data for connected devices. You cannot create or update RNIDrecords. Most of the properties correspond to the definition of the RNID record in FC-SB and additionaldefinition can be found in the specification. The switch must be an FC switch in Native mode.Flag: read-onlyConfig: falseKey: link-addressThis list has the following leafs:link-address

Description: The link address (first two bytes of the Port Identifier (PID)) of the RNID record.Flag: read-onlyType: fibrechannel:brocade-hex-string-typeConfig: falseValue: The link address of the RNID record.Optional: Yes

formatDescription: The Format field from the RNID record.


Broadcom


Flag: read-onlyType: fibrechannel:brocade-hex-string-typeConfig: falseValue: 0x18 = Indicates the record is a FICON node identifier.Optional: Yes

port-typeDescription: The port type of the RNID record.Flag: read-onlyType: fibrechannel:port-type-string-typeConfig: falseValue: The port type of the RNID record.Optional: Yes

registered-port-wwnDescription: The Registered Port WWN.Flag: read-onlyType: fibrechannel:wwn-typeConfig: falseValue: The Registered Port WWN.Optional: Yes

registered-node-wwnDescription: The Registered Node WWN.Flag: read-onlyType: fibrechannel:wwn-typeConfig: falseValue: The Registered Node WWN.Optional: Yes

flagsDescription: The Flags field from the RNID record.Flag: read-onlyType: fibrechannel:brocade-hex-string-typeConfig: falseValue: The Flags field from the RNID record.Optional: Yes

node-parametersDescription: The Node Parameters field from the RNID record.Flag: read-onlyType: fibrechannel:brocade-hex-string-typeConfig: falseValue: The Node Parameters field from the RNID record.Optional: Yes

type-numberDescription: The type number of the node that describes the machine type of the device.Flag: read-onlyType: stringConfig: falseValue: The type number of the node that describes the machine type of the device.Optional: Yes

model-numberDescription: The model number of the device.Flag: read-only


Broadcom


Type: stringConfig: falseValue: The model number of the device.Optional: Yes

manufacturerDescription: The manufacturer or code for the manufacturer of the device.Flag: read-onlyType: stringConfig: falseValue: The manufacturer or code for the manufacturer of the device.Optional: Yes

plantDescription: The manufacturer plant name or code for the manufacturer plant of the device.Flag: read-onlyType: stringConfig: falseValue: The manufacturer plant name or code for the manufacturer plant of the device.Optional: Yes

sequence-numberDescription: The sequence number or serial number of the device.Flag: read-onlyType: stringConfig: falseValue: The sequence number of the device.Optional: Yes

tagDescription: The physical identifier of the device.Flag: read-onlyType: fibrechannel:brocade-hex-string-typeConfig: falseValue: The physical identifier of the device.Optional: Yes

switch-rnidDescription: A list of Switch Request Node Identifier (RNID) records from the FICON database. AllSwitch RNID records for the entire fabric are returned unless a switch-addr is specified to return a singleSwitch RNID record. The Switch RNID records report the state data for connected devices. You cannotcreate or update Switch RNID records. The switch must be an FC switch in Native mode.Most of the properties correspond to the definition of the RNID record in FC-SB and additional definitioncan be found in the specification.Flag: read-onlyConfig: falseKey: switch-addressThis list has the following leafs:switch-address

Description: The switch address (domain ID) of the Switch RNID record.Flag: read-onlyType: fibrechannel:brocade-hex-string-typeConfig: falseValue: The switch address (domain ID) of the Switch RNID record.Optional: Yes


Broadcom


switch-wwnDescription: The Switch Node WWN.Flag: read-onlyType: fibrechannel:wwn-typeConfig: falseValue: The Switch Node WWN.Optional: Yes

flagsDescription: The Flags field from the Switch RNID record.Flag: read-onlyType: fibrechannel:brocade-hex-string-typeConfig: falseValue: The Flags field from the Switch RNID record.Optional: Yes

node-parametersDescription: The Node Parameters field from the Switch RNID record.Flag: read-onlyType: fibrechannel:brocade-hex-string-typeConfig: falseValue: The Node Parameters field from the Switch RNID record.Optional: Yes

type-numberDescription: The type number of the node that describes the machine type of the switch.Flag: read-onlyType: stringConfig: falseValue: The type number of the node that describes the machine type of the switch.Optional: Yes

model-numberDescription: The model number of the switch.Flag: read-onlyType: stringConfig: falseValue: The model number of the switch.Optional: Yes

manufacturerDescription: The manufacturer or code for the manufacturer of the switch.Flag: read-onlyType: stringConfig: falseValue: The manufacturer or code for the manufacturer of the switch.Optional: Yes

plantDescription: The manufacturer plant name or code for the manufacturer plant of the switch.Flag: read-onlyType: stringConfig: falseValue: The manufacturer plant name or code for the manufacturer plant of the switch.Optional: Yes


Broadcom


sequence-numberDescription: The sequence number or serial of the switch.Flag: read-onlyType: stringConfig: falseValue: The sequence number of the switch.Optional: Yes

tagDescription: The physical identifier of the switch.Flag: read-onlyType: fibrechannel:brocade-hex-string-typeConfig: falseValue: The physical identifier of the switch.Optional: Yes

lirrDescription: A list of Link Incident Registration Record (LIRR) records from the FICON database. AllLIRR records for the entire fabric are returned unless a link-address is specified to return a single LIRRrecord. The LIRR records report the state data for registered devices. The switch must be an FC switch inNative mode.Flag: read-onlyConfig: falseKey: link-addressThis list has the following leafs:link-address

Description: The link address (first two bytes of the port identifier (PID)) of the LIRR record.Flag: read-onlyType: fibrechannel:brocade-hex-string-typeConfig: falseValue: The link address (first two bytes of the port identifier (PID)) of the LIRR record.Optional: Yes

formatDescription: The Format field from the LIRR record.Flag: read-onlyType: fibrechannel:brocade-hex-string-typeConfig: falseValue: 0x18 = Indicates the record is a FICON node identifier.Optional: Yes

port-typeDescription: The port type of the LIRR record.Flag: read-onlyType: fibrechannel:port-type-string-typeConfig: falseValue: The port type of the LIRR record.Optional: Yes

listener-port-wwnDescription: The Listener Port WWN.Flag: read-onlyType: fibrechannel:wwn-typeConfig: falseValue: The Listener Port WWN.


Broadcom


Optional: Yesswitch-port-wwn

Description: The Switch Port WWN.Flag: read-onlyType: fibrechannel:wwn-typeConfig: falseValue: The Switch Port WWN.Optional: Yes

listener-typeDescription: The Listener Type field from the LIRR record (such as Conditional, Conditional-C,and Conditional-S).Flag: read-onlyType: stringConfig: falseValue: The Listener Type field from the LIRR record (such as Conditional, Conditional-C, andConditional-S).Optional: Yes

rlirDescription: A list of Registered Link Incident Record (RLIR) records from the FICON database. All RLIRrecords for the entire fabric. You cannot select a single RLIR record. The RLIR records report the statedata for connected devices. You cannot create or update RLIR records.Some of the properties correspond to the definition of the RLIR record in FC-LS and the RNID record inFC-SB and additional definitions can be found in the specifications. The switch must be an FC switch inNative mode.Flag: read-onlyConfig: falseThis list has the following leafs:link-address

Description: The link address (first two bytes of the port identifier (PID)) of the RLIR record.Flag: read-onlyType: fibrechannel:brocade-hex-string-typeConfig: falseValue: The link address (first two bytes of the port identifier (PID)) of the RLIR record.Optional: Yes

formatDescription: The Format field from the RLIR record.Flag: read-onlyType: fibrechannel:brocade-hex-string-typeConfig: falseValue: 0x18 = Indicates the record is a FICON node identifier.Optional: Yes

port-typeDescription: The port type of the RLIR record.Flag: read-onlyType: fibrechannel:port-type-string-typeConfig: falseValue: The port type (such as f-port).Optional: Yes

port-indexDescription: The Physical Port Number field from the RLIR record.


Broadcom


Flag: read-onlyType: fibrechannel:user-port-number-typeConfig: falseValue: The Physical Port Number field.Optional: Yes

incident-countDescription: The Incident Count field from the RLIR record.Flag: read-onlyType: uint8Config: falseValue: The Incident Count field from the RLIR record. This number increases by 1 for eachincident within the switch.Optional: Yes

time-stamp-formatDescription: The Time Stamp Format field from the RLIR record.Flag: read-onlyType: uint8Config: falseValue: The time stamp format (such as 1).Optional: Yes

time-stampDescription: An ASCII string representation of the Time Stamp field from the RLIR record.Flag: read-onlyType: stringConfig: falseValue: The time stamp in day month date hour:minute:seconds year format.Optional: Yes

port-statusDescription: The Port Status field from the RLIR record.Flag: read-onlyType: stringConfig: falseValue: This value is returned as a string indicating the status (such as Link not operational).Optional: Yes

link-failure-typeDescription: The Link Failure Type field from the RLIR record.Flag: read-onlyType: stringConfig: falseValue: This value is returned as a string indicating the type of link failure (such as Loss of Signalor synchronization).Optional: Yes

registered-port-wwnDescription: The Registered Port WWN.Flag: read-onlyType: fibrechannel:wwn-typeConfig: falseValue: The Registered Port WWN.Optional: Yes


Broadcom


registered-node-wwnDescription: The Registered Node WWN.Flag: read-onlyType: fibrechannel:wwn-typeConfig: falseValue: The Registered Node WWN.Optional: Yes

port-flagsDescription: The Flags field from the the RLIR record.Flag: read-onlyType: fibrechannel:brocade-hex-string-typeConfig: falseValue: The Flags field from the the RLIR record.Optional: Yes

port-node-parametersDescription: The Node Parameters field from the RLIR record.Flag: read-onlyType: fibrechannel:brocade-hex-string-typeConfig: falseValue: The Node Parameters field from the RLIR record.Optional: Yes

port-type-numberDescription: The type number of the node that describes the machine type of the device.Flag: read-onlyType: stringConfig: falseValue: The type number of the node that describes the machine type of the device.Optional: Yes

port-model-numberDescription: The model number of the device.Flag: read-onlyType: stringConfig: falseValue: The model number of the device.Optional: Yes

port-manufacturerDescription: The manufacturer or code for the manufacturer of the device.Flag: read-onlyType: stringConfig: falseValue: The manufacturer or code for the manufacturer of the device.Optional: Yes

port-plantDescription: The manufacturer plant name or code for the manufacturer plant of the device.Flag: read-onlyType: stringConfig: falseValue: The manufacturer plant name or code for the manufacturer plant of the device.Optional: Yes


Broadcom


port-sequence-numberDescription: The sequence number of the device.Flag: read-onlyType: stringConfig: falseValue: The sequence number of the device.Optional: Yes

port-tagDescription: The physical identifier of the device.Flag: read-onlyType: fibrechannel:brocade-hex-string-typeConfig: falseValue: The physical identifier of the device.Optional: Yes

switch-port-wwnDescription: The Switch Port WWN.Flag: read-onlyType: fibrechannel:wwn-typeConfig: falseValue: The Switch Port WWN.Optional: Yes

switch-node-wwnDescription: The Switch Node WWN.Flag: read-onlyType: fibrechannel:wwn-typeConfig: falseValue: The Switch Node WWN.Optional: Yes

switch-flagsDescription: The Flags field from the the RLIR record.Flag: read-onlyType: fibrechannel:brocade-hex-string-typeConfig: falseValue: The Flags field from the the RLIR record.Optional: Yes

switch-node-parametersDescription: The Node Parameters field from the RLIR record.Flag: read-onlyType: fibrechannel:brocade-hex-string-typeConfig: falseValue: The Node Parameters field from the RLIR record.Optional: Yes

switch-type-numberDescription: The type number of the node that describes the machine type of the switch.Flag: read-onlyType: stringConfig: falseValue: The type number of the node that describes the machine type of the switch.Optional: Yes


Broadcom


switch-model-numberDescription: The model number of the device.Flag: read-onlyType: stringConfig: falseValue: The model number of the device.Optional: Yes

switch-manufacturerDescription: The manufacturer or code for the manufacturer of the device.Flag: read-onlyType: stringConfig: falseValue: The manufacturer or code for the manufacturer of the device.Optional: Yes

switch-plantDescription: The manufacturer plant name or code for the manufacturer plant of the device.Flag: read-onlyType: stringConfig: falseValue: The manufacturer plant name or code for the manufacturer plant of the device.Optional: Yes

switch-sequence-numberDescription: The sequence number of the device.Flag: read-onlyType: stringConfig: falseValue: The sequence number of the device.Optional: Yes

switch-tagDescription: The physical identifier of the device.Flag: read-onlyType: fibrechannel:brocade-hex-string-typeConfig: falseValue: The physical identifier of the device.Optional: Yes

Supported Methods

Only the GET, PATCH, OPTIONS, and HEAD operations are supported in this module.

Examples

This section provides basic examples for using the brocade-ficon module.

Viewing the FICON CUP Configuration

The following example uses the GET request to view the FICON CUP configuration.

Structure

GET <base_URI>/running/brocade-ficon/cup?vf-id=<vfid>

URI


Broadcom


GET https://10.10.10.10/rest/running/brocade-ficon/cup?vf-id=1

Request Body


Response Body



<Response>

<cup>

<fmsmode-enabled>true</fmsmode-enabled>

<programmed-offline-state-control>true</programmed-offline-state-control>

<user-alert-mode>false</user-alert-mode>

<active-equal-saved-mode>true</active-equal-saved-mode>

<director-clock-alert-mode>true</director-clock-alert-mode>

<mihpto>180</mihpto>

<unsolicited-alert-mode-fru-enabled>true</unsolicited-alert-mode-fru-enabled>

<unsolicited-alert-mode-hsc-enabled>true</unsolicited-alert-mode-hsc-enabled>

<unsolicited-alert-mode-invalid-attach-enabled>true</unsolicited-alert-mode-invalid-attach-enabled>

</cup>

</Response>

Enabling FMS Mode

Before you enable FMS mode, you must be connected to a FICON logical switch. For instructions, refer to the BrocadeFabric OS FICON Configuration Guide.

Note: You cannot disable FMS mode through the REST API interface. If a PATCH request is received with fmsmode-enabled=false, an error is returned.

The following example uses the PATCH request to enable FMS mode.

Structure

PATCH <base_URI>/running/brocade-ficon/cup?vf-id=<vfid>

URI

PATCH https://10.10.10.10/rest/running/brocade-ficon/cup?vf-id=1

Request Body

<cup>

<fmsmode-enabled>true</fmsmode-enabled>

</cup>

Response Body


Configuring FICON CUP

Before you configure FICON CUP, complete the following:


Broadcom


• Create a FICON logical switch (see brocade-fibrechannel-logical-switch)• Configure FICON (refer to the Brocade Fabric OS FICON Configuration Guide)

You can configure the following CUP parameters:

• Allow or prohibit programmed offline state control• Enable or disable Active=Saved mode• Enable or disable Director Clock Alert mode• Enable or disable the unsolicited alert types (HSC, FRU, and invalid attach)

The following example uses the PATCH request to enable offline state control, Active=Saved mode, and Director ClockAlert mode as well as enable the unsolicited alert types.

Structure

PATCH <base_URI>/running/brocade-ficon/?vf-id=<vfid>

URI

PATCH https://10.10.10.10/rest/running/brocade-ficon/cup?vf-id=1

Request Body

<cup>

<programmed-offline-state-control>true</programmed-offline-state-control>

<active-equal-saved-mode>true</active-equal-saved-mode>

<director-clock-alert-mode>true</director-clock-alert-mode>

<unsolicited-alert-mode-fru-enabled>true</unsolicited-alert-mode-fru-enabled>

<unsolicited-alert-mode-hsc-enabled>true</unsolicited-alert-mode-hsc-enabled>

<unsolicited-alert-mode-invalid-attach-enabled>true</unsolicited-alert-mode-invalid-attach-enabled>

</cup>

Response Body


Viewing the FICON Logical Paths

The following example uses the GET request to view the list of logical paths that are currently established to the ControlUnit Port (CUP)

Structure

GET <base_URI>/running/brocade-ficon/logical-path?vf-id=<vfid>

URI

GET https://10.10.10.10/rest/running/brocade-ficon/logical-path?vf-id=1

Request Body


Response Body


{


Broadcom


"Response": {

"logical-path": [

{

"link-address": "0x012b",

"channel-image-id": "0x03",

"operational-state": "Oper",

"reporting-path-state": "Alternate"

},

{

"link-address": "0x012a",



"reporting-path-state": "Current"

},

{

"link-address": "0x0129",


"operational-state": "Reset",

"reporting-path-state": ""

},

{

"link-address": "0x0128",



"reporting-path-state": ""

}

]

}

}

Configuring a FICON Logical Path

The following example uses the PATCH request to set the current reporting path using link address 0x0128 and channelimage id 0x03.

Structure

PATCH <base_URI>/running/brocade-ficon/logical-path/link-address/link_address/channel-image-id/channel_image_id/reporting-path-state/current?vf-id=<vfid>

URI

PATCH https://10.10.10.10/rest/running/brocade-ficon/logical-path/link-address/0x0128/channel-image-id/0x03/

reporting-path-state/current?vf-id=32

Request Body


Response Body



Broadcom


Viewing Request Node Identifier (RNID) Data

The following example uses the GET request to view the RNID information for VFID 1.

Structure

GET <base_URI>/running/brocade-ficon/rnid?vf-id=<vfid>

URI

GET https://10.10.10.10/rest/running/brocade-ficon/rnid?vf-id=1

Request Body


Response Body



<Response>

<rnid>

<format>0x18</format>


<link-address>0x0128</link-address>

<registered-port-wwn>c0:50:76:d5:5f:08:11:81</registered-port-wwn>

<registered-node-wwn>50:05:07:64:00:cf:c8:87</registered-node-wwn>

<flags>0x10</flags>

<node-parameters>0x31014c</node-parameters>

<type-number>003906</type-number>

<model-number>M02</model-number>

<manufacturer>IBM</manufacturer>

<plant>02</plant>

<sequence-number>0000000FC887</sequence-number>

<tag>0xc04c</tag>

</rnid>

<rnid>




<registered-port-wwn>c0:50:76:d5:5f:08:11:91</registered-port-wwn>


<flags>0x10</flags>

<node-parameters>0x31014d</node-parameters>




<plant>02</plant>


<tag>0xc04d</tag>

</rnid>

<rnid>



<link-address>0x012a</link-address>


Broadcom


<registered-port-wwn>c0:50:76:d5:5f:08:11:c1</registered-port-wwn>


<flags>0x10</flags>

<node-parameters>0x31014e</node-parameters>




<plant>02</plant>


<tag>0xc04e</tag>

</rnid>

<rnid>



<link-address>0x012b</link-address>

<registered-port-wwn>c0:50:76:d5:5f:08:11:d1</registered-port-wwn>


<flags>0x10</flags>

<node-parameters>0x31014f</node-parameters>




<plant>02</plant>


<tag>0xc04f</tag>

</rnid>

</Response>

Viewing Switch RNID Data

The following example uses the GET request to view the switch RNID information for VFID 1.

Structure

GET <base_URI>/running/brocade-ficon/switch-rnid?vf-id=<vfid>

URI

GET https://10.10.10.10/rest/running/brocade-ficon/switch-rnid?vf-id=1

Request Body


Response Body



<Response>

<switch-rnid>

<switch-address>0x01</switch-address>

<switch-wwn>10:00:c4:f5:7c:01:2a:21</switch-wwn>

<flags>0x00</flags>

<node-parameters>0x200a00</node-parameters>


Broadcom


<type-number>SLKWRM</type-number>

<model-number>630</model-number>

<manufacturer>BRD</manufacturer>

<plant>CA</plant>

<sequence-number>1FKF0324N005</sequence-number>

<tag>0x01ff</tag>

</switch-rnid>

</Response>

Viewing Link Incident Registration Record (LIRR) Data

The following example uses the GET request to view the LIRR information for VFID 1.

Structure

GET <base_URI>/running/brocade-ficon/lirr?vf-id=<vfid>

URI

GET https://10.10.10.10/rest/running/brocade-ficon/lirr?vf-id=1

Request Body


Response Body



<Response>

<lirr>




<listener-port-wwn>c0:50:76:d5:5f:08:11:81</listener-port-wwn>

<switch-port-wwn>20:28:c4:f5:7c:01:2a:21</switch-port-wwn>

<listener-type>Conditional-C</listener-type>

</lirr>

<lirr>




<listener-port-wwn>c0:50:76:d5:5f:08:11:91</listener-port-wwn>

<switch-port-wwn>20:29:c4:f5:7c:01:2a:21</switch-port-wwn>

<listener-type>Conditional-S</listener-type>

</lirr>

<lirr>



<link-address>0x012a</link-address>

<listener-port-wwn>c0:50:76:d5:5f:08:11:c1</listener-port-wwn>

<switch-port-wwn>20:2a:c4:f5:7c:01:2a:21</switch-port-wwn>

<listener-type>Conditional</listener-type>

</lirr>

<lirr>


Broadcom





<listener-port-wwn>c0:50:76:d5:5f:08:11:d1</listener-port-wwn>

<switch-port-wwn>20:2b:c4:f5:7c:01:2a:21</switch-port-wwn>

<listener-type>Conditional</listener-type>

</lirr>

</Response>

Viewing Registered Link Incident Record (RLIR) Data

The following example uses the GET request to view the RLIR information for VFID 1.

Structure

GET <base_URI>/running/brocade-ficon/rlir?vf-id=<vfid>

URI

GET https://10.10.10.10/rest/running/brocade-ficon/rlir?vf-id=1

Request Body


Response Body



<Response>

<rlir>


<port-type>f-port</port-type>



<incident-count>1</incident-count>

<time-stamp-format>1</time-stamp-format>

<time-stamp>Tue May 21 16:42:46 2019</time-stamp>

<port-status>Link not operational</port-status>

<link-failure-type>Not operational seq. recognized</link-failure-type>

<registered-port-wwn>c0:50:76:d5:5f:08:11:d1</registered-port-wwn>


<port-flags>0x10</port-flags>

<port-node-parameters>0x31014f</port-node-parameters>

<port-type-number>003906</port-type-number>

<port-model-number>M02</port-model-number>

<port-manufacturer>IBM</port-manufacturer>

<port-plant>02</port-plant>

<port-sequence-number>0000000FC887</port-sequence-number>

<port-tag>0xc04f</port-tag>

<switch-port-wwn>20:2b:c4:f5:7c:01:2a:21</switch-port-wwn>

<switch-node-wwn>10:00:c4:f5:7c:01:2a:21</switch-node-wwn>

<switch-flags>0x00</switch-flags>

<switch-node-parameters>0x200a2b</switch-node-parameters>

<switch-type-number>SLKWRM</switch-type-number>


Broadcom


<switch-model-number>630</switch-model-number>

<switch-manufacturer>BRD</switch-manufacturer>

<switch-plant>CA</switch-plant>

<switch-sequence-number>1FKF0324N005</switch-sequence-number>

<switch-tag>0x002b</switch-tag>

</rlir>

</Response>

History




Broadcom


brocade-fruThis module provides a detailed view of configuration and runtime information of the field replaceable units (FRU) installedin the chassis.

This module also provides information on installed blade, fan, and power-supply FRUs. In addition, customer-suppliedinformation, if included, can be viewed for each FRU type.

Module Tree

This is the tree view of the module from the brocade-fru.yang-tree.txt file. See YANG Module Overview for YANG nodefield definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-fru

+--rw brocade-fru

+--rw blade* [slot-number]

| +--rw slot-number uint16


| +--ro blade-type? string

| +--ro blade-id? uint16

| +--ro blade-state? string

| +--ro model-name? string

| +--ro firmware-version? fru:firmware-version-type

| +--ro fc-port-count? uint16

| +--ro ge-port-count? uint16

| +--ro ip-address-list

| | +--ro ip-address* inet:ip-address

| +--ro ip-gateway-list

| | +--ro ip-gateway* fru:ip-gateway-type

| +--ro subnet-mask? inet:ipv4-address

| +--ro primary-firmware-version? fru:firmware-version-type

| +--ro secondary-firmware-version? fru:firmware-version-type

| +--ro power-consumption? fru:power-detail-type

| +--ro power-usage? fru:power-detail-type

| +--ro extension-enabled? boolean

| +--rw extension-app-mode? string

| +--rw extension-ve-mode? string

| +--rw extension-ge-mode? string

| +--ro time-alive? fru:time-detail-type

| +--ro time-awake? fru:time-detail-type

| +--ro part-number? fru:part-number-type


+--ro fan* [unit-number]

| +--ro unit-number uint16

| +--ro power-consumption? fru:power-detail-type

| +--ro operational-state? string

| +--ro speed? uint32

| +--ro airflow-direction? air-flow-direction-type





+--ro power-supply* [unit-number]


Broadcom


| +--ro unit-number uint16

| +--ro power-production? uint32

| +--ro input-voltage? decimal64

| +--ro airflow-direction? air-flow-direction-type

| +--ro power-source? string

| +--ro operational-state? string

| +--ro temperature? decimal64

| +--ro power-usage? fru:power-detail-type

| +--ro temperature-sensor-supported? boolean





+--ro history-log* []

| +--ro fru-type? fru:fru-type

| +--ro position? uint16

| +--ro state? fru:state-type

| +--ro time-stamp? yang:date-and-time



+--ro sensor* [id]

| +--ro id uint16

| +--ro slot-number? uint16

| +--ro index? uint16

| +--ro state? fru:operational-state-type

| +--ro category? fru:sensor-category

| +--ro temperature? uint16

+--ro wwn* [unit-number]

+--ro unit-number uint16

+--ro airflow-direction? air-flow-direction-type

+--ro power-usage? fru:power-detail-type

+--ro generation-number? uint16 {fibrechannel:fibrechannel_chassis_platform}?

+--ro vendor-serial-number? string

+--ro vendor-part-number? string

+--ro vendor-revision-number? string

+--ro part-number? fru:part-number-type

+--ro serial-number? fru:serial-number-type

+--ro time-alive? fru:time-detail-type

+--ro time-awake? fru:time-detail-type

URI Format


• <base_URI>/running/brocade-fru/blade followed by the leafs as listed in the module tree to view informationabout all blades in the chassis.

• <base_URI>/running/brocade-fru/blade/slot-number/<slot-number> to view information about thespecified blade.

• <base_URI>/running/brocade-fru/fan followed by the leafs as listed in the module tree to view information aboutall fans in the chassis.


Broadcom


• <base_URI>/running/brocade-fru/fan/unit-number/<fan-unit> to view information about the specified fanunit.

• <base_URI>/running/brocade-fru/power-supply followed by the leafs as listed in the module tree to viewinformation about all power supplies in the chassis.

• <base_URI>/running/brocade-fru/power-supply/unit-number/<power-supply-unit> to viewinformation about the specified power-supply unit.

• <base_URI>/running/brocade-fru/history-log to view information about the FRU history.

• <base_URI>/running/brocade-fru/sensor/id/ followed by the leafs as listed in the module tree to viewinformation about the sensors.

• <base_URI>/running/brocade-fru/wwn/unit-number/<wwn_unit_number> to view information about theWWN card units.

Parametersbrocade-fru

Description: Configuration and runtime information of the FRUs installed in the chassis.Flag: read-writeThis container has the following leafs:blade

Description: A list of blade details for the specified slot number.Flag: read-writeKey: slot-numberThis list has the following leafs:slot-number

Description: The number of the physical slot in the chassis in which the blade is inserted.Flag: read-writeType: uint16Value: 0 through 12. 0 for a fixed-port switch. 1 through 12 for a chassisOptional: Yes

manufacturerDescription: The name of the blade manufacturer.Flag: read-onlyType: stringConfig: falseValue: 1 to 63 alphanumeric characters.Optional: Yes

blade-typeDescription: The type of blade (sw blade, cp blade, core blade, ap blade).Flag: read-onlyType: stringConfig: falseValue: 1 to 32 alphanumeric characters.Optional: Yes

blade-idDescription: The ID of the blade. This parameter is available only when the blade type is notunknown (blade-type != 'unknown').Flag: read-onlyType: uint16Config: false


Broadcom


Value: 1 to 1000.Optional: Yes

blade-stateDescription: The current state of the blade.Flag: read-onlyType: stringConfig: falseValue: 1 to 255 characters.Optional: Yes

model-nameDescription: A printable ASCII string that describes the model of the blade. This parameter isavailable only when the blade type is not unknown (blade-type != 'unknown') or the slot number isnot zero (slot-number != 0).Flag: read-onlyType: stringConfig: falseValue: 1 to 255 printable ASCII characters.Optional: Yes

firmware-versionDescription: A human-readable string that displays the firmware version running on the switch.For an AP blade, it displays the AP blade firmware version. For other blades, it displays the activeCP firmware version.Flag: read-onlyType: fru:firmware-version-typeConfig: falseValue: 1 to 255 printable ASCII characters.Optional: Yes

fc-port-countDescription: The number of FC ports supported by the blade. This parameter is availableonly when the blade type is not CP or not unknown (blade-type != 'cp blade' or blade-type !='unknown').Flag: read-onlyType: uint16Config: falseValue: 0 to 256.Optional: Yes

ge-port-countDescription: The number of GE ports supported by the blade. This parameter is available onlywhen extension is enabled or the blade ID is 75 (extension-enabled = true or blade-id = 75).Flag: read-onlyType: uint16Config: falseValue: 0 to 256.Optional: Yes

ip-address-listDescription: A list of IP addresses assigned to the CP blade. This parameter is available only forCP blades (blade-type = 'cp blade').Flag: read-onlyConfig: falseThis list has the following leaf:


Broadcom


ip-addressDescription: The list of IP addresses assigned to the CP blade.Flag: read-onlyType: inet:ip-addressValue: A valid IPv4 or IPv6 address.Optional: Yes

ip-gateway-listDescription: A list of gateway IP addresses of the CP blade. This parameter is available only forCP blades (blade-type = 'cp blade').Flag: read-onlyConfig: falseThis list has the following leaf:ip-gateway

Description: The list of gateway IP addresses of an IP router that can route packets tothe destination IP address. The gateway address must be on the same IP subnet as oneof the port IP addresses. This parameter is available only for CP blades (blade-type = 'cpblade').Flag: read-onlyType: fru:ip-gateway-typeValue: A valid IPv4 or IPv6 address.Optional: Yes

subnet-maskDescription: The IPv4 subnet mask of the switch IP network. This parameter is available only forCP blades (blade-type = 'cp blade').Flag: read-onlyType: inet:ipv4-addressValue: A valid IPv4 address.Optional: Yes

primary-firmware-versionDescription: A printable ASCII string that identifies the firmware version running on the primarypartition of the CP blade. This parameter is available only for CP blades (blade-type = 'cp blade').Flag: read-onlyType: fru:firmware-version-typeConfig: falseValue: 1 to 255 printable ASCII characters.Optional: Yes

power-consumptionDescription: The maximum power consumption allocated for the blade.Flag: read-onlyType: fru:power-detail-typeConfig: falseValue: The maximum power consumption allocated for the blade.Optional: Yes

power-usageDescription: The real-time power consumed by the FRU.Flag: read-onlyType: fru:power-detail-typeConfig: falseValue: The real-time power consumed by the FRU.Optional: Yes


Broadcom


secondary-firmware-versionDescription: A printable ASCII string that identifies the firmware version running on thesecondary partition of the CP blade. This parameter is available only for CP blades (blade-type ='cp blade').Flag: read-onlyType: fru:firmware-version-typeConfig: falseValue: 1 to 255 printable ASCII characters.Optional: Yes

extension-enabledDescription: Whether the switch or blade supports extension. For blade IDs 154, 186, and 213,the value is set to enabled (true).Flag: read-onlyType: booleanConfig: falseValue: true = Extension is supported. false = Extension is not suppported.Optional: Yes

extension-app-modeDescription: The application mode configuration of the extension blade or switch. Thisparameter is available only when extension is enabled (extension-enabled = true). Note thata change in the application mode configuration is a disruptive operation and that when theconfiguration change is successful, a switch automatically reboots and a blade automaticallypowers off and on. Blade ID 213 supports only hybrid mode. For blade ID 213, the default ishybrid mode. For blade ID 154 and 186, the default is FCIP mode.Flag: read-writeType: stringValue: FCIP = Supports FCIP-only tunnels. hybrid = Supports FCIP with IP Extension tunnels.unavailable = The value is unavailable at the moment. This is a read-only value and can be seenin specific scenarios where the information is not loaded because of a slot power off or a slotfaulty after reboot or powercycle.Optional: Yes

extension-ve-modeDescription: The VE mode configuration of the extension blade or switch. This parameter isavailable only when extension is enabled (extension-enabled = true). Note that a VE modeconfiguration change is a disruptive operation and that when the configuration change issuccessful, a switch automatically reboots and a blade automatically powers off and on. For bladeID 154 and 186, the default is 10VE mode. For blade ID 213, the default is not applicable.Flag: read-writeType: stringValue: not applicable = Not a supported configuration. 10VE = 10 VEs available for tunnelconfiguration (5 VE_Ports per DP). 10VE mode is required for hybrid mode operation. 20VE =20 VEs available for tunnel configuration (10 VE_Ports per DP). 20VE mode is allowed in FCIPmode only. unavailable = The value is unavailable at the moment. This is a read-only value andcan be seen in specific scenarios where the information is not loaded because of a slot power offor a slot faulty after reboot or powercycle.Optional: Yes

extension-ge-modeDescription: The GE mode configuration of the extension blade or switch. This parameter isapplicable only on the Brocade 7810 Extension Switch. In copper mode, the RJ-45 ports (ge0 andge1) are enabled and optical ports (ge2 and ge3) are disabled. In optical mode, the optical ports


Broadcom


(ge2 and ge3) are enabled and the RJ45 ports (ge0 and ge1) are disabled. For blade ID 154 and186, the default is not applicable. For blade ID 213, the default is optical.Flag: read-writeType: stringValue: not applicable = Not a supported configuration. optical = ge2 and ge3 use the first twooptical ports. copper = ge0 and ge1 use the front-end RJ-45 ports. The first two optical ports aredisabled. unavailable = The value is unavailable at the moment. This is a read-only value andcan be seen in specific scenarios where the information is not loaded because of a slot power offor a slot faulty after reboot or powercycle.Optional: Yes

time-aliveDescription: The number of days the FRU has been powered on.Flag: read-onlyType: fru:time-detail-typeConfig: falseValue: The number of days the FRU has been powered on.Optional: Yes

time-awakeDescription: The number of days since the FRU was last powered on.Flag: read-onlyType: fru:time-detail-typeConfig: falseValue: The number of days since the FRU was last powered on.Optional: Yes

part-numberDescription: The part number assigned by the organization responsible for producing ormanufacturing of the FRU.Flag: read-onlyType: fru:part-number-typeConfig: falseValue: The part number assigned by the organization responsible for producing or manufacturingof the FRU.Optional: Yes

serial-numberDescription: The serial-number resource contains a Printable ASCII String that specifies theserial number of the FRU.Flag: read-onlyType: fru:serial-number-typeConfig: falseValue: The serial-number resource contains a Printable ASCII String that specifies the serialnumber of the FRU.Optional: Yes

fanDescription: The details about the fan units.Flag: read-onlyKey: unit-numberConfig: falseThis list has the following leafs:unit-number

Description: The physical slot number in the chassis where the fan is located.


Broadcom


Flag: read-onlyType: uint16Value: 1 to 16.Optional: Yes

power-consumptionDescription: The maximum power consumption allocated for the fan in watts. Thisparameter is available only when the operational state is not absent (operational-state !='absent').Flag: read-onlyType: fru:power-detail-typeValue: —1000 to —1 watts.Optional: Yes

operational-stateDescription: The current operational state of the fan.Flag: read-onlyType: stringValue: The operational state of the fan (faulty, ok, below minimum, above maximum,absent, unknown, or not ok)Optional: Yes

speedDescription: The fan speed in RPM. This parameter is available only when theoperational state is ok (operational-state ='ok').Flag: read-onlyType: uint32Value: 1 to 100000 RPM.Optional: Yes

airflow-directionDescription: The air flow direction of the fan blowers. This parameter is available onlywhen the operational state is not absent (operational-state !='absent').Flag: read-onlyType: air-flow-direction-typeValue: The air flow direction of the fan blowers (forward (non-portside exhaust) ,non-portside exhaust, reverse (non-portside intake), non-portside intake, and not available).Optional: Yes




Broadcom


part-numberDescription: The part number assigned by the organization responsible for producing ormanufacturing of the FRU.Flag: read-onlyType: fru:part-number-typeConfig: falseValue: The part number assigned by the organization responsible for producing ormanufacturing of the FRU.Optional: Yes

serial-numberDescription: The serial-number resource contains a Printable ASCII String that specifiesthe serial number of the FRU.Flag: read-onlyType: fru:serial-number-typeConfig: falseValue: The serial-number resource contains a Printable ASCII String that specifies theserial number of the FRU.Optional: Yes

power-supplyDescription: The details about the power supply units.Flag: read-onlyKey: unit-numberThis list has the following leafs:unit-number

Description: The physical slot number of the chassis where the power supply is located.Flag: read-onlyType: uint16Value: 1 to 16.Optional: Yes

power-productionDescription: The maximum power production allocated for the power supply unit inwatts.Flag: read-onlyType: uint32Value: 0 to 10000 watts.Optional: Yes

input-voltageDescription: The input voltage of the power supply unit in volts.Flag: read-onlyType: decimal64Value: 0 to 900.99 volts.Optional: Yes

airflow-directionDescription: The air flow direction of the power supply fans.Flag: read-onlyType: air-flow-direction-typeValue: The air flow direction of the fan blowers (forward (non-portside exhaust) ,non-portside exhaust, reverse (non-portside intake), non-portside intake, and not available).Optional: Yes


Broadcom


power-sourceDescription: The power supply input voltage type.Flag: read-onlyType: stringValue: The input voltage type (such as AC, DC, HVAC, HVDC, or not available).Optional: Yes

operational-stateDescription: The operational state of the power supply.Flag: read-onlyType: stringValue: The operational state of the power supply (such as absent, ok, faulty, predictingfailure, unknown, or try reseating unit).Optional: Yes

temperatureDescription: The temperature of the power supply sensor in centigrade. This parameteris available only when the temperature monitoring is supported (temperature-sensor-supported = true)Flag: read-onlyType: decimal64Value: 0 to 300.00 centigrade.Optional: Yes

power-usageDescription: The real-time power consumed by the FRU.Flag: read-onlyType: fru:power-detail-typeConfig: falseValue: The real-time power consumed by the FRU.Optional: Yes

temperature-sensor-supportedDescription: Whether the power supply sensor supports temperature monitoring.Flag: read-onlyType: booleanValue: false = Temperature monitoring is not supported. true = Temperature monitoring issupported.Optional: Yes




Broadcom



serial-numberDescription: A Printable ASCII String that specifies the serial number of the chassis.Flag: read-onlyType: fru:serial-number-typeConfig: falseValue: A Printable ASCII String that specifies the serial number of the chassis.Optional: Yes

history-logDescription: The entire history log records of all FRU's.Flag: read-onlyConfig: falseOptional: YesThis list has the following leafs:fru-type

Description: The type of FRU.Flag: read-onlyType: fru:fru-typeValue: sw blade = The FRU is a switch blade. cp blade = The FRU is a CP blade. coreblade = The FRU is a core blade. application blade = The FRU is an application blade.fan = The FRU is a fan. wwn = The FRU is a WWN card. power supply = The FRU is apower supply. unknown = The FRU is unknown.Optional: Yes

positionDescription: The physical location in the chassis where the FRU is located. For a fanand powersupply, it is a unit number. For a slot, it is a slot number.Flag: read-onlyType: uint16Value: 1 to 12.Optional: Yes

stateDescription: The state of the FRU.Flag: read-onlyType: fru:state-typeValue: inserted = The FRU is inserted in the chassis. removed = The FRU is removedfrom the chassis. invalid = The FRU state is invalid.Optional: Yes

time-stampDescription: The timestamp of the generated event.Flag: read-onlyType: yang:date-and-timeValue: The timestamp of the generated event.


Broadcom


Optional: Yespart-number

Description: The part number assigned by the organization responsible for producing ormanufacturing of the FRU.Flag: read-onlyType: fru:part-number-typeConfig: falseValue: The part number assigned by the organization responsible for producing ormanufacturing of the FRU.Optional: Yes


sensorDescription: The sensor details.Flag: read-onlyKey: idConfig: falseOptional: NoThis list has the following leafs:id

Description: The sensor ID number in the chassis.Flag: read-onlyType: uint16Value: The sensor ID number in the chassis.Optional: No

slot-numberDescription: The physical slot number in the chassis in which the blade is inserted.Flag: read-onlyType: uint16Value: 1 to 12.Optional: Yes

indexDescription: The sensor index number for the specific FRU.Flag: read-onlyType: uint16Value: The sensor index number for the specific FRU.Optional: Yes

stateDescription: The current operational state of the sensor. The not ok state displays whenthe unit is faulty for an unknown reason.Flag: read-onlyType: fru:operational-state-typeValue: Valid values include: faulty, ok, below minimum, above maximum, absent,unknown, and not ok.Optional: Yes


Broadcom


categoryDescription: The FRU sensor type.Flag: read-onlyType: fru:sensor-categoryValue: temperature = The temperature sensor of the FRU.Optional: Yes

temperatureDescription: The temperature of the FRU sensor in centigrade.Flag: read-onlyType: uint16Value: The temperature of the FRU sensor in centigrade.Optional: Yes

wwnDescription: The WWN card unit details.Flag: read-onlyKey: unit-numberConfig: falseOptional: YesThis list has the following leafs:unit-number

Description: The physical slot number in the chassis in which the WWN card is inserted.Flag: read-onlyType: uint16Config: falseValue: 1 to 16.Optional: Yes

airflow-directionDescription: The system air flow direction.Flag: read-onlyType:Config: falseValue: Valid values include: forward (non-portside exhaust), non-portside exhaust,reverse (non-portside intake), non-portside intake, and not available.Optional: Yes

power-usageDescription: The real-time power consumed by the FRU. This parameter is applicableonly for chassis.Flag: read-onlyType: fru:power-detail-typeConfig: falseValue: The real-time power consumed by the FRU.Optional: Yes

generation-numberDescription: The WWN card generation number. The director must be an FC switch inNative mode.Flag: read-onlyType: uint16Config: falseValue: The WWN card generation number.Optional: Yes


Broadcom


vendor-serial-numberDescription: The serial number of the chassis assigned by the vendor.Flag: read-onlyType: stringConfig: falseValue: The serial number of the chassis assigned by the vendor.Optional: Yes

vendor-part-numberDescription: The part number of the chassis assigned by the vendor.Flag: read-onlyType: stringConfig: falseValue: The part number of the chassis assigned by the vendor.Optional: Yes

vendor-revision-numberDescription: The revision number of the chassis assigned by the vendor.Flag: read-onlyType: stringConfig: falseValue: The revision number of the chassis assigned by the vendor.Optional: Yes




time-awakeDescription: The number of days since the FRU was last powered on.Flag: read-onlyType: fru:time-detail-typeConfig: falseValue: The number of days since the FRU was last powered on.


Broadcom


Optional: Yes

Supported Methods

Only the GET, PATCH, and HEAD operations are supported in this module.

ExamplesViewing Data for all Blades in a ChassisThe following example uses the GET request to view data on all blades in the chassis.StructureGET <base_URI>/running/brocade-fru/bladeURIGET https://10.10.10.10/rest/running/brocade-fru/blade



<Response>

<blade>

<slot-number>1</slot-number>


<serial-number>DYK3213M01R</serial-number>


<blade-type>cp blade</blade-type>

<firmware-version>v8.2.1b_rc1_bld12</firmware-version>

<primary-firmware-version>v8.2.1b_rc1_bld12</primary-firmware-version>

<secondary-firmware-version>v8.2.1b_rc1_bld12</secondary-firmware-version>

<ip-address-list>


<ip-address>2620:100:4:fa01:c6f5:7cff:fe44:a5d9/64</ip-address>

</ip-address-list>


<ip-gateway-list>

<ip-gateway>10.38.64.1</ip-gateway>

<ip-gateway>fe80::126</ip-gateway>

</ip-gateway-list>

<model-name>CPX6</model-name>

<extension-enabled>false</extension-enabled>

<blade-id>175</blade-id>

<blade-state>enabled</blade-state>

<power-usage>-48</power-usage>

<time-alive>435</time-alive>

<time-awake>2</time-awake>

<power-consumption>-50</power-consumption>

</blade>


Broadcom


<blade>



<serial-number>DYK3213M03G</serial-number>


<blade-type>cp blade</blade-type>


<primary-firmware-version>v8.2.1b_rc1_bld12</primary-firmware-version>

<secondary-firmware-version>v8.2.1b_rc1_bld12</secondary-firmware-version>

<ip-address-list>


<ip-address>2620:100:4:fa01:c6f5:7cff:fe44:ac91/64</ip-address>

</ip-address-list>


<ip-gateway-list>


<ip-gateway>fe80::126</ip-gateway>

</ip-gateway-list>

<model-name>CPX6</model-name>








</blade>

.

.

.

<blade>



<serial-number>FDU0325N021</serial-number>


<blade-type>sw blade</blade-type>


<model-name>FC32-64</model-name>

<fc-port-count>64</fc-port-count>








</blade>

</Response>

Viewing Data for a Specific BladeThe following example uses the GET request to view data for a specific blade (6).


Broadcom


StructureGET <base_URI>/running/ brocade-fru/blade/slot-number/slot-number

URIGET https://10.10.10.10/rest/running/brocade-fru/blade/slot-number/6



<Response>

<blade>



<serial-number>DZD3213M011</serial-number>


<blade-type>core blade</blade-type>


<model-name>CR32-4</model-name>

<fc-port-count>32</fc-port-count>








</blade>

</Response>

Setting the Extension Application Mode ConfigurationThe following example uses the PATCH request to set the application mode configuration of the Extensionblade to FCIP.StructurePATCH <base_URI>/running/brocade-fru/bladeURIPATCH https://10.10.10.10/rest/running/brocade-fru/blade

Request Body

<blade>


<extension-app-mode>FCIP</extension-app-mode>

<blade>


Broadcom


Response BodyWhen the operation is successful, the response has an empty message body and a “204 No Content” statusappears in the header.Setting the Extension VE Mode ConfigurationThe following example uses the PATCH request to set the VE mode configuration of the Extension blade to20VE.StructurePATCH <base_URI>/running/brocade-fru/bladeURIPATCH https://10.10.10.10/rest/running/brocade-fru/blade

Request Body

<blade>


<extension-ve-mode>20VE</extension-ve-mode>

<blade>

Response BodyWhen the operation is successful, the response has an empty message body and a “204 No Content” statusappears in the header.Setting the Extension GE Mode ConfigurationThe following example uses the PATCH request to set the GE mode configuration of the Extension blade tooptical.StructurePATCH <base_URI>/running/brocade-fru/bladeURIPATCH https://10.10.10.10/rest/running/brocade-fru/blade

Request Body

<blade>


<extension-ge-mode>optical</extension-ge-mode>

<blade>

Response BodyWhen the operation is successful, the response has an empty message body and a “204 No Content” statusappears in the header.Viewing Data for all Fans in the ChassisThe following example uses the GET request to view data on all fans in the chassis.StructureGET <base_URI>/running/brocade-fru/fanURIGET https://10.10.10.10/rest/running/brocade-fru/fan


Broadcom




<Response>

<fan>

<unit-number>1</unit-number>

<serial-number>DYL3017M0BG</serial-number>



<operational-state>ok</operational-state>

<airflow-direction>non-portside intake</airflow-direction>

<speed>5076</speed>



</fan>

<fan>


<serial-number>DYL3017M06K</serial-number>





<speed>5012</speed>



</fan>

</Response>

Viewing Data for a Specific FanThe following example uses the GET request to view data for a specific fan (1) in the chassis.StructureGET <base_URI>/running/brocade-fru/fan/unit-number/fan-unit

URIGET https://10.10.10.10/rest/running/brocade-fru/fan/unit-number/1



<Response>

<fan>



Broadcom







<speed>5076</speed>



</fan>

</Response>

Viewing Data for all Power Supplies in a ChassisThe following example uses the GET request to view data on all power supplies in the chassis.StructureGET <base_URI>/running/brocade-fru/power-supplyURIGET https://10.10.10.10/rest/running/brocade-fru/power-supply



<Response>

<power-supply>


<serial-number>DUC2M32M2FD</serial-number>


<power-production>2870</power-production>

<power-source>AC</power-source>



<input-voltage>203.50</input-voltage>

<temperature>30.00</temperature>



<temperature-sensor-supported>true</temperature-sensor-supported>

</power-supply>

<power-supply>


<serial-number>DUC2M32M2ME</serial-number>









Broadcom





</power-supply>

</Response>

Viewing Data for a Specific Power SupplyThe following example uses the GET request to view data on a specific power supply (1) in the chassis.StructureGET <base_URI>/running/brocade-fru/power-supply/unit-number/power-supply-unit

URIGET https://10.10.10.10/rest/running/brocade-fru/power-supply/unit-number/1



<Response>

<power-supply>













</power-supply>

</Response>

Viewing the History Log

This example uses a GET request to view the history log for all FRUs in the chassis.

Structure

GET <base_URI>/running/brocade-fru/history-log

URI

GET https://10.10.10.10/rest/running/brocade-fru/history-log

Request Body


Response Body


Broadcom



<Response>

<history-log>

<fru-type>core blade</fru-type>

<position>5</position>

<state>inserted</state>

<time-stamp>2017-06-14T13:11:31-06:00</time-stamp>



</history-log>

<history-log>

<fru-type>power supply</fru-type>






</history-log>

<history-log>





<serial-number>DUC2M32M2ME</serial-number>


</history-log>

<history-log>

<fru-type>fan</fru-type>






</history-log>

<history-log>

<fru-type>fan</fru-type>




<serial-number>DYL3017M06K</serial-number>


</history-log>

<history-log>

<fru-type>wwn</fru-type>




<serial-number>DZH3010M018</serial-number>


</history-log>

<history-log>


Broadcom


<fru-type>wwn</fru-type>






</history-log>

<history-log>

<fru-type>cp blade</fru-type>






</history-log>

<history-log>

<fru-type>sw blade</fru-type>






</history-log>

<history-log>

<fru-type>cp blade</fru-type>






</history-log>

<history-log>



<state>removed</state>




</history-log>

<history-log>







</history-log>

<history-log>







Broadcom



</history-log>

<history-log>







</history-log>

<history-log>







</history-log>

<history-log>





<serial-number>DYJ3232N09B</serial-number>


</history-log>

<history-log>







</history-log>

<history-log>







</history-log>

<history-log>







</history-log>

</Response>


Broadcom


Viewing Sensor Data

This example uses a GET request to view data for sensor ID 3 in the chassis.

Structure

GET <base_URI>/brocade-fru/sensor/id/sensor_id_number

URI

GET https://10.10.10.10/rest/brocade-fru/sensor/id/3

Request Body

Request Body


Response Body


<Response>

<sensor>

<id>3</id>


<index>0</index>

<state>ok</state>

<category>temperature</category>

<temperature>52</temperature>

</sensor>

</Response>

Viewing Data for a WWN Card

This example uses a GET request to view data on a WWN card in the chassis.

Structure

GET <base_URI>/brocade-fru/wwn/unit-number/wwn_unit_number

URI

GET https://10.10.10.10/rest/brocade-fru/wwn/unit-number/wwn_unit_number

Request Body


Response Body


<Response>

<wwn>




<generation-number>6</generation-number>


Broadcom


<vendor-revision-number>a</vendor-revision-number>

<vendor-part-number>dfasdf</vendor-part-number>

<vendor-serial-number>adfaasdfasdf</vendor-serial-number>





</wwn>

</Response>

History



Fabric OS 8.2.1b This API call was modified to add the power-consumption, power-usage, time-alive, andtime-awake parameters.

Fabric OS 9.0.0 This API call was modified to add the temperature-sensor-supported parameter to thepower-supply list and add the history-log, sensor, and wwn lists.


Broadcom


brocade-interface/fibrechannelThe Fibre Channel parameters in this module retrieve information for all Fibre Channel ports on the specified switch. Ifvirtual fabrics are enabled, then the request can include a query parameter (vf-id) for the desired virtual fabric. If no queryparameter is specified and virtual fabrics are enabled, the port information for the switch in the default virtual fabric isreturned.

NOTEThe brocade-fibrechannel, brocade-extension-ip-interface, and brocade-gigabitethernet modules have beenmerged into the brocade-interface module in Fabric OS 8.2.1b or later. However, this section only coversbrocade-fibrechannel. For information about brocade-extension-ip-interface, see brocade-interface/extension-ip-interface. For information about brocade-gigabitethernet, see brocade-interface/gigabitethernet.

This module augments the interface and interface-state lists defined in the ietf-interfaces module as defined in RFC 7223with Fibre Channel data nodes, and it adds Fibre Channel state data.

Module Tree

This is the tree view of the module from the brocade-interface.yang-tree.txt file. See YANG Module Overview for YANGnode field definitions and possible values, and see Supported Data Types for data type descriptions.module: brocade-interface

+--rw brocade-interface

+--rw fibrechannel* [name]

| +--rw name string

| +--ro wwn? fibrechannel:wwn-type





| +--rw speed? brocade-interface-types:fc-speed-type

| +--ro max-speed? brocade-interface-types:fc-speed-type

| +--ro auto-negotiate? uint8

| o--rw g-port-locked? uint8 {fibrechannel:fibrechannel_switch_platform}?

| +--rw e-port-disable? uint8 {fibrechannel:fibrechannel_switch_platform}?

| +--rw n-port-enabled? uint8 {fibrechannel:access_gateway_platform}?

| +--rw d-port-enable? uint8

| +--rw persistent-disable? uint8

| +--ro neighbor

| | +--ro wwn* fibrechannel:wwn-type

| +--ro neighbor-node-wwn? fibrechannel:wwn-type

| +--ro neighbor-port-index? fibrechannel:user-port-number-type

| +--ro neighbor-switch-user-friendly-name? string



| x--ro port-type? brocade-interface-types:port-type-type

| +--ro port-type-string? port-type-string-type

| +--rw qos-enabled? uint8

| +--rw compression-configured? uint8 {fibrechannel:fibrechannel_switch_platform}?

| +--rw encryption-enabled? uint8 {fibrechannel:fibrechannel_switch_platform}?

| +--ro compression-active? uint8 {fibrechannel:fibrechannel_switch_platform}?

| +--ro encryption-active? uint8 {fibrechannel:fibrechannel_switch_platform}?

| +--rw target-driven-zoning-enable? uint8

| +--rw sim-port-enabled? uint8 {fibrechannel:fibrechannel_switch_platform}?

| +--rw mirror-port-enabled? int8


Broadcom



| +--rw credit-recovery-enabled? int8

| +--ro credit-recovery-active? int8

| +--ro fec-active? int8

| +--rw f-port-buffers? uint8

| +--rw e-port-credit? uint8

| +--rw csctl-mode-enabled? int8 {fibrechannel:fibrechannel_switch_platform}?

| +--rw fault-delay-enabled? uint8

| +--rw octet-speed-combo? int8

| +--ro long-distance? uint8 {fibrechannel:fibrechannel_switch_platform}?

| +--ro vc-link-init? uint8 {fibrechannel:fibrechannel_switch_platform}?

| +--rw isl-ready-mode-enabled? uint8 {fibrechannel:fibrechannel_switch_platform}?

| +--rw rscn-suppression-enabled? uint8 {fibrechannel:fibrechannel_switch_platform}?

| +--rw los-tov-mode-enabled? uint8

| +--rw npiv-enabled? uint8

| +--rw npiv-pp-limit? int16

| +--ro npiv-flogi-logout-enabled? int8

| +--rw ex-port-enabled? uint8 {fibrechannel:fibrechannel_switch_platform}?

| +--rw edge-fabric-id? fibrechannel:fabric-id-type

| +--rw preferred-front-domain-id? fibrechannel:domain-id-type

| +--ro neighbor-switch-ipv4-address? inet:ipv4-address

| +--ro neighbor-switch-ipv6-address? inet:ipv6-address

| +--rw fec-enabled? int8

| +--ro via-tts-fec-enabled? int8

| +--rw port-autodisable-enabled? uint8

| o--rw rate-limit-enabled? int16 {fibrechannel:fibrechannel_switch_platform}?

| o--rw non-dfe-enabled? uint8 {fibrechannel:fibrechannel_switch_platform}?

| +--rw trunk-port-enabled? uint8

| +--ro default-index? fibrechannel:user-port-number-type

| +--ro physical-state? string

| x--ro pod-license-status? boolean

| +--rw pod-license-state? enumeration

{fibrechannel:fibrechannel_standalone_switch_platform}?

| +--ro index? fibrechannel:user-port-number-type

| +--ro reserved-buffers? uint16

| +--ro average-transmit-buffer-usage? uint16

| +--ro average-transmit-frame-size? uint16

| +--ro average-receive-buffer-usage? uint16

| +--ro average-receive-frame-size? uint16

| +--ro current-buffer-usage? uint16

| +--ro recommended-buffers? uint16

| +--ro measured-link-distance? string

| +--ro chip-instance? uint16

| +--ro chip-buffers-available? uint16

| +--ro port-health? string

| +--ro authentication-protocol? string

| +--rw disable-reason? string

| +--ro areas

| | +--ro area* fibrechannel:fcid-hex-string-type

| +--ro le-domain? uint16

| +--rw port-peer-beacon-enabled? boolean

| +--rw clean-address-enabled? boolean {fibrechannel:fibrechannel_switch_platform}?

| +--rw congestion-signal-enabled? boolean {fibrechannel:fibrechannel_switch_platform}?

| +--ro segmentation-reason? string


Broadcom


+--rw fibrechannel-statistics* [name]

| +--rw name string

| +--ro sampling-interval? uint16

| +--ro time-generated? fibrechannel:time-generated-type

| +--rw reset-statistics? uint8

| +--ro in-octets? yang:zero-based-counter64

| +--ro out-octets? yang:zero-based-counter64

| +--ro in-multicast-pkts? yang:zero-based-counter64

| +--ro out-multicast-pkts? yang:zero-based-counter64

| +--ro in-link-resets? yang:zero-based-counter64

| +--ro out-link-resets? yang:zero-based-counter64

| +--ro in-offline-sequences? yang:zero-based-counter64

| +--ro out-offline-sequences? yang:zero-based-counter64

| +--ro invalid-ordered-sets? yang:zero-based-counter64

| +--ro frames-too-long? yang:zero-based-counter64

| +--ro truncated-frames? yang:zero-based-counter64

| +--ro address-errors? yang:zero-based-counter64

| +--ro delimiter-errors? yang:zero-based-counter64

| +--ro encoding-disparity-errors? yang:zero-based-counter64

| +--ro too-many-rdys? yang:zero-based-counter64

| +--ro in-crc-errors? yang:zero-based-counter64

| +--ro crc-errors? yang:zero-based-counter64

| +--ro bad-eofs-received? yang:zero-based-counter64

| +--ro encoding-errors-outside-frame? yang:zero-based-counter64

| +--ro multicast-timeouts? yang:zero-based-counter64

| +--ro in-lcs? yang:zero-based-counter64

| +--ro in-frame-rate? yang:zero-based-counter64

| +--ro out-frame-rate? yang:zero-based-counter64

| +--ro in-max-frame-rate? yang:zero-based-counter64

| +--ro out-max-frame-rate? yang:zero-based-counter64

| +--ro in-rate? yang:zero-based-counter64

| +--ro out-rate? yang:zero-based-counter64

| +--ro in-peak-rate? yang:zero-based-counter64

| +--ro out-peak-rate? yang:zero-based-counter64

| +--ro in-frames? yang:zero-based-counter64

| +--ro out-frames? yang:zero-based-counter64

| +--ro bb-credit-zero? yang:zero-based-counter64

| +--ro input-buffer-full? yang:zero-based-counter64

| +--ro f-busy-frames? yang:zero-based-counter64

| +--ro p-busy-frames? yang:zero-based-counter64

| +--ro f-rjt-frames? yang:zero-based-counter64

| +--ro p-rjt-frames? yang:zero-based-counter64

| +--ro class-1-frames? yang:zero-based-counter64



| +--ro class-3-discards? yang:zero-based-counter64

| +--ro link-failures? yang:zero-based-counter64

| +--ro invalid-transmission-words? yang:zero-based-counter64

| +--ro primitive-sequence-protocol-error? yang:zero-based-counter64

| +--ro loss-of-signal? yang:zero-based-counter64

| +--ro loss-of-sync? yang:zero-based-counter64

| +--ro class3-in-discards? yang:zero-based-counter64

| +--ro class3-out-discards? yang:zero-based-counter64


Broadcom


| +--ro pcs-block-errors? yang:zero-based-counter64

| +--ro remote-link-failures? yang:zero-based-counter64

| +--ro remote-invalid-transmission-words? yang:zero-based-counter64

| +--ro remote-primitive-sequence-protocol-error? yang:zero-based-counter64

| +--ro remote-loss-of-signal? yang:zero-based-counter64

| +--ro remote-loss-of-sync? yang:zero-based-counter64

| +--ro remote-crc-errors? yang:zero-based-counter64

| +--ro remote-fec-uncorrected? yang:zero-based-counter64

| +--ro remote-buffer-credit-info

| | +--ro bb-credit? yang:zero-based-counter64

| | +--ro peer-bb-credit? yang:zero-based-counter64

| +--ro link-level-interrupts? yang:zero-based-counter64

| +--ro frames-processing-required? yang:zero-based-counter64

| +--ro frames-timed-out? yang:zero-based-counter64

| +--ro frames-transmitter-unavailable-errors? yang:zero-based-counter64

+--rw extension-ip-interface* [name dp-id ip-address] {fibrechannel:fibrechannel_extension_platform}?

...

+--rw gigabitethernet* [name] {fibrechannel:fibrechannel_extension_platform}?

...

+--rw gigabitethernet-statistics* [name] {fibrechannel:fibrechannel_extension_platform}?

...

+--ro logical-e-port* [port-index] {fibrechannel:fibrechannel_extended_isl}?

| +--ro port-index fibrechannel:user-port-number-type

| +--ro fabric-id? fibrechannel:fabric-id-type

| +--ro operational-status? enumeration

| +--ro offline-reason? enumeration


| +--ro associated-physical-ports

| +--ro port* fibrechannel:slot-port-name-type

+--rw portchannel* [name] {fibrechannel:portchannel_platform}?

...

URI Formats


• <base_URI>/running/brocade-interface/fibrechannel/ to return a list of all Fibre Channel ports on thespecified switch.

• <base_URI>/running/brocade-interface/fibrechannel-statistics/ to return the statistics for all FibreChannel ports on the specified switch.

• <base_URI>/running/brocade-interface/fibrechannel-statistics/fibre-channel-interface-name/trunk-enabled to return the trunk settings for a physical port.

• <base_URI>/running/brocade-interface/fibrechannel/name/fibre-channel-interface-name/n-port-enabled to configure a port as an N_Port.

• <base_URI>/running/brocade-fibrechannel-switch/fibrechannel-switch/name/switch-worldwide-name/ag-mode to determine if the switch is in Access Gateway mode.

• <base_URI>/running/brocade-interface/logical-e-port/port-index/port_index to view a list oflogical E_Port interfaces on the device which form the logical inter switch link (LISL).


Broadcom


Parametersbrocade-interface

Description: All Fibre Channel interface-related configuration, operational state, and statistics.Flag: read-writeType: stringThis container has the following leafs:fibrechannel

Description: A list of interfaces on the device. System-controlled interfaces created by the system arealways present in this list, whether they are configured or not.Flag: read-writeKey: nameThis list has the following leafs:name

Description: The name of the interface.Flag: read-writeType: stringValues: The slot and port number of the specified port in the format slot/port.Optional: No

wwnDescription: The world wide name (WWN) of the specified port.Flag: read-onlyType: fibrechannel:wwn-typeConfig: falseValues: A valid WWN name.Optional: Yes

operational-statusDescription: The current operational status of the specified port.Flag: read-onlyType: uint32Config: falseValues:0 = Undefined2 = Online/Testing3 = Offline5 = Faulty6 = TestingOptional: Yes

enabled-stateDescription: The parameter is deprecated. Use the is-enabled-state parameter. The currentstate of the specified port.Flag: read-writeType: uint32Config: falseValues: 2 = Port is enabled. 6 = Port is disabled.Optional: Yes

is-enabled-stateDescription: The current state of the specified port.Flag: read-writeType: booleanValues: true = Port is enabled. false = Port is disabled.


Broadcom


Optional: Yesuser-friendly-name

Description: A user-friendly name to be assigned to the specified port.When a port name is not configured, a default name is assigned. The format of the default nameis as follows:• On stand-alone platforms, the default port name displays as port<port-number>, for example,port10.• On enterprise-class platforms, the default port name displays as slot<slot-number> port<port-number, for example, slot1 port5.Provide a null string to replace the existing name with the default.Flag: read-writeType: stringConfig: falseValues: 1 to 128 alphanumeric characters, excluding '(', ')', ',', ';', and '@'.Optional: Yes

speedDescription: The Fibre Channel interface may operate at various speeds; this leaf forces theport interface to operate at a particular speed. Without any explicit speed set (for example, havingthe auto-negotiate value set), the Fibre Channel interfaces run at the maximum speed, subject tospeed negotiations with their neighbor. The value 0 is returned only when auto-negotiate is setand the port has not yet negotiated the speed with the other end (for example, if the port is offlineor is syncing). Otherwise, the negotiated speed or the fixed speed is returned. To determinewhether the speed was auto-negotiated or fixed, see the auto-negotiate leaf.Flag: read-writeType: fc-speed-typeValues: 0 = The auto-negotiated speed (default). 1000000000 = Fixed at 1Gb/s. 2000000000= Fixed at 2Gb/s. 4000000000 = Fixed at 4Gb/s. 8000000000 = Fixed at 8Gb/s. 10000000000= Fixed at 10Gb/s. 16000000000 = Fixed at 16Gb/s. 32000000000 = Fixed at 32Gb/s.53000000000 = Fixed at 53Gb/s. 64000000000 = Fixed at 64Gb/s.Optional: Yes

max-speedDescription: The maximum speed that the port is capable of supporting in bits per second. Notethat this parameter is not applicable to Gen 7 ports.Flag: read-onlyType: fc-speed-typeConfig: falseValues: 0 = The auto-negotiated speed (default). 1000000000 = Fixed at 1Gb/s. 2000000000= Fixed at 2Gb/s. 4000000000 = Fixed at 4Gb/s. 8000000000 = Fixed at 8Gb/s. 10000000000= Fixed at 10Gb/s. 16000000000 = Fixed at 16Gb/s. 32000000000 = Fixed at 32Gb/s.53000000000 = Fixed at 53Gb/s. 64000000000 = Fixed at 64Gb/s.Optional: Yes

auto-negotiateDescription: Whether the port speed is auto-negotiated on the specified port.Flag: read-onlyType: uint8Config: falseValues: 0 = Port speed is fixed. 1 = Port speed is auto-negotiated.Optional: Yes

g-port-lockedDescription: Designates the specified port as a G_Port. Note that the Fibre Channel switchNative mode must be supported. After successful execution, the switch attempts to initialize the


Broadcom


specified port as an F_Port only and does not attempt loop initialization (FL_Port) on the port. Aport that is designated as a G_Port can become an E_Port. This configuration can be clearedbut not set on VE or VEX_Ports. Changes made by this command are persistent across switchreboots or power cycles.

NOTEThis parameter is obsolete.

Flag: read-writeType: uint8Config: falseValues: 0 = Unlocked (removes the G_Port designation from the port). 1 = Locked (the port isdesignated as a G_Port).Optional: Yes

e-port-disableDescription: Enables or disables E_Port capability on the specified port or locks down thespecified port as an E_Port. Note that the Fibre Channel switch Native mode must be supported.E_Port capability is enabled by default. When an inter-switch link (ISL) is connected to a port andthe port's E_Port capability is disabled, the ISL is segmented, and all traffic between the switchesstops. Fabric management data, such as zoning information, can no longer be exchangedthrough this port.Flag: read-writeType: uint8Values: 0 = Enables the port as an E_Port. 1 = Disables E_Port capability for the specified port.Default: 0.Optional: Yes

n-port-enabledDescription: Indicates whether this port can operate as an N_Port. Note that the Fibre Channelswitch must be in Access Gateway mode.Flag: read-writeType: uint8Values: 0 = Port is disabled as an N_Port. 1 = Port is enabled as an N_Port.Optional: Yes

d-port-enableDescription: Indicates whether this port is configured as a D_Port. This resource is only on 16-Gb/s-capable blades that support D_Port capability.Flag: read-writeType: uint8Values: 0 = Port is disabled as a D_Port. 1 = Port is enabled as a D_Port.Optional: Yes

persistent-disableDescription: Status of the persistent-disable feature for the port.Flag: read-writeType: uint8Values: 0 = Persistent-disable is not active for the port. 1 = Persistent-disable is active for theport.Optional: Yes

neighborDescription: A list of WWNs.Flag: read-onlyConfig: falseThis container has the following leaf:


Broadcom


wwnDescription: The Fibre Channel WWN of the neighbor port.Flag: read-onlyType: fibrechannel:wwn-typeConfig: falseValues: A valid WWN name.Optional: No

neighbor-node-wwnDescription: The neighbor node WWN connected to this port. This parameter is available onlywhen the switch operational status is online or testing (operational-status = 2).Flag: read-onlyType: fibrechannel:wwn-typeConfig: falseValues: A valid WWN name.Optional: Yes

neighbor-port-indexDescription: The immediate neighbor port index connected to this port. This parameter isavailable only when the switch operational status is online or testing (operational-status = 2) andthe port type is E_Port or EX_Port.Flag: read-onlyType: fibrechannel:user-port-number-typeConfig: falseValues: –1 to 3400.Optional: Yes

neighbor-switch-user-friendly-nameDescription: The Fibre Channel user-friendly name of the adjacent switch. This parameter isavailable only when the switch operational status is online or testing (operational-status = 2) andthe port type is E_Port or EX_Port.Flag: read-onlyType: stringConfig: falseValues: The Fibre Channel user-friendly name of the adjacent switch.Optional: Yes

fcidDescription: This parameter is deprecated. Use the fcid-hex parameter. The Fibre Channel ID(FCID) of the specified port (decimal format).Flag: read-onlyType: fibrechannel:fcid-typeConfig: falseValues: A valid Fibre Channel ID.Optional: Yes

fcid-hexDescription: The Fibre Channel ID (FCID) of the specified port (hexadecimal format).Flag: read-onlyType: fibrechannel:fcid-hex-string-typeConfig: falseValues: A valid Fibre Channel ID of the port.Optional: Yes


Broadcom


port-typeDescription: This parameter is deprecated. Use the port-type-string leaf instead. The port typecurrently enabled for the specified port. If this port is logged in, this is the negotiated port type;otherwise, the configured port type is reported.Flag: read-onlyType: port-type-typeConfig: falseValues: 0 = Unknown. 7 = E_Port. 10 = G_Port. 11 = U_Port (Default). 15 = F_Port. 16 = L_Port.17 = FCoE Port. 19 = EX_Port. 20 = D_Port. 21 = SIM Port. 22 = AF_Port. 23 = AE_Port. 25 =VE_Port. 26 = Ethernet Flex Port. 29 = Flex Port. 30 = N_Port. 32768 = LB_Port.Optional: Yes

port-type-stringDescription: The currently enabled port type for the specified port. If the port is logged in, itdisplays the negotiated port type; otherwise, it displays the configured port type.Flag: read-onlyType: port-type-string-typeConfig: falseValue: e-port = The port is an E_Port. g-port = The port is a G_Port. universal-port = Theport is not configured for any type. f-port = The port is a F_Port. l-port = The port is a Logicalport. fcoe-port = The port is a FCoE_Port. ex-port = The port is a EX_Port. d-port = The portis a Diagnostic port. sim-port = The port is SIM port. af-port = The port is AF_Port. AF_Portsare present only on AMP switches. ae-port = The port is an AE_Port. ve-port = The port is aVE_Port. ethernet-port = The port is an Ethernet Flex port. flex-port = The port is a Flex port.n-port = The port is N_Port. N_Ports are applicable for AG mode. mirror-port = The port is aMirror port. encryption-support-port = The port is an Encryption Support Port. A front-end portthat is reserved for the Encryption block to work. loopback-port = The port is a Loopback port.unknown-port = The port is online and does not belong any known port type.Optional: Yes

qos-enabledDescription: Indicates whether QoS is enabled on the port.Flag: read-writeType: uint8Values: 0 = Port QoS disabled. 1 = Port QoS enabled.Optional: Yes

compression-configuredDescription: Enables or disables the compression configuration on the specified port. Thischange is persistent. Configuring a port for compression is disruptive. You must disable the portbefore you can enable compression on the port. This command fails on an enabled port. Thenumber of configurable ports is limited by the platform ASIC. The switch must be an FC switch inNative mode.Flag: read-writeType: uint8Values: 0 = Compression configuration disabled. 1 = Compression configuration enabled.Optional: Yes

encryption-enabledDescription: Enables or disables the encryption configuration on the port. This change ispersistent. Configuring a port for encryption is disruptive. You must disable the port before youcan enable compression on the port. This command fails on an enabled port. The number ofconfigurable ports is limited by the platform ASIC. The switch must be an FC switch in Nativemode.Flag: read-write


Broadcom


Type: uint8Value: 0 = Disables the encryption configuration on the specified port. 1 = Enables the encryptionconfiguration on the specified port.Optional: Yes

compression-activeDescription: The runtime compression status for the specified port. The switch must be an FCswitch in Native mode.Flag: read-onlyType: uint8Config: falseValues: 0 = Port is enabled for compression but offline, or not enabled for compression. 1 = Portis online and compression is enabled.Optional: Yes

encryption-activeDescription: The encryption status for the specified port. The switch must be an FC switch inNative mode.Flag: read-onlyType: uint8Config: falseValues: 0 = Encryption is disabled. 1 = Encryption is enabled.Optional: Yes

target-driven-zoning-enableDescription: Enables or disables the Target Driven Zoning (TDZ) configuration on the specifiedport. This change is persistent. Target Driven Zoning can be configured on online or offlineE_Ports, F_Ports, and L_Ports; it does not toggle the port to apply the configuration. After TargetDriven Zoning is configured on a port, it allows the connected target device to configure TargetDriven Peer Zones to be enabled and committed.Flag: read-writeType: uint8Values: 0 = Target Driven Zoning configuration is disabled. 1 = Target Driven Zoningconfiguration is enabled.Optional: Yes

sim-port-enabledDescription: Enables or disables the port as a SIM port. Note that Fibre Channel switch Nativemode must be supported.Flag: read-writeType: uint8Values: 0 = SIM port is disabled. 1 = SIM port is enabled.Optional: Yes

mirror-port-enabledDescription:Enables or disables the port as a mirror port. Port mirroring reroutes data frames between twodevices to the mirror port. This parameter is available only when the port type is not a VE_Port(port-type-string != ve-port).Flag: read-writeType: int8Values: 0 = Mirror port is disabled. 1 = Mirror port is enabled.Optional: Yes


Broadcom


credit-recovery-enabledDescription: Enables or disables credit recovery on the port. Credit recovery enables creditsor frames to be recovered. This parameter is available only when the port type is not a VE_Port(port-type-string != ve-port).Flag: read-writeType: int8Values: 0 = Credit recovery is disabled. 1 = Credit recovery is enabled. Default: 1.Optional: Yes

credit-recovery-activeDescription: Whether credit recover is active on the port. Fabric OS must support credit recoveryat either end of the link for credit recovery to be active. This parameter is available only when theport type is not a VE_Port (port-type-string != ve-port).Flag: read-onlyType: int8Config: falseValues: 0 = Credit recovery is not active on the port. 1 = Credit recovery is active on the port.Optional: Yes

fec-activeDescription: Whether forward error correction (FEC) is active on the port. Fabric OS mustsupport FEC at either end of the link for FEC to be active. This parameter is available only whenthe port type is not a VE_Port (port-type-string != ve-port).Flag: read-onlyType: int8Config: falseValues: 0 = FEC is not active on the port. 1 = FEC is active on the port.Optional: Yes

f-port-buffersDescription: Configures the buffer allocation for an F_Port. The minimum buffer allocation is thedefault number of buffers plus 1. The maximum is determined by the remaining buffer allocationsin the port's port group. If no buffers are configured, the value is zero. The F_Port buffer featureis not supported on ports configured as EX_Ports, mirror ports, long distance ports, L_Ports, QoSports, Fast Write, and trunk areas.Flag: read-writeType: uint8Values: 0 or from 8 to the maximum.Optional: Yes

e-port-creditDescription: Configures the number of credits to be allocated to the specified port. The minimumcredit allocation is 5, and the maximum can be up to 160 depending on the platform.Flag: read-writeType: uint8Values: 0 or from 5 to 160. 0 = E_Port Credit is disabled.Optional: Yes

csctl-mode-enabledDescription: Enables or disables Class-Specific Control (CSCTL) mode which enables trafficprioritization based on CS_CTL. The switch must be an FC switch in Native mode.Flag: read-writeType: int8Values: 0 = CSCTL mode is disabled on the port. 1 = CSCTL mode is enabled on the port.Optional: Yes


Broadcom


fault-delay-enabledDescription: Configures the fault delay for a port. In the event that the link is noisy after a hostpower cycle, the switch may go into a soft fault state, which means a delay of R_A_TOV. Settingthe mode value to 1 reduces the fault delay value to 1.2 seconds. The configuration is stored innonvolatile memory and is persistent across switch reboots and power cycles.Flag: read-writeType: uint8Values: 0 = The value is R_A_TOV. 1 = The value is 1.2 seconds. Default: 0.Optional: Yes

octet-speed-comboDescription: The speed configuration for a port octet. A port octet can be set to any of the threeoctet combinations, and the ports in the octet can run on any speed supported by the port’s octetcombination. This applies to both auto-negotiated and fixed speeds.Flag: read-writeType: int8Values: 1 = Auto-negotiated or fixed port speeds of 32 Gb/s, 16 Gb/s, 8 Gb/s, 4 Gb/s, and 2Gb/s. 2 = Auto-negotiated or fixed port speeds of 10 Gb/s, 8 Gb/s, 4 Gb/s, and 2 Gb/s 3 = Auto-negotiated or fixed port speeds of 16 Gb/s and 10 Gb/s. Default = 1.Optional: Yes

long-distanceDescription: The long-distance level. Note that Fibre Channel switch Native mode must besupported.Flag: read-onlyType: uint8Config: falseValues: Displays one of the following values (the numerical value representing each distancelevel is shown in parentheses): 0 = Long-distance is disabled for this port. 1 = L0 configures theport as a regular port. 2 = L1 configures the value as long (<= 50 km). 3 = L2 configures the valueas super long (<= 100 km). 4 = LE mode configures an E_Port distance as greater than 5 km andup to 10 km. 5 = L0.5 configures the value as medium long (<= 25 km). 6 = LD configures thevalue as automatic long distance. 7 = LS mode configures the value as a static long-distance linkwith a fixed buffer allocation greater than 10 km.Optional: Yes

vc-link-initDescription: The VC link initialization. Note that Fibre Channel switch Native mode must besupported.Flag: read-onlyType: uint8Config: falseValues: 0 = The long-distance link initialization is turned off. 1 = The long-distance linkinitialization is turned on for long-distance mode.Optional: Yes

isl-ready-mode-enabledDescription: Enables or disables ISL ready mode on the port. Note that Fibre Channel switchNative mode must be supported. Note that ISL ready mode is mutually exclusive with E_PortCredit, QoS-enabled mode, and long-distance levels.Flag: read-writeType: uint8Values: 0 = ISL ready mode is disabled on the port. 1 = ISL ready mode is enabled on the port.Optional: Yes


Broadcom


rscn-suppression-enabledDescription: Enables or disables Registered State Change Notification (RSCN) suppression onthe port. Note that Fibre Channel switch Native mode must be supported.When enabled, any device changes on the port do not generate an RSCN to any other enddevice. When disabled, device changes on the port generate an RSCN to all other end devicesthat are zoned with this one. By default, RSCN suppression is disabled on all ports.Flag: read-writeType: uint8Values: 0 = RSCN is disabled on the port. 1 = RSCN is enabled on the port. Default: 0.Optional: Yes

los-tov-mode-enabledDescription: Enables or disables de-bouncing of signal loss for front-end ports for 100 ms.Flag: read-writeType: uint8Values: 0 = LOS_TOV mode is disabled on the port. 1 = LOS_TOV mode is enabled on fixed-speed ports. 2 = LOS_TOV mode is enabled for both fixed-speed and auto-negotiated ports.Optional: Yes

npiv-enabledDescription: Enables or disables NPIV capability on the port.Flag: read-writeType: uint8Values: 0 = NPIV is disabled on the port. 1 = NPIV is enabled on the port.Optional: Yes

npiv-pp-limitDescription: Configures the maximum number of allowed logins for the port.Flag: read-writeType: int16Values: 1 to 255 = The maximum number of allowed logins for the port. Default = 126.Optional: Yes

npiv-flogi-logout-enabledDescription: Whether base device logout is enabled or disabled. Note that this parameter is notapplicable for ports on the core blades of a chassis.Flag: read-onlyType: int8Config: falseValues: 0 = Base device logout is disabled on the port, which causes NPIV devices on the sameport to log out when the base device logs out. 1 = Base device logout is enabled on the port. Thebase device can log out without disrupting the NPIV devices on the same port.Optional: Yes

ex-port-enabledDescription: Configures the port as an EX_Port. Note that Fibre Channel switch Native modemust be supported.Flag: read-writeType: uint8Values: 0 = Does not configure the port as an EX_Port. 1 = Configures the port as an EX_Port.Optional: Yes

edge-fabric-idDescription: The fabric ID. This parameter is applicable only when the EX_Port is enabled (ex-port-enabled = 1).Flag: read-write


Broadcom


Type: fibrechannel:fabric-id-typeValue: 1 to 128.Optional: Yes

preferred-front-domain-idDescription: The preferred domain ID. This parameter is applicable only when the EX_Port isenabled (ex-port-enabled = 1).Flag: read-writeType: fibrechannel:domain-id-typeValue: 1 to 239.Optional: Yes

neighbor-switch-ipv4-addressDescription: The IPv4 address of the switch connected to the EX_Port. For trunked EX_Ports,this IP address is available only on the master port. This parameter is applicable only when theEX_Port is enabled (ex-port-enabled = 1) and the operational status is online/testing (operational-status == 2).Flag: read-onlyType: inet:ipv4-addressConfig: falseValue: An IPv4 address.Optional: Yes

neighbor-switch-ipv6-addressDescription: The IPv6 address of the switch connected to the EX-port. For trunked EX_Ports,this IP address is available only on the master port. This parameter is applicable only when theEX_Port is enabled (ex-port-enabled = 1) and the operational status is online/testing (operational-status == 2).Flag: read-onlyType: inet:ipv6-addressValue: An IPv6 address.Optional: Yes

fec-enabledDescription: Whether forward error correction (FEC) is enabled or disabled on a port. FECprovides a mechanism for reducing error rates during data transmissions over 16Gb/s FibreChannel links. When FEC is enabled on a port, the sender adds a systematically generated error-correcting code (ECC) to its data transmission. This mechanism allows the receiver to detectand correct errors without needing to get additional information from the sender. This parameteris available only when the port type is not a VE_Port (port-type-string != ve-port). Note: FEC issupported only at 10Gb/s and 16Gb/s speeds.Flag: read-writeType: int8Values: 0 = FEC is disabled on the port. 1 = FEC is enabled on the port, and the port is online.Optional: Yes

via-tts-fec-enabledDescription: Whether FEC negotiation via TTS is enabled or disabled on the port. Thisparameter is available only when the port type is not a VE_Port (port-type-string != ve-port).Flag: read-onlyType: int8Config: falseValues: 0 = The external control of FEC is disabled. 1 = The control of the FEC state is permittedvia TTS by an externally attached host or device.Optional: Yes


Broadcom


port-autodisable-enabledDescription: Enables or disables port autodisable on the port, which minimizes traffic disruptionintroduced in some instances of automatic port recovery. When the autodisable flag is enabled,you can specify the conditions that prevent the port to reinitialize. Such conditions include loss ofsync, loss of signal, OLS, NOS, and LIP. Note that a link reset does not cause a port autodisable.When a port is in FICON Management Server (FMS) mode, an autodisabled port remainspersistently disabled across High Availability (HA) failover.Flag: read-writeType: uint8Values: 0 = Port autodisable is disabled on the port. 1 = Port autodisable is enabled on the port.Optional: Yes

rate-limit-enabledDescription: Configures the rate limits in Mb/s. Note that Fibre Channel switch Native modemust be supported. This is applicable only with F/FL_Ports. For E/EX_Ports, this resource is noteffective. The ingress rate limit is enforced only when a given port can run at a speed higher thanthe speed specified in the configuration.


Flag: read-writeType: int16Values: One of the following rates in Mb/s: 0 (no rate limit set), 200, 400, 600, 800, 1000, 1500,2000, 2500, 3000, 3500, 4000, 5000, 7000, 8000, 9000, 10000, 11000, 12000, 13000, 14000,15000, 16000.Optional: Yes

non-dfe-enabledDescription: Enables or disables non-DFE mode on the port. Note that Fibre Channelswitch Native mode must be supported. Active receiver DFE uses sophisticated algorithms toautomatically adjust the receiver to compensate for signal distortions.


Flag: read-writeType: uint8Values: 0 = Non-DFE mode is disabled on the port. Automatic receiver adjustment through DFEis activated. 1 = Non-DFE mode is enabled on the port. If the non-DFE enabled port is connectedto a port that does not require fixed receiver equalization, CRC errors may be detected on theport and the link may toggle. Even if disabled, non-DFE is still automatically activated if both ofthe following conditions are met: the port speed is 8G or N8 and the received fillword is IDLE.Optional: Yes

trunk-port-enabledDescription: Enables or disables trunking on a port. Trunking is enabled by default when atrunking license is present on the switch.Flag: read-writeType: uint8Values: 0 = Trunking is disabled on the port. 1 = Trunking is enabled on the port.Optional: Yes

default-indexDescription: The default port Index of the port. The default port index can be a port swappedarea.Flag: read-write


Broadcom


Type: fibrechannel:user-port-number-typeConfig: falseValues: The default port Index of the port.Optional: Yes

physical-stateDescription: The physical state of a port.Flag: read-onlyType: stringConfig: falseValues: The physical state of a port (online|offline|testing|faulty|e_port|f_port|segmented|unknown|no_port|no_module|laser_flt|no_light|no_sync|in_sync|port_flt|hard_flt|diag_flt|lock_ref|mod_inv|mod_val|no_sigdet).Optional: Yes

pod-license-statusDescription: This parameter is deprecated. Use the pod-license-state parameter instead. ThePOD license status for a port.Flag: read-onlyType: booleanConfig: falseValues: true = The POD license is enabled on the port. false = The POD license is disabled onthe port.Optional: Yes

pod-license-stateDescription: The Ports on Demand (POD) license status of the logical port. The switch must bea non-director FC switch.Flag: read-writeType: enumerationValue: reserved = The port is reserved under a POD license. released = The port is notreserved under a POD license.Optional: Yes

indexDescription: The user port number of the front-end port.Flag: read-onlyType: fibrechannel:user-port-number-typeConfig: falseValue: -1 to 3400.Optional: Yes

reserved-buffersDescription: The maximum number of buffers or reserved buffers if offline. This value increasesor decreases when you configure the f-port-buffers parameter and is effective when the port isonline. If the port is offline, the default value is assigned. The maximum value is derived from thechip-buffers-available parameter. Note that if you set the value too high, the buffers available toother front-end ports on that chip are depleted.This parameter is available only when the port type string is not an FCoE_Port, VE_Port, orEthernet port.Flag: read-onlyType: uint16Config: falseValue: 0 to the maximum number of buffers or reserved buffers if offline.Optional: Yes


Broadcom


average-transmit-buffer-usageDescription: The average number of buffers transmitted per polling period.This parameter is available only when the port type string is not an FCoE_Port,VE_Port, or Ethernet port.Flag: read-onlyType: uint16Config: falseValue: The average number of buffers transmitted per polling period.Optional: Yes

average-transmit-frame-sizeDescription: The average frame size transmitted, including the FC header, in bytes.This parameter is available only when the port type string is not an FCoE_Port,VE_Port, or Ethernet port.Flag: read-onlyType: uint16Config: falseValue: The average frame size transmitted, including the FC header, in bytes.Optional: Yes

average-receive-buffer-usageDescription: The average number of buffers received per polling period.This parameter is available only when the port type string is not an FCoE_Port,VE_Port, or Ethernet port.Flag: read-onlyType: uint16Config: falseValue: The average number of buffers received per polling period.Optional: Yes

average-receive-frame-sizeDescription: The average frame size received, including the FC header, in bytes.This parameter is available only when the port type string is not an FCoE_Port,VE_Port, or Ethernet port.Flag: read-onlyType: uint16Config: falseValue: The average frame size received, including the FC header, in bytes.Optional: Yes

current-buffer-usageDescription: The real-time buffer usage by a front-end port.This parameter is available only when the port type string is not an FCoE_Port,VE_Port, or Ethernet port.Flag: read-onlyType: uint16Config: falseValue: The real-time buffer usage by a front-end port.Optional: Yes

recommended-buffersDescription: The real-time number of buffers needed to utilize the port at full bandwidth. If thisvalue is too low, the port starves for buffers. If this value is too high, buffers are wasted and notavailable to other front-end ports on the same chip.This parameter is available only when the port type string is not an FCoE_Port,VE_Port, or Ethernet port.


Broadcom


Flag: read-onlyType: uint16Config: falseValue: The real-time number of buffers needed to utilize the port at full bandwidth.Optional: Yes

measured-link-distanceDescription: The actual link distance measured in kilometers.This parameter is available only when the port type string is not an FCoE_Port,VE_Port, or Ethernet port.Flag: read-onlyType: stringConfig: falseValue: 1 to 8 kilometers.Optional: Yes

chip-instanceDescription: The chip index on which the given port exists.This parameter is available only when the port type string is not an FCoE_Port,VE_Port, or Ethernet port.Flag: read-onlyType: uint16Config: falseValue: The chip index on which the given port exists.Optional: Yes

chip-buffers-availableDescription: The front-end port on the chip whose available buffer count is being queried.This parameter is available only when the port type string is not an FCoE_Port,VE_Port, or Ethernet port.Flag: read-onlyType: uint16Config: falseValue: 1 to the maximum.Optional: Yes

port-healthDescription: The port health (for example, Offline).Flag: read-onlyType: stringConfig: falseValue: The port health (for example, Offline).Optional: Yes

authentication-protocolDescription: Whether authentication is enabled and the authentication protocol configured on theport.Flag: read-onlyType: stringConfig: falseValue: Whether authentication is enabled and the authentication protocol configured on the port.Optional: Yes

disable-reasonDescription: The reason the port is disabled defined by the system or by the user. For a user-defined reason, the length is limited to 16 characters. Replay of the same value is idempotent.


Broadcom


Only a user-defined reasons can be overwritten via REST. One exception is the special system-defined value of 'None', which can be overwritten by a user-defined reason. Use a PATCHrequest with an empty string to clear the user-defined reason.Flag: read-writeType: stringValue: The reason the port is disabled.Optional: Yes

areasDescription: A list of 16-bit areas associated with a port on a Gen 7 platform or an FCoE_Port.Flag: read-onlyConfig: falseOptional: Noarea

Description: The area of a device.Flag: read-onlyType: fibrechannel:fcid-hex-string-typeValue: The area of a device.Optional: No

le-domainDescription: The LE domain ID for the port. This parameter is available only when the port typeis not a VE_Port (port-type-string != ve-port).Flag: read-onlyType: uint16Value: 1 to 128.Optional: Yes

port-peer-beacon-enabledDescription: Enables or disables port peer beaconing. This parameter is available only when theport type is not a VE_Port (port-type-string != ve-port).Flag: read-writeType: booleanValue: true = Enables port peer beaconing. false = Disables port peer beaconing.Optional: Yes

clean-address-enabledDescription: Enables or disables Clean Address Bit on the specified port. The switch must bea non-director FC switch. This parameter is available only when the port type is not a VE_Port(port-type-string != ve-port).Flag: read-writeType: booleanValue: true = Enables Clean Address Bit support for the specified port. false = Disables CleanAddress Bit support for the specified port.Optional: Yes

congestion-signal-enabledDescription: Enables or disables Congestion Signal support for the specified port. Only availableon Gen7 or later platforms.This parameter is available only when the port type string is not an FCoE_Port, VE_Port, andEthernet port.Flag: read-writeType: booleanValue: true = Enables Congestion Signal support for the specified port. false = DisablesCongestion Signal support for the specified port.


Broadcom


Optional: Yessegmentation-reason

Description: Displays the reason for port segmentation. This parameter is available only whenthe port type is an E_Port, VE_Port, EX_Port, or D_Port.Flag: read-onlyType: stringConfig: falseValue: Displays the reason for port segmentation.Optional: Yes

fibrechannel-statisticsDescription: Statistics for all interfaces on the device. System-controlled interfaces created by thesystem are always present in this list, whether they are configured or not.Flag: read-writeKey: nameThis list has the following leafs:name

Description: The name of the interface.Flag: read-writeType: stringConfig: falseValues: The slot and port number of the port in the format slot/port.Optional: No

sampling-intervalDescription: The sampling interval for statistics.Flag: read-onlyType: uint16Config: falseUnits: secondsValues: 1 through 65536.Optional: Yes

time-generatedDescription: The time at which the statistics were queried.Flag: read-onlyType: fibrechannel:time-generated-typeConfig: falseUnits: secondsValues: standard IETF date-time outputOptional: Yes

reset-statisticsDescription: Resets statistic counters. The only readable value is 0, and the only settable valueis 1. This is a write only parameter.Flag: read-writeType: uint8Config: falseValues: 0 = Do not reset the statistic counters. 1 = Reset the statistic counters.Optional: Yes

in-octetsDescription: The total number of octets received on the interface, including framing characters.Flag: read-onlyType: yang:zero-based-counter64


Broadcom


Config: falseUnits: octet countValues: 0 through 18446744073709551615Optional: Yes

out-octetsDescription: The total number of octets transmitted out of the interface, including framingcharacters.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: octet countValues: 0 through 18446744073709551615Optional: Yes

in-multicast-pktsDescription: The number of packets, delivered by this sublayer to a higher sublayer, that wereaddressed to a multicast address at this sublayer. For a MAC-layer protocol, this includes bothGroup and Functional addresses.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: packet countValues: 0 through 18446744073709551615Optional: Yes

out-multicast-pktsDescription: The total number of packets that higher-level protocols requested be transmittedand that were addressed to a multicast address at this sublayer, including those that werediscarded or not sent. For a MAC-layer protocol, this includes both Group and Functionaladdresses.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: packet countValues: 0 through 18446744073709551615Optional: Yes

in-link-resetsDescription: The number of link resets received.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: instance countValues: 0 through 18446744073709551615Optional: Yes

out-link-resetsDescription: The total number of link resets transmitted.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: instance countValues: 0 through 18446744073709551615Optional: Yes


Broadcom


in-offline-sequencesDescription: The total number of offline sequences received.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: instance countValues: 0 through 18446744073709551615Optional: Yes

out-offline-sequencesDescription: The total number of offline sequences transmitted.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: instance countValues: 0 through 18446744073709551615Optional: Yes

invalid-ordered-setsDescription: The total number of invalid ordered sets received.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: set countValues: 0 through 18446744073709551615Optional: Yes

frames-too-longDescription: The number of frames received that were longer than 2140 octets. The value of2140 is calculated based on an assumption of 24 header bytes plus 4 CRC bytes and 2112 bytesof payload.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: frame countValues: 0 through 18446744073709551615Optional: Yes

truncated-framesDescription: The total number of truncated frames received.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: frame countValues: 0 through 18446744073709551615Optional: Yes

address-errorsDescription: Count of frames received with unknown addressing. An example is an unknownSID or DID, which are not known to the routing algorithm.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: frame countValues: 0 through 18446744073709551615Optional: Yes


Broadcom


delimiter-errorsDescription: Count of invalid frame delimiters that are received at this port. An example would bea frame that has a class 2 at the start and a class 3 at the end.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: instance countValues: 0 through 18446744073709551615Optional: Yes

encoding-disparity-errorsDescription: The total number of disparity errors received at this port.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: error countValues: 0 through 18446744073709551615Optional: Yes

too-many-rdysDescription: The number of instances in which the number of RDYs (readys) exceeded thenumber of frames received.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: instance countValues: 0 through 18446744073709551615Optional: Yes

in-crc-errorsDescription: The number of CRC errors for all frames received.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: error countValues: 0 through 18446744073709551615Optional: Yes

crc-errorsDescription: The number of times that the CRC in a frame does not match the CRC that iscomputed by the receiver. This count is part of the Link Error Status Block (LESB).Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: error countValues: 0 through 18446744073709551615Optional: Yes

bad-eofs-receivedDescription: The number of bad EOF frames received.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: frame countValues: 0 through 18446744073709551615Optional: Yes


Broadcom


encoding-errors-outside-frameDescription: The number of encoding-error or disparity-error outside frames received.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: frame countValues: 0 through 18446744073709551615Optional: Yes

multicast-timeoutsDescription: The number of multicast frames that have timed out.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: frame countValues: 0 through 18446744073709551615Optional: Yes

in-lcsDescription: The number of link control (lcs) frames received.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: frame countValues: 0 through 18446744073709551615Optional: Yes

in-frame-rateDescription: The instantaneous receive frame rate.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: frame countValues: 0 through 18446744073709551615Optional: Yes

out-frame-rateDescription: The instantaneous transmit frame rate.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: frame countValues: 0 through 18446744073709551615Optional: Yes

in-max-frame-rateDescription: The maximum frame receive rate since the last reset.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: frame countValues: 0 through 18446744073709551615Optional: Yes

out-max-frame-rateDescription: The maximum frame transmit rate since the last reset.


Broadcom


Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: frame countValues: 0 through 18446744073709551615Optional: Yes

in-rateDescription: The instantaneous byte receive rate.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: bytesValues: 0 through 18446744073709551615Optional: Yes

out-rateDescription: The instantaneous byte transmit rate.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: bytesValues: 0 through 18446744073709551615Optional: Yes

in-peak-rateDescription: The peak byte receive rate.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: bytesValues: 0 through 18446744073709551615Optional: Yes

out-peak-rateDescription: The peak byte transmit rate.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: bytesValues: 0 through 18446744073709551615Optional: Yes

in-framesDescription: The number of frames received at this port.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: frame countValues: 0 through 18446744073709551615Optional: Yes

out-framesDescription: The number of frames transmitted from this port.Flag: read-onlyType: yang:zero-based-counter64


Broadcom


Config: falseUnits: frame countValues: 0 through 18446744073709551615Optional: Yes

bb-credit-zeroDescription: The number of transitions in and out of the BB credit zero state.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: transition countValues: 0 through 18446744073709551615Optional: Yes

input-buffer-fullDescription: The number of transitions in and out of the Input Buffer Full state.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: transition countValues: 0 through 18446744073709551615Optional: Yes

f-busy-framesDescription: The number of F_BSY (fabric busy) frames generated.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: frame countValues: 0 through 18446744073709551615Optional: Yes

p-busy-framesDescription: The number of P_BSY (port busy) frames generated.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: frame countValues: 0 through 18446744073709551615Optional: Yes

f-rjt-framesDescription: The number of F_RJT (fabric frame reject) frames generated.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: frame countValues: 0 through 18446744073709551615Optional: Yes

p-rjt-framesDescription: The number of P_RJT (port frame reject) frames generated.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: frame count


Broadcom


Values: 0 through 18446744073709551615Optional: Yes

class-1-framesDescription: The number of Class 1 frames received at this port.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: frame countValues: 0 through 18446744073709551615Optional: Yes



class-3-discardsDescription: The number of Class 3 frames discarded by this port.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: frame countValues: 0 through 18446744073709551615Optional: Yes

link-failuresDescription: The number of link failures at this port.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: instance countValues: 0 through 18446744073709551615Optional: Yes

invalid-transmission-wordsDescription: The number of invalid transmission words received at this port.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: word countValues: 0 through 18446744073709551615Optional: Yes


Broadcom


primitive-sequence-protocol-errorDescription: The number of primitive sequence protocol errors detected at this port.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: error countValues: 0 through 18446744073709551615Optional: Yes

loss-of-signalDescription: The number of signal loss instances detected at this port.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: instance countValues: 0 through 18446744073709551615Optional: Yes

loss-of-syncDescription: The number of instances of synchronization loss detected at this port.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: instance countValues: 0 through 18446744073709551615Optional: Yes

class3-in-discardsDescription: The number of class 3 receive frames discarded due to timeout.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: frame countValues: 0 through 18446744073709551615Optional: Yes

class3-out-discardsDescription: The number of class 3 transmit frames discarded due to timeout.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: frame countValues: 0 through 18446744073709551615Optional: Yes

pcs-block-errorsDescription: The number of physical coding sublayer (PCS) block errors. This counter recordsencoding violations on 10-Gb/s or 16-Gb/s ports.Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: error countValues: 0 through 18446744073709551615Optional: Yes


Broadcom


remote-link-failuresDescription: The number of link failures at the remote F-port. This parameter is available onlywhen the port is online (/fibrechannel/operational-status = 2).Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: instance countValues: 0 through 18446744073709551615Optional: Yes

IDescription: The number of invalid transmission words received at the remote F_Port. Thisparameter is available only when the port is online ( /fibrechannel/operational-status = 2).Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: word countValues: 0 through 18446744073709551615Optional: Yes

remote-primitive-sequence-protocol-errorDescription: The number of primitive sequence protocol errors detected at the remote F_Port.This parameter is available only when the port is online (/fibrechannel/operational-status = 2).Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: errors countValues: 0 through 18446744073709551615Optional: Yes

remote-loss-of-signalDescription: The number of instances of signal loss detected at the remote F_Port. Thisparameter is available only when the port is online (/fibrechannel/operational-status = 2).Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: instance countValues: 0 through 18446744073709551615Optional: Yes

remote-loss-of-syncDescription: The number of instances of synchronization loss detected at the remote F_Port.This parameter is available only when the port is online (/fibrechannel/operational-status = 2).Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: instance countValues: 0 through 18446744073709551615Optional: Yes

remote-crc-errorsDescription: The number of frames received with invalid CRC at the remote F_Port. Thisparameter is available only when the port is online (/fibrechannel/operational-status = 2).Flag: read-onlyType: yang:zero-based-counter64Config: false


Broadcom


Units: frame countValues: 0 through 18446744073709551615Optional: Yes

remote-fec-uncorrectedDescription: The number of frames uncorrected by the FEC block at the remote F_Port. Thisparameter is available only when the port is online (/fibrechannel/operational-status = 2).Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: frame countValues: 0 through 18446744073709551615Optional: Yes

remote-buffer-credit-infoDescription: The buffer credit values. Applicable only for the remote F_Port. This parameter isavailable only when the port is online (/fibrechannel/operational-status = 2).Flag: read-onlyType: yang:zero-based-counter64Config: falseThe container has the following leafs:bb-credit

Description: The buffer credit values available to the attached devices. This parameter isavailable only when the port is online (/fibrechannel/operational-status = 2).Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: transition countValues: 0 through 18446744073709551615Optional: Yes

peer-bb-creditDescription: The number of credits available to the switch port. This parameter isavailable only when the port is online (/fibrechannel/operational-status = 2).Flag: read-onlyType: yang:zero-based-counter64Config: falseUnits: transition countValues: 0 through 18446744073709551615Optional: Yes

link-level-interruptsDescription: The number of link level interrupts on the port.Flag: read-onlyType: yang:zero-based-counter64Config: falseValue: The number of link level interrupts on the port.Optional: Yes

frames-processing-requiredDescription: The number of frames which required processing on the port.Flag: read-onlyType: yang:zero-based-counter64Config: falseValue: The number of frames which required processing on the port.


Broadcom


Optional: Yesframes-timed-out

Description: The number of frames which timed out during transmit on the port.Flag: read-onlyType: yang:zero-based-counter64Config: falseValue: The number of frames which timed out during transmit on the port.Optional: Yes

frames-transmitter-unavailable-errorsDescription: The number of frames returned by an unavailable transmitter.Flag: read-onlyType: yang:zero-based-counter64Config: falseValue: The number of frames returned by an unavailable transmitter.Optional: Yes

logical-e-portDescription: A list of logical E_Port interfaces on the device which form the logical inter switch link(LISL). The switch must support Extended ISL (XISL) and Virtual Fabrics mode must be enabled.Flag: read-onlyKey: port-indexOptional: Noport-index

Description: The unique port number on the switch for identifying a logical E_Port.Flag: read-onlyType: fibrechannel:user-port-number-typeValue: The unique port number on the switch for identifying a logical E_Port.Optional: No

fabric-idDescription: The virtual fabric identification (VFID) of the logical switch in which the logicalE_Port is created.Flag: read-onlyType: fibrechannel:fabric-id-typeValue: The virtual fabric identification (VFID) of the logical switch in which the logical E_Port iscreated.Optional: No

operational-statusDescription: The operational status of the the logical E_Port.Flag: read-onlyType: enumerationValue: online = The logical E_Port is online. offline = The logical E_Port is offline.Optional: No

offline-reasonDescription: The reason for logical E_Port Offline status.Flag: read-onlyType: enumerationValue: Init = The logical E_Port is initializing. CreateRequestSent = Request to create a logicalE_Port is sent to the peer switch. CreatReqRtryPendg = Retry pending to send create requestto peer switch. PeerLSDown = Peer switch is disabled or offline. CreateFailed = Logical E_Portcreation failed. PeerReqInProcess = Request from peer switch to create logical E_Port in


Broadcom


process. PeerReqReceived = Request from peer switch to create logical E_Port received.DeleteSent = Delete logical E_Port sent to peer switch. Invalid = Logical E_Port in Invalid state.Optional: No

neighbor-node-wwnDescription: The neighbor node WWN logically connected to this port.Flag: read-onlyType: fibrechannel:wwn-typeValue: The neighbor node WWN logically connected to this port.Optional: Yes

associated-physical-portsDescription: A list of associated physical E_Ports.Flag: read-onlyOptional: NoThis list has the following leaf:port

Description: The physical port number of the base switch associated with the logicalE_Port.Flag: read-onlyType: fibrechannel:slot-port-name-typeValue: The physical port number of the base switch associated with the logical E_Port.Optional: Yes

Supported Methods

Only the GET, HEAD, OPTIONS, and PATCH operations are supported in this module.

Examples

Comparable Fabric OS CLI commands include portStatsShow and portErrorShow . Refer to the Brocade Fabric OSCommand Reference for information and examples of these commands.

Retrieving a List of Fibre Channel ResourcesThis example uses a GET request to retrieve a list of all Fibre Channel resources in the fabric.StructureGET <base_URI>/running/brocade-interface/fibrechannelURIGET https://10.10.10.10/rest/running/brocade-interface/fibrechannel

Request BodyNo request body is required.Response BodyWhen the operation is successful, the response has a message body similar to the following, and a “200 OK”status appears in the header.<?xml version="1.0"?>

<Response>

<fibrechannel>

<name>7/0</name>

<wwn>20:20:c2:f2:2c:2a:ac:2c</wwn>

<port-type>7</port-type>

<port-type-string>e-port</port-type-string>


Broadcom


<speed>16000000000</speed>

<max-speed>32000000000</max-speed>

<user-friendly-name>slot7 port0</user-friendly-name>




<auto-negotiate>1</auto-negotiate>

<isl-ready-mode-enabled>0</isl-ready-mode-enabled>

<long-distance>0</long-distance>

<trunk-port-enabled>1</trunk-port-enabled>

<vc-link-init>0</vc-link-init>

<measured-link-distance>lt 2</measured-link-distance>

<pod-license-status>true</pod-license-status>

<index>128</index>

<default-index>128</default-index>

<fcid>2850816</fcid>

<fcid-hex>0x2b8000</fcid-hex>

<physical-state>online</physical-state>

<persistent-disable>0</persistent-disable>

<e-port-disable>0</e-port-disable>

<ex-port-enabled>0</ex-port-enabled>

<npiv-enabled>1</npiv-enabled>

<npiv-pp-limit>126</npiv-pp-limit>

<qos-enabled>1</qos-enabled>

<csctl-mode-enabled>0</csctl-mode-enabled>

<port-autodisable-enabled>0</port-autodisable-enabled>

<e-port-credit>0</e-port-credit>

<d-port-enable>0</d-port-enable>

<octet-speed-combo>1</octet-speed-combo>

<encryption-enabled>0</encryption-enabled>

<compression-configured>0</compression-configured>

<compression-active>0</compression-active>

<encryption-active>0</encryption-active>

<mirror-port-enabled>0</mirror-port-enabled>

<fec-enabled>1</fec-enabled>

<fec-active>1</fec-active>

<via-tts-fec-enabled>0</via-tts-fec-enabled>

<port-health>healthy</port-health>

<authentication-protocol>none</authentication-protocol>

<port-peer-beacon-enabled>false</port-peer-beacon-enabled>

<neighbor>

<wwn>20:2d:00:22:f2:22:f2:22</wwn>

</neighbor>

<neighbor-node-wwn>10:00:00:22:f2:22:f2:81</neighbor-node-wwn>

<neighbor-port-index>93</neighbor-port-index>

<neighbor-switch-user-friendly-name>66-92_B6520</neighbor-switch-user-friendly-name>

<le-domain>0</le-domain>

<target-driven-zoning-enable>0</target-driven-zoning-enable>

<npiv-flogi-logout-enabled>0</npiv-flogi-logout-enabled>

<sim-port-enabled>0</sim-port-enabled>

<f-port-buffers>0</f-port-buffers>

<clean-address-enabled>false</clean-address-enabled>

<reserved-buffers>20</reserved-buffers>


Broadcom


<average-transmit-buffer-usage>0</average-transmit-buffer-usage>

<average-transmit-frame-size>0</average-transmit-frame-size>

<average-receive-buffer-usage>0</average-receive-buffer-usage>

<average-receive-frame-size>0</average-receive-frame-size>

<current-buffer-usage>34</current-buffer-usage>

<recommended-buffers>34</recommended-buffers>

<chip-instance>0</chip-instance>

<chip-buffers-available>7572</chip-buffers-available>

<fault-delay-enabled>0</fault-delay-enabled>

<credit-recovery-enabled>1</credit-recovery-enabled>

<credit-recovery-active>1</credit-recovery-active>

<rscn-suppression-enabled>0</rscn-suppression-enabled>

<los-tov-mode-enabled>0</los-tov-mode-enabled>

<segmentation-reason/>

</fibrechannel>

...

<fibrechannel>

<name>6/31</name>

<wwn>2c:2f:22:c2:aa:ce:22:1f</wwn>


<port-type-string>universal-port</port-type-string>

<speed>32000000000</speed>











<measured-link-distance>-</measured-link-distance>


<index>799</index>



<fcid-hex>0x2b3f00</fcid-hex>

<physical-state>no_module</physical-state>
















Broadcom




<port-health>offline</port-health>



<neighbor/>

<neighbor-switch-user-friendly-name/>




















</fibrechannel>

</Response>

Getting Details on a Single Fibre Channel PortThis example uses a GET request to get the details of a single Fibre Channel port; in this example, port 7/1.StructureGET <base_URI>/running/brocade-interface/fibrechannel/name/fibre-channel-interface-nameURINotice that the slash character in the name resource is encoded as “%2f”.GET https://10.10.10.10/rest/running/brocade-interface/fibrechannel/name/7%2f1


<Response>

<fibrechannel>

<name>7/1</name>

<wwn>20:81:c4:f5:7c:4a:ac:6c</wwn>


<port-type-string>e-port</port-type-string>

<speed>16000000000</speed>


Broadcom












<measured-link-distance>lt 2</measured-link-distance>


<index>129</index>



<fcid-hex>0x2b8100</fcid-hex>

<physical-state>online</physical-state>





<npiv-pp-limit>126</npiv-pp-limit>


<csctl-mode-enabled>0</csctl-mode-enabled>




<octet-speed-combo>1</octet-speed-combo>









<port-health>healthy</port-health>



<neighbor>

<wwn>20:5c:00:27:f8:66:f3:81</wwn>

</neighbor>

<neighbor-node-wwn>10:00:00:27:f8:66:f3:81</neighbor-node-wwn>

<neighbor-port-index>92</neighbor-port-index>

<neighbor-switch-user-friendly-name>66-92_B6520_Odin</neighbor-switch-user-friendly-name>



<npiv-flogi-logout-enabled>0</npiv-flogi-logout-enabled>







Broadcom














<segmentation-reason/>

</fibrechannel>

</Response>

Getting Details on a Single Fibre Channel Port AttributeThis example uses a GET request to determine if trunking is enabled on a port; in this example, port 3/4.

NOTEYou can get details for any port attribute in the fibrechannel-interface container.

StructureGET <base_URI>/running/brocade-interface/fibrechannel/name/fibre-channel-interface-name/trunk-port-enabledURINotice that the slash character in the name resource is encoded as “%2f”.GET https://10.10.10.10/rest/running/brocade-interface/fibrechannel/name/3%2f4/trunk-port-enabled

Request BodyNo request body is required.Response BodyWhen the operation is successful, the response has a message body similar to the following, and a “200 OK”status appears in the header.


<Response>

<fibrechannel>

<name>3/4</name>


</fibrechannel>

</Response>

Configuring a Single Fibre Channel Port AttributeThis example uses a PATCH request to disable trunking on a port; in this example, port 3/4.

NOTEYou can configure any read-write port attribute in the fibrechannel container.

StructurePATCH <base_URI>/running/brocade-interface/fibrechannel/name/fibre-channel-interface-name/trunk-port-enabled/0


Broadcom


URINotice that the slash character in the name resource is encoded as “%2f”.PATCH https://10.10.10.10/rest/running/brocade-interface/fibrechannel/name/3%2f4/trunk-port-

enabled/0

Request BodyNo request body is required.Response BodyWhen the operation is successful, the response has an empty response body, and a “204 No Content” statusappears in the header.Setting the User-Friendly Name for a Fibre Channel InterfaceThis example uses a PATCH request to set the user-friendly name for Fibre Channel interface 10/2.StructurePATCH <base_URI>/running/brocade-interface/fibrechannel/name/fibre-channel-interface-name/user-friendly-name/user-friendly-nameURINotice that the slash character in the name resource is encoded as “%2f”.PATCH https://10.10.10.10/rest/running/brocade-interface/fibrechannel/name/10%2f2/user-friendly-

name/Port_ten-two

Request BodyNo request body is required.Response BodyWhen the operation is successful, the response has an empty message body and a “204 No Content” statusappears in the header.Setting a Fibre Channel Interface StateThis example uses a PATCH request to disable Fibre Channel interface 10/2.StructurePATCH <base_URI>/running/brocade-interface/fibrechannel/name/<fc_interface_name>/is-enabled-state/enabled-state/falseURINotice that the slash character in the name resource is encoded as “%2f”.

PATCH https://10.10.10.10/rest/running/brocade-interface/fibrechannel/name/10%2f2/is-enabled-state/

false

Request BodyNo request body is required.Response BodyWhen the operation is successful, the response has an empty message body and a “204 No Content” statusappears in the header.Getting Trunk Settings for a Physical PortThis example uses a GET request to get the trunk details of a physical port; in this example, port 0/88.


Broadcom


StructureGET <base_URI>/running/brocade-interface/fibrechannel/name/fibre-channel-interface-name/trunk-enabledURINotice that the slash character in the name resource is encoded as “%2f”.GET https://10.10.10.10/rest/running/brocade-interface/fibrechannel/name/0%2f88/trunk-enabled


<Response>

<fibrechannel>

<name>0/88</name>


</fibrechannel>

</Response>

Retrieving a List of Logical E_Ports

This example uses a GET request to retrieve a list of logical E_Ports from logical switch 128..

Structure

GET base_URI/running/brocade-interface/logical-e-port

URI

GET https://10.10.10.10/rest/running/brocade-interface/logical-e-port

Request Body


Response Body

{

"Response": {

"logical-e-port": [

{

"name": 64,

"fabric-id": 128,

"operational-status": 2,

"associated-physical-ports": {

"port": [

"42",

"1"

]

}

}

]


Broadcom


}

}

History



Fabric OS 8.2.0a This API call was modified to add new parameters to the brocade-interface/fibrechannelcontainer.

Fabric OS 8.2.1 This API call was modified to add new parameters to the brocade-interface/fibrechannel-statistics container.

Fabric OS 9.0.0 This API call was modified to add new parameters to the brocade-interface/fiberchanneland fibrechannel-statistics containers as well as add a the new logical-e-port container.

Fabric OS 9.0.1 This API call was modified to add new parameters to the brocade-interface/fiberchannel.


Broadcom


brocade-licenseThis module provides a detailed view of the licenses installed on the switch.

Module tree

This is the tree view of the module from the brocade-license.yang-tree.txt file. See YANG Module Overview for YANGnode field definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-license

+--ro brocade-license

+--ro license* [name]

| +--ro name string

| +--ro features

| | +--ro feature* string

| +--ro capacity? uint32

| +--ro consumed? uint32

| +--ro configured-blade-slots

| | +--ro configured-blade-slot* uint32

| +--ro expiration-date? string

| +--ro generation-date? string

| +--ro active-firmware-version? fru:firmware-version-type

| +--ro target-firmware-version? fru:firmware-version-type

| +--ro license-format? enumeration

+--ro end-user-license-agreement

| +--ro text? string

+--ro ports-on-demand-license-info

+--ro sfp-port-count? fibrechannel:port-number-type

+--ro qsfp-port-count? fibrechannel:port-number-type

+--ro sfp-dd-count? fibrechannel:port-number-type

+--ro port-on-demand-license? boolean

+--ro qflex-port-on-demand-license? boolean

+--ro sfp-dd-port-on-demand-license? boolean

+--ro provisioned-sfp-port-count? fibrechannel:port-number-type

+--ro sfp-port-base-switch-allowance-count? fibrechannel:port-number-type

+--ro sfp-port-license-allowance-count? fibrechannel:port-number-type

+--ro sfp-port-assigned-count? fibrechannel:port-number-type

+--ro sfp-port-base-switch-assigned-count? fibrechannel:port-number-type

+--ro licensed-sfp-port-count? fibrechannel:port-number-type

+--ro sfp-port-license-reservation-available-count? fibrechannel:port-number-type

+--ro sfp-port-base-switch-members

| +--ro port* fibrechannel:port-number-type

+--ro licensed-sfp-port-members


+--ro unassigned-sfp-port-members


+--ro licensed-offline-sfp-port-members


+--ro provisioned-qsfp-port-count? fibrechannel:port-number-type

+--ro qsfp-base-switch-allowance-count? fibrechannel:port-number-type

+--ro qsfp-license-allowance-count? fibrechannel:port-number-type

+--ro qsfp-port-assigned-count? fibrechannel:port-number-type

+--ro qsfp-port-base-switch-assigned-count? fibrechannel:port-number-type


Broadcom


+--ro licensed-qsfp-port-count? fibrechannel:port-number-type

+--ro qsfp-port-license-reservation-available-count? fibrechannel:port-number-type

+--ro qsfp-port-base-switch-members


+--ro licensed-qsfp-port-members


+--ro unassigned-qsfp-port-members


+--ro licensed-offline-qsfp-port-members


+--ro provisioned-sfp-dd-port-count? fibrechannel:port-number-type

+--ro sfp-dd-base-switch-allowance-count? fibrechannel:port-number-type

+--ro sfp-dd-license-allowance-count? fibrechannel:port-number-type

+--ro sfp-dd-port-assigned-count? fibrechannel:port-number-type

+--ro sfp-dd-port-base-switch-assigned-count? fibrechannel:port-number-type

+--ro licensed-sfp-dd-port-count? fibrechannel:port-number-type

+--ro sfp-dd-port-license-reservation-available-count? fibrechannel:port-number-type

+--ro sfp-dd-port-base-switch-members


+--ro licensed-sfp-dd-port-members


+--ro unassigned-sfp-dd-port-members


+--ro licensed-offline-sfp-dd-port-members

+--ro port* fibrechannel:port-number-type

URI format


• <base_URI>/running/brocade-license/license followed by the leafs as listed in the module tree.

• <base_URI>/running/brocade-license/end-user-license-agreement to display the Brocade End UserLicense Agreement.

• <base_URI>/running/brocade-license/ports-on-demand-license-info to display the port licenseassignments.

Parametersbrocade-license

Description: The container for licenses installed on the switch.Flag: read-onlyConfig: falseThis container has the following leafs:license

Description: A list of licenses installed on the switch.Flag: read-onlyKey: nameThis list has the following leafs:


Broadcom


nameDescription: The license key or serial number for one or more features installed on the switch.Flag: read-onlyType: stringValue: The license key or serial number.Optional: Yes

featuresDescription: A list of features that are integrated in a single license.Flag: read-onlyThis container has the following leaf:feature

Description: The name of the feature.Flag: read-onlyType: stringValue: The name of the feature.Optional: Yes

capacityDescription: The capacity for the license installed on the switch. Note that this parameter is validonly for a capacity-based license.Flag: read-onlyType: uint32Value: The capacity for the license installed on the switch.Optional: Yes

consumedDescription: The number of slots configured to use the license installed on the switch. Note thatthis parameter is valid only for a capacity-based license.Flag: read-onlyType: uint32Value: The number of slots consumed.Optional: Yes

configured-blade-slotsDescription: A list of slot numbers of the configured blade slots for the license installed on theswitch.Flag: read-onlyThis container has the following leaf:configured-blade-slot

Description: The configured blade slot details.Flag: read-onlyType: uint32Value: The configured blade slot details.Optional: Yes

expiration-dateDescription: The expiration date for the license installed on the switch.Flag: read-onlyType: stringValue: The expiration date for the license in MM/DD/YYYY format.Optional: Yes


Broadcom


generation-dateDescription: The generation date for the license installed on the switch. This parameter displaysonly for a time-based license.Flag: read-onlyType: stringValue: The generation date for the license in MM/DD/YYYY format.Optional: Yes

active-firmware-versionDescription: A human readable string identifying the running firmware version of the switch.Flag: read-onlyType: fru:firmware-version-typeValue: The running firmware version of the switch.Optional: Yes

target-firmware-versionDescription: A human readable string identifying the target firmware version of the switch.Flag: read-onlyType: fru:firmware-version-typeValue: The target firmware version of the switch.Optional: Yes

license-formatDescription: Whether the specified license is certificate- or key-based.Flag: read-onlyType: enumerationValue: certificate-based-license: The license is a certificate-based license. key-based-license:The license is a key-based license.Optional: Yes

end-user-license-agreementDescription: The detailed view of the End User License Agreement (EULA).Flag: read-onlyConfig: falseOptional: NoThis container has the following leafs:text

Description: The contents of the accepted Broacade EULA.Flag: read-onlyType: stringValues: The contents of the accepted Broacade EULA.Optional: No

ports-on-demand-license-infoDescription: The Ports on Demand information for the license reservations on the switch.Flag: read-onlyConfig: falseOptional: NoThis container/list has the following leafs:sfp-port-count

Description: The total count of SFP ports available on the switch.Flag: read-onlyType: fibrechannel:port-number-typeValues: The total count of SFP ports available on the switch.Optional: No


Broadcom


qsfp-port-countDescription: The total count of QSFP ports available on the switch.Flag: read-onlyType: fibrechannel:port-number-typeValues: The total count of QSFP ports available on the switch.Optional: No

sfp-dd-countDescription: The total count of SFP Double Density (dd) ports available on the switch.Flag: read-onlyType: fibrechannel:port-number-typeConfig: falseValues: The total count of SFP Double Density (dd) ports available on the switch.Optional: No

port-on-demand-licenseDescription: Whether the Ports on Demand license is installed.Flag: read-onlyType: booleanValues: true = The Ports on Demand license is installed. false = The Ports on Demand license isnot installed.Optional: No

qflex-port-on-demand-licenseDescription: Whether the Q-Flex Ports on Demand license is installed.Flag: read-onlyType: booleanValues: true = The Q-Flex Ports on Demand license is installed. false = The Q-Flex Ports onDemand license is not installed.Optional: No

sfp-dd-port-on-demand-licenseDescription: Whether the SFP Double Density (dd) Ports on Demand license is installed.Flag: read-onlyType: booleanValues: true = The SFP-DD Ports on Demand license installed. false = The SFP-DD Ports onDemand license is not installed.Optional: No

provisioned-sfp-port-count?Description: The total number of SFP based ports provisioned for use in the switch.Flag: read-onlyType: fibrechannel:port-number-typeValues: The total number of SFP based ports provisioned for use in the switch.Optional: No

sfp-port-base-switch-allowance-countDescription: The number of SFP port assignments provisioned by base switch allowance.Flag: read-onlyType: fibrechannel:port-number-typeValues: The number of SFP port assignments provisioned by base switch allowance.Optional: No

sfp-port-license-allowance-countDescription: The maximum number of SFP-based port assignments provisioned by the Ports onDemand license.Flag: read-only


Broadcom


Type: fibrechannel:port-number-typeValues: The maximum number of SFP-based port assignments provisioned by the Ports onDemand license.Optional: No

sfp-port-assigned-countDescription: The total number of SFP-based ports assigned to the base switch allowance orinstalled licenses.Flag: read-onlyType: fibrechannel:port-number-typeValues: The total number of SFP-based ports assigned to the base switch allowance or installedlicenses.Optional: No

sfp-port-base-switch-assigned-countDescription: The number of SFP-based ports assigned to the base switch allowance.Flag: read-onlyType: fibrechannel:port-number-typeValues: The number of SFP-based ports assigned to the base switch allowance.Optional: No

licensed-sfp-port-countDescription: The number of SFP-based ports assigned to the Ports on Demand license.Flag: read-onlyType: fibrechannel:port-number-typeValues: The number of SFP-based ports assigned to the Ports on Demand license.Optional: No

sfp-port-license-reservation-available-countDescription: The number of license reservations available for use by unassigned SFP ports.Flag: read-onlyType: fibrechannel:port-number-typeValues: The number of license reservations available for use by unassigned SFP ports.Optional: No

sfp-port-base-switch-membersDescription: A list of SFP-based ports assigned to the base switch allowance.Flag: read-onlyOptional: NoThis container has the following leaf:port

Description: The SFP-based port assigned to the base switch allowance.Flag: read-onlyType: fibrechannel:port-number-typeConfig: falseValues: The SFP-based port assigned to the base switch allowance.Optional: No

licensed-sfp-port-membersDescription: A list of SFP-based ports assigned to the Ports on Demand license.Flag: read-onlyOptional: NoThis container has the following leaf:port

Description: The SFP-based port assigned to the Ports on Demand license.


Broadcom


Flag: read-onlyType: fibrechannel:port-number-typeValues: The SFP-based port assigned to the Ports on Demand license.Optional: No

unassigned-sfp-port-membersDescription: A list of SFP-based ports that are not assigned to the base switch or Ports onDemand license.Flag: read-onlyOptional: NoThis container has the following leaf:port

Description: The SFP-based port that is not assigned to the base switch or Ports onDemand license.Flag: read-onlyType: fibrechannel:port-number-typeValues: The SFP-based port that is not assigned to the base switch or Ports on Demandlicense.Optional: No

licensed-offline-sfp-port-membersDescription: A list of licensed SFP-based ports that are offline.Flag: read-onlyOptional: NoThis container has the following leaf:port

Description: The licensed SFP-based port that is offline.Flag: read-onlyType: fibrechannel:port-number-typeValues: The licensed SFP-based port that is offline.Optional: No

provisioned-qsfp-port-countDescription: The total number of QSFP-based ports provisioned for use in the switch.Flag: read-onlyType: fibrechannel:port-number-typeValues: The total number of QSFP-based ports provisioned for use in the switch.Optional: No

qsfp-base-switch-allowance-countDescription: The QSFP-based port assignments provisioned by base switch allowance.Flag: read-onlyType: fibrechannel:port-number-typeValues: The QSFP-based port assignments provisioned by base switch allowance.Optional: No

qsfp-license-allowance-countDescription: The maximum number of QSFP-based port assignments provisioned by the Portson Demand license.Flag: read-onlyType: fibrechannel:port-number-typeValues: The maximum number of QSFP-based port assignments provisioned by the Ports onDemand license.Optional: No


Broadcom


qsfp-port-assigned-countDescription: The total number of QSFP-based ports assigned to base switch allowance orinstalled licenses.Flag: read-onlyType: fibrechannel:port-number-typeValues: The total number of QSFP-based ports assigned to base switch allowance or installedlicenses.Optional: No

qsfp-port-base-switch-assigned-countDescription: The number of QSFP-based ports that are assigned to base switch allowance.Flag: read-onlyType: fibrechannel:port-number-typeValues: The number of QSFP-based ports that are assigned to base switch allowance.Optional: No

licensed-qsfp-port-countDescription: The number of QSFP-based ports that is assigned to the Ports on Demand license.Flag: read-onlyType: fibrechannel:port-number-typeValues: The number of QSFP-based ports that is assigned to the Ports on Demand license.Optional: No

qsfp-port-license-reservation-available-countDescription: The number of license reservations available for use by unassigned QSFP-basedports.Flag: read-onlyType: fibrechannel:port-number-typeValues: The number of license reservations available for use by unassigned QSFP-based ports.Optional: No

qsfp-port-base-switch-membersDescription: A list of QSFP-based ports that are assigned to the base switch allowance.Flag: read-onlyOptional: NoThis container has the following leaf:port

Description: The QSFP-based port that is assigned to the base switch allowance.Flag: read-onlyType: fibrechannel:port-number-typeValues: The QSFP-based port that is assigned to the base switch allowance.Optional: No

licensed-qsfp-port-membersDescription: A list of QSFP-based ports that are assigned to the Ports on Demand license.Flag: read-onlyOptional: NoThis container has the following leaf:port

Description: The QSFP-based port that is assigned to the Ports on Demand license.Flag: read-onlyType: fibrechannel:port-number-typeValues: The QSFP-based port that is assigned to the Ports on Demand license.Optional: No


Broadcom


unassigned-qsfp-port-membersDescription: A list of QSFP-based ports that are not assigned to base switch or Ports onDemand license.Flag: read-onlyOptional: NoThis container has the following leaf:port

Description: The QSFP-based port member that is not assigned to base switch or Portson Demand license.Flag: read-onlyType: fibrechannel:port-number-typeValues: The QSFP-based port member that is not assigned to base switch or Ports onDemand license.Optional: No

licensed-offline-qsfp-port-membersDescription: A list of licensed QSFP-based ports that are offline.Flag: read-onlyOptional: NoThis container has the following leaf:port

Description: The licensed QSFP-based port that is offline.Flag: read-onlyType: fibrechannel:port-number-typeValues: The licensed QSFP-based port that is offline.Optional: No

provisioned-sfp-dd-port-countDescription: The total number of SFP-DD-based ports provisioned for use in the switch.Flag: read-onlyType: fibrechannel:port-number-typeValues: The total number of SFP-DD-based ports provisioned for use in the switch.Optional: No

sfp-dd-base-switch-allowance-countDescription: The SFP-DD-based port assignments provisioned by the base switch allowance.Flag: read-onlyType: fibrechannel:port-number-typeValues: The SFP-DD-based port assignments provisioned by the base switch allowance.Optional: No

sfp-dd-license-allowance-countDescription: The maximum number of SFP-DD-based port assignments provisioned by the Portson Demand license.Flag: read-onlyType: fibrechannel:port-number-typeValues: The maximum number of SFP-DD-based port assignments provisioned by the Ports onDemand license.Optional: No

sfp-dd-port-assigned-countDescription: The total number of SFP-DD-based ports assigned to the base switch allowance orinstalled licenses.Flag: read-onlyType: fibrechannel:port-number-type


Broadcom


Values: The total number of SFP-DD-based ports assigned to the base switch allowance orinstalled licenses.Optional: No

sfp-dd-port-base-switch-assigned-countDescription: The number of SFP-DD-based ports assigned to the base switch allowance.Flag: read-onlyType: fibrechannel:port-number-typeValues: The number of SFP-DD-based ports assigned to the base switch allowance.Optional: No

licensed-sfp-dd-port-countDescription: The number of SFP-DD-based ports assigned to the Ports on Demand license.Flag: read-onlyType: fibrechannel:port-number-typeValues: The number of SFP-DD-based ports assigned to the Ports on Demand license.Optional: No

sfp-dd-port-license-reservation-available-countDescription: The number of license reservations available for use by unassigned SFP-DD-basedports.Flag: read-onlyType: fibrechannel:port-number-typeValues: The number of license reservations available for use by unassigned SFP-DD-basedports.Optional: No

sfp-dd-port-base-switch-membersDescription: A list of SFP-DD-based ports that are assigned to the base switch allowance.Flag: read-onlyOptional: NoThis container has the following leaf:port

Description: The SFP-DD-based port member that is assigned to the base switchallowance.Flag: read-onlyType: fibrechannel:port-number-typeValues: The SFP-DD-based port member that is assigned to the base switch allowance.Optional: No

licensed-sfp-dd-port-membersDescription: A list of SFP-DD-based ports that are assigned to the Ports on Demand license.Flag: read-onlyOptional: NoThis container has the following leaf:port

Description: The SFP-DD-based port member that is assigned to the Ports on Demandlicense.Flag: read-onlyType: fibrechannel:port-number-typeValues: The SFP-DD-based port member that is assigned to the Ports on Demandlicense.Optional: No


Broadcom


unassigned-sfp-dd-port-membersDescription: A list of SFP-DD-based ports that are not assigned to the base switch or Ports onDemand license.Flag: read-onlyOptional: NoThis container has the following leaf:port

Description: The SFP-DD-based port member that are not assigned to the base switchor Ports on Demand license.Flag: read-onlyType: fibrechannel:port-number-typeValues: The SFP-DD-based port member that are not assigned to the base switch orPorts on Demand license.Optional: No

licensed-offline-sfp-dd-port-membersDescription: A list of licensed SFP-DD-based ports that are offline.Flag: read-onlyOptional: NoThis container has the following leaf:port

Description: The licensed SFP-DD-based port that is offline.Flag: read-onlyType: fibrechannel:port-number-typeValues: The licensed SFP-DD-based port that is offline.Optional: No

Supported methods

Only the GET, HEAD, OPTIONS operation is supported in this module.

Examples

Viewing the License Data

The following example uses the GET request to display a detailed view of the licenses installed on the switch.

Structure

GET <base_URI>/running/brocade-license/license

URI

GET https://10.10.10.10/rest/running/brocade-license/license

Request Body


Response Body


<Response>

<license>

<name>QYRKQTWJNfCZHCf3NNfBgJLWYWCDrrLSB7BZN</name>

<features>


Broadcom


<feature>Extended Fabric</feature>

<feature>Trunking</feature>

<feature>FICON_CUP</feature>

<feature>Fabric Vision and IO Insight</feature>

</features>

<license-format>key-based-license</license-format>

</license>

<license>

<name>rCTRGSBSB9BBPZEtAYB4g7ZTZ3C974PQANXNCZFABHDB</name>

<features>

<feature>Q-Flex Ports on Demand</feature>

</features>

<capacity>32</capacity>


</license>

<license>

<name>AgP4QaZ3J7LNSKRDTfrg9GgLQD3A4DSfLHYf4THAfaAA</name>

<features>

<feature>Ports on Demand</feature>

</features>



</license>

<license>

<name>PPRgJXLGGXDQ9DHNrRK9HTCGS7HSAHDtMWSD4SGAZKFA</name>

<features>

<feature>Integrated Routing Ports on Demand</feature>

</features>



</license>

</Response>

Viewing the Brocade End User License Agreement

This example uses a GET request to display the Brocade End User License Agreement.

Structure

GET base_URI/running/brocade-license/end-user-license-agreement

URI

GET https://10.10.10.10/rest/running/brocade-license/end-user-license-agreement

Request Body


Response Body


<Response>

<end-user-license-agreement>

<text>*************************************************************************

* BROCADE FABRIC OPERATING SYSTEM AND FEATURE LICENSES AND LICENSE KEYS *


Broadcom


*************************************************************************

END USER LICENSE AGREEMENT

==========================

THIS END USER LICENSE AGREEMENT ("Agreement") GOVERNS THE DOWNLOAD, INSTALLATION,

USE, POSTING, DISTRIBUTING AND OTHERWISE MAKING AVAILABLE OF BROCADE'S FABRIC

OPERATING SYSTEM ("FOS") SOFTWARE AND/ OR USE OF BROCADE FEATURE LICENSES AND

LICENSE KEYS THAT ACTIVATE FOS OR FUNCTIONALITY WITHIN FOS, AND ACCOMPANYING

DOCUMENTATION (collectively the "Software"). BY DOWNLOADING, INSTALLING, USING,

POSTING, DISTRIBUTING OR OTHERWISE MAKING AVAILABLE THE SOFTWARE, OR BY

PURCHASING, CONVERTING A TRANSACTION KEY INTO A LICENSE KEY, OR INSTALLING A

LICENSE OR LICENSE KEY, YOU ARE AGREEING TO BE BOUND ON AN ONGOING BASIS BY THE

TERMS AND CONDITIONS HEREIN, WHICH MAY BE UPDATED BY BROCADE FROM TIME TO TIME.

IF AT ANY TIME YOU DO NOT AGREE TO ALL OF THE TERMS OF THIS AGREEMENT, PROMPTLY

STOP USE OF THE SOFTWARE AND DESTROY ALL COPIES OF THE SOFTWARE IN YOUR

POSSESSION OR CONTROL, AND CERTIFY IN WRITING TO BROCADE SUCH CESSATION OF USE

AND DESTRUCTION.

Single User License

===================

Subject to the terms and conditions of this Agreement and payment of the applicable

license fees, Brocade Communications Systems LLC ("Brocade") and its suppliers grant

to you ("End User") a non-exclusive, non-transferable, non-assignable, non-sub licensable

license to use the Software in object code form (in the case of FOS) solely for the

purpose of operating Brocade storage area networking switches in accordance with the

section entitled "Restrictions" below. End User may make such backup copies of the

Software as may be necessary for End User's lawful use, provided End User affixes to

such copies all trademark, copyright, patent, and notices of other proprietary rights

that appear on the original.

FOS Licenses and License Keys

=============================

FOS Licenses are used to activate FOS features or functionality in Brocade switches.

FOS Licenses shall only be purchased from a Brocade authorized distributor or official

OEM partner, and FOS License Keys shall only be obtained through Brocade's License Portal

or an authorized OEM License Portal and shall only be used on Brocade switches purchased

through authorized channels. FOS License Keys obtained from any other sources are not

permitted to be used on any Brocade hardware products. FOS Licenses and License Keys

shall not be resold, assigned, sub-licensed or otherwise transferred to a third party.

Open Source Software

====================

Certain components of the Software may incorporate "open source" software. Open source

software is subject to the applicable open source license (e.g., the GNU General Public

License) and is not subject to this Agreement. To obtain a copy of the source code and

applicable licensing terms for the open source software used by Brocade, please download

the open source disclosure documents in the Broadcom Customer Support Portal (CSP). If

you do not have a CSP account or are unable to login, please contact your support

provider for this information.

Restrictions


Broadcom


============

FOS is designed for use with Brocade hardware products sold through authorized sales

channels, and with hardware platforms that are currently supported by Brocade. End User

acknowledges that use of the Software on hardware products that do not meet the above

criteria, or which is inconsistent with the restrictions below, presents risks to the

security and quality of Products and to the Software, for which Brocade disclaims all

liability. Except as otherwise expressly provided in this Agreement or expressly

authorized by Brocade, End User shall have no right, and End User specifically agrees

not to, and not to permit third parties to: (i) modify, adapt, or create derivative

works based upon the Software; (ii) copy, in whole or in part, decompile, translate,

reverse engineer, disassemble or otherwise reduce the Software to humanreadable form;

(iii) install the Software on any products other than Brocade storage area networking

switches purchased by End User through authorized channels for its own use or for

resale expressly authorized by Brocade; (iv) install or use the Software on products

in excess of the maximum number of Brocade storage area networking switches for which

End User is licensed; (v) install the Software on any Brocade storage area networking

switches that have reached End of Support as defined by Brocade, or refurbished devices,

except with Brocade's prior written consent, (vi) use the Software on any devices not

designated by Brocade for use with the Software (as notified through software release

notes and other notices), (vii) download, or make available for use or download, any

versions of the Software that have reached End of Support, as declared by Brocade, or

(viii) sub-license or permit third parties to post or otherwise make available, or

use the Software to provide support for Brocade products unless expressly authorized

by Brocade.

Upgrades and Additional Copies

==============================

For purposes of this Agreement, "Software" shall also include any upgrades, updates,

bug fixes or modified versions ("Upgrades") provided to End User by Brocade or an

authorized distributor and for which End User had paid the applicable license fees,

and any backup copies of the Software. Notwithstanding the foregoing, End User

acknowledges and agrees that Brocade and its resellers and distributors shall have

no obligation to provide any Upgrades. If Upgrades or additional copies of the

Software are provided, End User acknowledges and agrees that it has no license or

right to use such additional copies or Upgrades unless End User, at the time of

acquiring such copy or Upgrade, already holds a valid license to the original

Software for the applicable number of copies.

No Support

==========

Brocade may, but is not required to, provide technical support for the Software.

Security Notice

===============

Software may include security features that End User can use, along with other security

tools, to implement increased security in End User's storage area network ("SAN").

However, use of the security features of the Software does not guarantee the security

of End User's SAN or overall network. There are numerous factors that affect the security

of a SAN, including, without limitation, correct installation and setup of the security

features of Software and all related requirements, correctly configured security

policies, selection of hardware and software (including network security tools),

correct installation, configuration, and maintenance of the hardware and software,

the interoperability of the various components of End User's SAN and End User's network,


Broadcom


and a physically and electronically secure operating environment. In addition, Software

may utilize digital certificates in connection with its access control features.

Although digital certificates are a useful authentication security measure that improves

overall security, they do not guarantee authenticity or security. In designing the

security of End User's SAN, it is End User's responsibility to evaluate all of these

factors to ensure End User's SAN meets End User's security requirements. End User's

experience may vary based on these and other factors. End User's use of Software,

including the digital certificates, is subject to and governed by the terms of this

Agreement and to End User's compliance with the policies and procedures for the use

of the security features of Software and digital certificates, which may be made

available to End User by Brocade from time to time. If Brocade becomes aware of a breach

of the security of its digital certificate infrastructure, Brocade reserves the right

to re-issue digital certificates. In that event, End User will be required to submit

new certificate signing requests and install reissued certificates across End User's

SAN. End User should plan for any network disruption that this may cause. END USER

ACKNOWLEDGES THAT END USER HAS ACCESS TO SUFFICIENT INFORMATION TO ENSURE THAT END USER

CAN MAKE AN INFORMED DECISION AS TO THE EXTENT TO WHICH END USER CHOOSES TO RELY ON

DIGITAL CERTIFICATES AND OTHER SECURITY FEATURES IN SOFTWARE ("SECURITY").

Disclaimer of Warranty

======================

TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, BROCADE PROVIDES THE SOFTWARE

"AS IS" WITHOUT WARRANTY OF ANY KIND. BROCADE DOES NOT WARRANT THAT THE SOFTWARE

IS ERROR FREE OR THAT END USER WILL BE ABLE TO OPERATE THE SOFTWARE WITHOUT

PROBLEMS OR INTERRUPTIONS. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,

BROCADE AND ITS LICENSORS, SUPPLIERS, DISTRIBUTORS AND RESELLERS DISCLAIM ALL

EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS, AND WARRANTIES INCLUDING, WITHOUT

LIMITATION, ANY IMPLIED WARRANTY OR CONDITION OF MERCHANTABILITY, FITNESS FOR A

PARTICULAR PURPOSE, NONINFRINGEMENT, AND SATISFACTORY QUALITY OR ARISING FROM A

COURSE OF DEALING, USAGE, OR TRADE PRACTICE.

Limitation of Liability

=======================

IN NO EVENT WILL BROCADE OR ITS LICENSORS, SUPPLIERS, RESELLERS OR DISTRIBUTORS

BE LIABLE FOR ANY LOST REVENUE, PROFIT, OR DATA, OR FOR SPECIAL, INDIRECT,

CONSEQUENTIAL, INCIDENTAL, OR PUNITIVE DAMAGES HOWEVER CAUSED AND REGARDLESS

OF THE THEORY OF LIABILITY ARISING OUT OF THE USE OF OR INABILITY TO USE THE

SOFTWARE EVEN IF BROCADE OR ITS LICENSORS, SUPPLIERS, RESELLERS OR DISTRIBUTORS

HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. IN NO EVENT SHALL BROCADE'S

OR ITS LICENSORS', SUPPLIERS', RESELLERS' OR DISTRIBUTORS' TOTAL LIABILITY TO

END USER, WHETHER IN CONTRACT, TORT (INCLUDING NEGLIGENCE), OR OTHERWISE, EXCEED

THE PRICE PAID BY END USER. THE FOREGOING LIMITATIONS SHALL APPLY EVEN IF THE

ABOVE-STATED WARRANTY FAILS OF ITS ESSENTIAL PURPOSE. BECAUSE SOME STATES OR

JURISDICTIONS DO NOT ALLOW LIMITATION OR EXCLUSION OF CONSEQUENTIAL OR INCIDENTAL

DAMAGES, THE ABOVE LIMITATION MAY NOT APPLY TO END USER.

Proprietary Rights

==================

The Software, including all intellectual property rights therein, is and will

remain the sole and exclusive property of Brocade or its licensors.

Term and Termination

====================


Broadcom


This Agreement is effective until terminated. End User's license rights under this

Agreement will terminate immediately without notice from Brocade if End User fails

to comply with any provision of this Agreement. Upon termination, End User must stop

using the Software and destroy all copies of Software and the corresponding license

keys in its possession or control.

Compliance with Law

===================

Each party agrees to comply with all applicable laws, rules and regulations in

connection with its activities under this Agreement. Without limiting the foregoing,

End User acknowledges and agrees that the Software, including technical data, is

subject to United States export control laws, including the United States Export

Administration Act and its associated regulations, and may be subject to export or

import regulations in other countries. End User agrees to comply strictly with all

such regulations and acknowledges that End User has the responsibility to obtain

licenses to export, re-export, or import the Software.

Restricted Rights

=================

The Software under this Agreement is commercial computer software as that term is

described in 48 C.F.R. 252.227-7014(a)(1). If acquired by or on behalf of a civilian

agency, the U.S. Government acquires this commercial computer software and/or

commercial computer software documentation subject to the terms of this Agreement

as specified in 48 C.F.R. 12.212 (Computer Software) and 12.211 (Technical Data)

of the Federal Acquisition Regulations ("FAR") and its successors. If acquired by

or on behalf of any agency within the Department of Defense ("DOD"), the

U.S. Government acquires this commercial computer software and/or commercial computer

software documentation subject to the terms of this Agreement as specified in

48 C.F.R. 227.7202-3 of the DOD FAR Supplement ("DFAR") and its successors.

General

=======

This Agreement will bind and inure to the benefit of each party's successors and

assigns, provided that End User may not assign or transfer this Agreement, in whole

or in part, without Brocade's written consent. This Agreement shall be governed by

and construed in accordance with the laws of the State of California,

United States of America, as if performed wholly within the state and without giving

effect to the principles of conflict of law. No failure of either party to exercise

or enforce any of its rights under this Agreement will act as a waiver of such

rights. If any portion hereof is found to be void or unenforceable, the remaining

provisions of this Agreement shall remain in full force and effect. This Agreement

is the complete and exclusive agreement between the parties with respect to the

subject matter hereof, superseding and replacing any and all prior agreements,

communications, and understandings (both written and oral) regarding such subject

matter.

Effective October 1, 2019

</text>

</end-user-license-agreement>

</Response>


Broadcom


Viewing the Port License Assignments

This example uses a GET request to display the port license assignments..

Structure

GET base_URI/running/brocade-license/ports-on-demand-license-info

URI

GET https://10.10.10.10/rest/running/brocade-license/ports-on-demand-license-info

Request Body


Response Body


<Response>

<ports-on-demand-license-info>

<sfp-port-count>96</sfp-port-count>

<qsfp-port-count>32</qsfp-port-count>

<sfp-dd-count>0</sfp-dd-count>

<port-on-demand-license>true</port-on-demand-license>

<qflex-port-on-demand-license>true</qflex-port-on-demand-license>

<sfp-dd-port-on-demand-license>false</sfp-dd-port-on-demand-license>

<provisioned-sfp-port-count>96</provisioned-sfp-port-count>

<sfp-port-base-switch-allowance-count>48</sfp-port-base-switch-allowance-count>

<sfp-port-license-allowance-count>48</sfp-port-license-allowance-count>

<sfp-port-assigned-count>96</sfp-port-assigned-count>

<sfp-port-base-switch-assigned-count>48</sfp-port-base-switch-assigned-count>

<licensed-sfp-port-count>48</licensed-sfp-port-count>

<sfp-port-license-reservation-available-count>0</sfp-port-license-reservation-available-count>

<sfp-port-base-switch-members>

<sfp-port-base-switch-members>0</sfp-port-base-switch-members>




...




</sfp-port-base-switch-members>

<licensed-sfp-port-members>

<licensed-sfp-port-members>10</licensed-sfp-port-members>



...





</licensed-sfp-port-members>

<unassigned-sfp-port-members/>

<licensed-offline-sfp-port-members>


Broadcom


<licensed-offline-sfp-port-members>0</licensed-offline-sfp-port-members>



...




</licensed-offline-sfp-port-members>

<provisioned-qsfp-port-count>32</provisioned-qsfp-port-count>

<qsfp-base-switch-allowance-count>0</qsfp-base-switch-allowance-count>

<qsfp-license-allowance-count>32</qsfp-license-allowance-count>

<qsfp-port-assigned-count>32</qsfp-port-assigned-count>

<qsfp-port-base-switch-assigned-count>0</qsfp-port-base-switch-assigned-count>

<licensed-qsfp-port-count>32</licensed-qsfp-port-count>

<qsfp-port-license-reservation-available-count>0</qsfp-port-license-reservation-available-count>

<qsfp-port-base-switch-members/>

<licensed-qsfp-port-members>

<licensed-qsfp-port-members>96</licensed-qsfp-port-members>



...




</licensed-qsfp-port-members>

<unassigned-qsfp-port-members/>

<licensed-offline-qsfp-port-members>

<licensed-offline-qsfp-port-members>96</licensed-offline-qsfp-port-members>



...




</licensed-offline-qsfp-port-members>

<provisioned-sfp-dd-port-count>0</provisioned-sfp-dd-port-count>

<sfp-dd-base-switch-allowance-count>0</sfp-dd-base-switch-allowance-count>

<sfp-dd-license-allowance-count>0</sfp-dd-license-allowance-count>

<sfp-dd-port-assigned-count>0</sfp-dd-port-assigned-count>

<sfp-dd-port-base-switch-assigned-count>0</sfp-dd-port-base-switch-assigned-count>

<licensed-sfp-dd-port-count>0</licensed-sfp-dd-port-count>

<sfp-dd-port-license-reservation-available-count>0</sfp-dd-port-license-reservation-available-count>

<sfp-dd-port-base-switch-members/>

<licensed-sfp-dd-port-members/>

<unassigned-sfp-dd-port-members/>

<licensed-offline-sfp-dd-port-members/>

</ports-on-demand-license-info>

</Response>


Broadcom


History


Fabric OS 8.2.1b This API call was introduced.

Fabric OS 9.0.0 This API was modified to add the active-firmware-version and target-firmware-versionparameter, and added the end-user-license-agreement and ports-on-demand-license-infocontainers.

Fabric OS 9.0.0a This API was modified to add the license-format parameter.


Broadcom


brocade-lldpThis module enables you to configure and monitor LLDP.

Module Tree

This is the tree view of the module from the brocade-lldp.yang-tree.txt file. See YANG Module Overview for YANG nodefield definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-lldp

+--rw brocade-lldp

+--rw lldp-global {fibrechannel:fibrechannel_chassis_platform or


| +--rw multiplier? uint32

| +--rw tx-interval? uint32

| +--rw system-name? string

| +--rw system-description? string

| +--rw enabled-state? boolean

| +--ro mandatory-tlvs

| | +--ro tlv* lldp-mandatory-tlv-name-type

| +--rw optional-tlvs

| +--rw tlv* lldp-optional-tlv-name-type

+--rw lldp-profile* [name] {fibrechannel:fibrechannel_chassis_platform or


| +--rw name string

| +--rw multiplier? int32

| +--rw tx-interval? int32

| +--rw enabled-tlvs

| +--rw tlv* lldp-optional-tlv-name-type

+--ro lldp-neighbor* [slot-port] {fibrechannel:fibrechannel_chassis_platform or


| +--ro slot-port fibrechannel:slot-port-name-type

| +--ro dead-interval? uint32

| +--ro remaining-life? uint32

| +--ro remote-interface-name? string

| +--ro chassis-id? string

| +--ro system-name? string

+--ro lldp-statistics* [slot-port] {fibrechannel:fibrechannel_chassis_platform or


+--ro slot-port fibrechannel:slot-port-name-type

+--ro out-frames? ietf:zero-based-counter64

+--ro in-frames? ietf:zero-based-counter64

+--ro frames-aged-out? ietf:zero-based-counter64

+--ro frames-discarded? ietf:zero-based-counter64

+--ro error-frames? ietf:zero-based-counter64

+--ro tlv-discarded? ietf:zero-based-counter64

+--ro tlv-unrecognized? ietf:zero-based-counter64

URI Format



Broadcom


• <base_URI>running/brocade-lldp/lldp-global to configure global LLDP parameters.• <base_URI>running/brocade-lldp/lldp-profile/name/[name] to configure an LLDP profile.• <base_URI>running/brocade-lldp/lldp-neighbor/slot-port/[slot-port] to monitor an LLDP

neighbor.• <base_URI>running/brocade-lldp/lldp-statistics/slot-port/[slot-port] to view LLDP statistics.

Parametersbrocade-lldp

Description: The Link Level Discovery Protocol (LLDP) top-level container. This container contains LLDPconfiguration, operational state, and statistics.Flag: read-writeOptional: NoThis container has the following leafs:lldp-global

Description: The LLDP switch level configuration and operational parameters. The switch must be an FCdirector or Extension switch in Native mode.Flag: read-writeOptional: NoThis list has the following leafs:multiplier

Description: The LLDP timeout multiplier value.Flag: read-writeType: uint32Value: 2 to 10. The default is 4.Optional: No

tx-intervalDescription: The LLDP transmit interval of the switch.Flag: read-writeType: uint32Value: 4 to 180 seconds. The default is 30 seconds.Optional: No

system-nameDescription: The LLDP system name of the switch.Flag: read-writeType: stringValue: The LLDP system name (1 to 31 characters) of the switch.Optional: No

system-descriptionDescription: The LLDP system description of the switch.Flag: read-writeType: stringValue: The LLDP system description (up to 255 characters) of the switch.Optional: No

enabled-stateDescription: Enables or disables the LLDP protocol state on the switch.Flag: read-writeType: booleanValue: true : LLDP is enabled on the switch. false : LLDP is disabled on the switch. The defaultis true.


Broadcom


Optional: Nomandatory-tlvs

Description: The mandatory LLDP TLVs supported by the switch.Flag: read-onlyConfig: falseOptional: NoThis list has the following leaf:tlv

Description: A list of mandatory LLDP TLVs (chassis-id, port-id,and time-to-live). Themandatory LLDP TLVs cannot be modified.Flag: read-onlyType: lldp-mandatory-tlv-name-typeValue:chassis-id = The chassis ID TLV. port-id = The port ID TLV. time-to-live = The time-to-live TLV.Optional: No

optional-tlvsDescription:Flag: read-writeOptional: NoThis list has the following leaf:tlv

Description: A list of optional TLVs enabled on the switch.The dcbx, fcoe-app, fcoe-lls,sys-name, and port-desc TLVs are enabled by default; however, you can disable themas needed. You should enable the dcbx TLV before you enable the fcoe-app and fcoe-llsTLVs.Flag: read-writeType: lldp-optional-tlv-name-typeValue:dcbx = The IEEE Data Center Bridging eXchange TLV. fcoe-app = The IEEE DCBxFCoE Application TLV. fcoe-lls = The IEEE DCBx FCoE Logical Link TLV. dot1 = TheIEEE 802.1 Organizationally Specific TLV. dot3 = IEEE 802.3 Organizationally SpecificTLV. mgmt-addr = The Management Address TLV. port-desc = The Port-DescriptionTLV. sys-cap = The System Capabilities TLV.sys-desc = The System Description TLV.sys-name = The System Name TLV.Optional: No

lldp-profileDescription: The LLDP profile. The switch must be an FC director or Extension switch in Native mode.Flag: read-writeKey: nameOptional: NoThis list has the following leafs:name

Description: The LLDP profile name.Flag: read-writeType: stringValue: The LLDP profile name.Optional: No

multiplierDescription: The LLDP timeout multiplier of the LLDP profile.


Broadcom


Flag: read-writeType: int32Value: -1 or 2 to 10. The -1 multiplier value indicates that it is derived from the LLDP globalmultiplier value.Optional: No

tx-intervalDescription: The transmit interval, in seconds, of the LLDP profile.Flag: read-writeType: int32Value: -1 or 4 to 180. The -1 transmit interval value indicates that it is derived from the LLDPglobal transmit interval value.Optional: No

enabled-tlvsDescription: The enabled TLVs for the LLDP profile.Flag: read-writeOptional: NoThis list has the following leaf:tlv

Description: A list of enabled TLVs for the LLDP profile. If this list is empty, the tlvs arederived from the LLDP global optional tlvs.Flag: read-writeType: lldp-optional-tlv-name-typeValue:dcbx = The IEEE Data Center Bridging eXchange TLV. fcoe-app = The IEEE DCBxFCoE Application TLV. fcoe-lls = The IEEE DCBx FCoE Logical Link TLV. dot1 = TheIEEE 802.1 Organizationally Specific TLV. dot3 = IEEE 802.3 Organizationally SpecificTLV. mgmt-addr = The Management Address TLV. port-desc = The Port-DescriptionTLV. sys-cap = The System Capabilities TLV. sys-desc = The System Description TLV.sys-name = The System Name TLV.Optional: No

lldp-neighborDescription: A list of LLDP neighbor devices connected to the switch. The switch must be anFC director or Extension switch in Native mode.Flag: read-onlyKey: slot-portConfig: falseOptional: NoThis list has the following leafs:slot-port

Description: The slot and port number on which you want to monitor the LLDP neighbor details.Flag: read-onlyType: fibrechannel:slot-port-name-typeValue: The slot and port number of the specified port in the format slot/port.Optional: No

dead-intervalDescription: The dead interval of the the LLDP neighbor.Flag: read-onlyType: uint32Value: 0 to maximum.Optional: No


Broadcom


remaining-lifeDescription: The remaining life of the LLDP neighbor.Flag: read-onlyType: uint32Value: 0 to maximum.Optional: No

remote-interface-nameDescription: The remote interface name of the LLDP neighbor device connected to local switchethernet interface.Flag: read-onlyType: stringValue: The remote interface name of the LLDP neighbor device connected to local switchethernet interface.Optional: No

chassis-idDescription: The chassis ID of the LLDP neighbor.Flag: read-onlyType: stringValue: The chassis ID of the LLDP neighbor.Optional: No

system-nameDescription: The system name of the LLDP neighbor.Flag: read-onlyType: stringValue: The system name of the LLDP neighbor.Optional: No

lldp-statisticsDescription: The LLDP protocol specific transmit, receive, and error statistics of the ports. The switchmust be an FC director or Extension switch in Native mode.Flag: read-onlyKey: slot-portConfig: falseOptional: NoThis list has the following leafs:slot-port

Description: The slot and port number on which you want to view the LLDP-related statistics.Flag: read-onlyType: fibrechannel:slot-port-name-typeValue: The slot and port number of the specified port in the format slot/port.Optional: No

out-framesDescription: The number of LLDP out frames.Flag: read-onlyType: ietf:zero-based-counter64Value: The number of LLDP out frames.Optional: No

in-framesDescription: The number of LLDP in frames.Flag: read-onlyType: ietf:zero-based-counter64


Broadcom


Value: The number of LLDP in frames.Optional: No

frames-aged-outDescription: The number of LLDP aged out frames.Flag: read-onlyType: ietf:zero-based-counter64Value: The number of LLDP aged out frames.Optional: No

frames-discardedDescription: The number of LLDP discarded frames.Flag: read-onlyType: ietf:zero-based-counter64Value: The number of LLDP discarded frames.Optional: No

error-framesDescription: The number of LLDP error frames.Flag: read-onlyType: ietf:zero-based-counter64Value: The number of LLDP error frames.Optional: No

tlv-discardedDescription: The number of discarded LLDP TLVs.Flag: read-onlyType: ietf:zero-based-counter64Value: The number of discarded LLDP TLVs.Optional: No

tlv-unrecognizedDescription: The number of unrecognized LLDP TLVs.Flag: read-onlyType: ietf:zero-based-counter64Value: The number of unrecognized LLDP TLVs.Optional: No

Supported Methods


Examples

This section provides a basic example for using the brocade-lldp module.

Viewing Global LLDP Information for a Switch

This example uses a GET request to view the LLDP global information for the switch.

Structure

GET base_URI/running/brocade-lldp/lldp-global

URI

GET https://10.10.10.10/rest/running/brocade-lldp/lldp-global

Request Body


Broadcom


There is no request body.

Response Body



<Response>

<lldp-global>

<multiplier>4</multiplier>

<tx-interval>30</tx-interval>

<system-name>Switch_Test</system-name>

<system-description>Brocade_X7_4_Fabric_OS_Version_9_0_0</system-description>

<enabled-state>true</enabled-state>

<mandatory-tlvs>

<tlv>chassis-id</tlv>

<tlv>port-id</tlv>

<tlv>time-to-live</tlv>

</mandatory-tlvs>

<optional-tlvs>

<tlv>port-desc</tlv>

<tlv>sys-name</tlv>

<tlv>dcbx</tlv>

<tlv>fcoe-app</tlv>

<tlv>fcoe-lls</tlv>

</optional-tlvs>

</lldp-global>

</Response>

Configuring an LLDP Profile

This example uses a POST request to create an LLDP profile.

Structure

POST base_URI/running/brocade-lldp/lldp-profile/name/[name]

URI

POST https://10.10.10.10/rest/running/brocade-lldp/lldp-profile/name/test_profile

Request Body


Response Body

When the operation is successful, the response has an empty message body and a “201 Created” status message.

Monitoring an LLDP Neighbor

This example uses a GET request to monitor the LLDP neighbor details for a specified port.

Structure

GET base_URIrunning/brocade-lldp/lldp-neighbor/slot-port/<slot%port>

URI


Broadcom


GET https://10.10.10.10/rest/running/brocade-lldp/lldp-neighbor/slot-port/8%2f2

Request Body


Response Body


<Response>

<lldp-neighbor>


<dead-interval>120</dead-interval>

<remaining-life>102</remaining-life>

<remote-interface-name>ge2</remote-interface-name>

<chassis-id>c4f5.7cdc.c0fa</chassis-id>

<system-name>B7840_073_017</system-name>

</lldp-neighbor>

</Response>

Viewing LLDP Statistics

This example uses a GET request to view the LLDP statistics for a specified port.

Structure

GET base_URIrunning/brocade-lldp/lldp-statistics/slot-port/<slot%port>

URI

GET https://10.10.10.10/rest/running/brocade-lldp/lldp-statistics/slot-port/4%2f1

Request Body


Response Body



<Response>

<lldp-statistics>


<out-frames>0</out-frames>

<frames-aged-out>0</frames-aged-out>

<frames-discarded>0</frames-discarded>

<error-frames>0</error-frames>

<in-frames>0</in-frames>

<tlv-discarded>0</tlv-discarded>

<tlv-unrecognized>0</tlv-unrecognized>

</lldp-statistics>

</Response>


Broadcom


History




Broadcom


brocade-loggingThis module provides a detailed view of audit and RASlog message configuration.

Module Tree

This is the tree view of the module from the brocade-logging.yang-tree.txt file. See YANG Module Overview for YANGnode field definitions and possible values, and see Supported Data Types for data type descriptions.module: brocade-logging

+--rw brocade-logging

+--rw audit

| +--rw audit-enabled? boolean

| +--rw severity-level? brocade-logging-types:severity-level-type

| +--rw filter-class-list

| +--rw filter-class* brocade-logging-types:class-type

+--rw syslog-server* [server]

| +--rw server inet:host

| +--rw port? inet:port-number

| +--rw secure-mode? boolean

+--rw raslog* [message-id]

| +--rw message-id brocade-logging-types:message-id-type

| +--rw message-enabled? boolean

| +--ro message-flooded? boolean

| +--rw syslog-enabled? boolean

| +--ro message-text? brocade-logging-types:ascii-text-type

| +--rw current-severity? union

| +--ro default-severity? brocade-logging-types:severity-level-type

+--rw raslog-module* [module-id]

| +--rw module-id brocade-logging-types:module-id-type

| +--rw log-enabled? boolean

+--rw log-quiet-control* [log-type]

| +--rw log-type string

| +--rw quiet-enabled boolean

| +--rw start-time? brocade-logging-types:time-24hr-type

| +--rw end-time? brocade-logging-types:time-24hr-type

| +--rw days-of-week

| +--rw day* string

+--rw log-setting

| +--rw syslog-facility-level? string

| +--rw keep-alive-period? uint16

| +--rw clear-log? enumeration

+--rw supportftp

| +--rw host? union

| +--rw user-name? string

| +--rw password? brocade-security-type:base64-string-type

| +--rw remote-directory? string

| +--rw auto-enabled? boolean

| +--rw protocol? brocade-security-type:sec-crypto-cfg-file-transfer-protocol-type

| +--rw port? uint32

| +--rw connectivity-check-interval? uint32

+--ro audit-log* []

| +--ro sequence-number? uint32



Broadcom


| +--ro message-id? brocade-logging-types:message-id-type

| +--ro switch-user-friendly-name? string

| +--ro message-text? string

| +--ro severity-level? brocade-logging-types:severity-level-type

| +--ro event-class? brocade-logging-types:event-class-type

| +--ro ip-address? union

| +--ro user-name? union

| +--ro role? brocade-security-type:user-config-role-type

| +--ro interface? fibrechannel-yang-types:interface-type

| +--ro application-name? string

| +--ro fabric-id? uint32

+--ro error-log* []

+--ro sequence-number? uint32

+--ro time-stamp? yang:date-and-time

+--ro message-id? brocade-logging-types:message-id-type

+--ro fabric-id? uint32

+--ro slot-id? uint32

+--ro severity-level? brocade-logging-types:severity-level-type

+--ro ffdc-generated-event? boolean

+--ro switch-user-friendly-name? string

+--ro message-text? string

URI format


• <base_URI>/running/brocade-logging/audit followed by the leafs as listed in the module tree to display theaudit log configuration or to configure audit logging.

• <base_URI>/running/brocade-logging/syslog-server followed by the leafs as listed in the module tree todisplay the current syslog server or to configure a syslog server .

• <base_URI>/running/brocade-logging/raslog followed by the leafs as listed in the module tree to displayall external RASlog messages, their status (enabled or disabled), their configured severity and their default severity orconfigure RASlog messages.

• <base_URI>/running/brocade-logging/raslog-module followed by the leafs as listed in the module tree todisplay a list of all Fabric OS RASlog modules or enable or disable a RASlog module group.

• <base_URI>/running/brocade-logging/log-quiet-control followed by the leafs as listed in the module treeto display the quiet time configuration details for audit and RASlog message types or to configure quiet time.

• <base_URI>/running/brocade-logging/log-setting followed by the leafs as listed in the module tree todisplay the syslog facility level and keep alive period or to configure log settings.

• <base_URI>/running/brocade-logging/supportftp followed by the leafs as listed in the module tree todisplay or configure the server to transfer debug logs.

• <base_URI>/running/brocade-logging/audit-log followed by the leafs as listed in the module tree to displaythe audit logs.

• <base_URI>/running/brocade-logging/error-log followed by the leafs as listed in the module tree to displaythe error logs.

Parametersbrocade-logging

Description: The top-level container for all logging related configuration parameters.


Broadcom


Flag: read-writeThis container has the following leafs:audit

Description: The audit logging configuration parameters. You can configure certain filter classes, to setseverity levels for audit messages, and enable or disable audit filters. Depending on the configuration,certain classes are logged to syslog for auditing. Note that syslog configuration is required for loggingaudit messages.Flag: read-writeThis container has the following leafs:audit-enabled

Description: Enables or disables the audit filters. Note that this does not change the log classand log severity configuration.Flag: read-writeType: booleanValue: true = The audit filter is enabled. false = The audit filter is disabled.

severity-levelDescription: The severity level of the log messages you want to display. You can set thisparameter to display log messages of the specified severity level and higher. You cannot entermultiple severity levels.Flag: read-writeType: brocade-logging-types:severity-level-typeValue: info = Displays log messages of info level and higher. warning = Displays log messagesof warning level and higher. error = Displays log messages of error level and higher. critical =Displays log messages of critical level and higher.

filter-class-listDescription: A list of class types needed for audit configuration.Flag: read-writeThis container has the following leaf:filter-class

Description: The filters to be configured for audit classes. You can set more than oneaudit class, separated by a comma.Flag: read-writeType: brocade-logging-types:class-typeValue: zone = Displays the zone audit class. security = Displays the security audit class.configuration = Displays the configuration audit class. firmware = Displays the firmwareaudit class. fabric = Displays the fabric audit class. ls = Displays the ls audit class. cli =Displays the cli audit class. maps = Displays the maps audit class.

syslog-serverDescription: The remote syslog server. You can configure a switch to forward all error log entries toa remote syslog server. Brocade devices use the syslog daemon, a process available on most UNIXsystems that reads and forwards system messages to the appropriate log files or users, depending on thesystem configuration.Flag: read-writeKey: serverThis list has the following leafs:server

Description: The IPv4 or IPv6 address or DNS name of the server.Flag: read-writeType: inet:hostValue: A valid IPv4 or IPv6 address or DNS name of the server.


Broadcom


Optional: Noport

Description: The target syslog server's TCP/IP port number. The port can only be specified (non-default) when secure mode is enabled on the server (secure-mode=true).Flag: read-writeType: inet:port-numberValue: A valid TCP/IP port number. 514 = The default port number for non-secure mode. 6514 =The default port number for secure mode.Optional: Yes

secure-modeDescription: Whether secure syslog mode to send the error log messages securely using theTLS protocol to the syslog server is enabled.Flag: read-writeType: booleanValue: true = Secure mode is enabled. false = Secure mode is disabled. The default is disabled(false).Optional: Yes

raslogDescription: A list of RASlog messages’ configurable parameters, such as enabling message logging,the message ID, the current severity level, transferring to the syslog server is enabled. This list alsoincludes read-only leafs, such as the default severity, the message text, and the flooded flag.Flag: read-writeKey: message-idThis list has the following leafs:message-id

Description: The unique identifier for each RASlog message.Flag: read-writeType: brocade-logging-types:message-id-typeValue: The unique identifier for the RASlog message.

message-enabledDescription: Whether message logging is enabled for RASlog messages identified by messageID.Flag: read-writeType: booleanValue: true = Message logging is enabled. false = Message logging is disabled.

message-floodedDescription: Whether the RASlog message is blocked due to flooding.Flag: read-onlyType: booleanValue: true = The message is blocked due to flooding. false = The message is not blocked dueto flooding.

syslog-enabledDescription: Whether internal RASlog messages to be sent to syslog is enabled. This parameteris only supported for internal RASlog messages. Internal RASlog messages have an ID numberequal to or greater than 5000.Flag: read-writeType: booleanValue: true = Syslog is enabled. false = Syslog is disabled.


Broadcom


message-textDescription: The message text corresponding to the internal RASlog message. This parameteris only supported for internal RASlog messages. Internal RASlog messages have an ID numberequal to or greater than 5000.Flag: read-onlyType: brocade-logging-types:ascii-text-typeValue: The message text corresponding to the internal RASlog message.Config: false

current-severityDescription: The current severity level of the RASlog. The default severity level sets severityto a pre-defined level of logging for the RASlog associated with the corresponding message ID.However, you can configure a different severity with this parameter.Flag: read-writeType: union (brocade-logging-types:severity-level-type and string)Value: Valid values are info, warning, error, critical, and default.

default-severityDescription: The pre-defined default severity level of the RASlog.Flag: read-onlyType: brocade-logging-types:severity-level-typeValue: Values displayed are info, warning, error, and critical.Config: false

raslog-moduleDescription: A list of Fabric OS modules (identified by module ID) that have logging enabled.Flag: read-writeKey: module-idThis list includes the following leafs:module-id

Description: The Fabric OS module identified by module ID.Flag: read-writeType: brocade-logging-types:module-id-typeValue: A Fabric OS module ID.

log-enabledDescription: Whether logging is enabled for the Fabric OS module. This parameter is used onlyduring a PATCH request. Note that this parameter does not display when you use a GET requestto display RASlog modules (for example: GET https://10.10.10.10/rest/running/brocade-logging/raslog-module).Flag: write-onlyType: booleanValue: true = Logging is enabled for the Fabric OS module. false = Logging is disabled for theFabric OS module.

log-quiet-controlDescription: A list of parameters that control quiet time for logging based on the log type.Key: log-typeFlag: read-writeThis list includes the following leafs:log-type

Description: The log type for which quiet time is configured.Flag: read-writeType: string


Broadcom


Value: audit = Quiet time is configured for audit logs. raslog = Quiet time is configured forRASlogs.

quiet-enabledDescription: Whether quiet time is enabled for logs.Flag: read-writeType: booleanValue: true = Quiet time is enabled. false = Quiet time is disabled.

start-timeDescription: The RAS quiet start time for the specified log type. This parameter is available onlywhen quiet time is enabled (quiet-enabled = true).Flag: read-writeType: brocade-logging-types:time-24hr-typeValue: The quiet start time in the 24 hour clock format hh:mm (where hh is 00 to 23 and mm is 00to 5).

end-timeDescription: The RAS quiet end time for the specified log type. Start time must be configuredbefore you can set the end time. This parameter is available only when quiet time is enabled(quiet-enabled = true).Flag: read-writeType: brocade-logging-types:time-24hr-typeValue: The quiet end time in the 24 hour clock format hh:mm (where hh is 00 to 23 and mm is 00to 5).

days-of-weekDescription: The days of the week for which you want to set quiet time for the specified log type.Flag: read-writeThis container has the following leaf:day

Description: The day of the week for which you want to set quiet time for the specifiedlog type. This parameter is available only when quiet time is enabled (quiet-enabled =true). If you set this to everyday, mon, tue, wed, thu, fri, sat, or sun, you must configurethe start and end time.Flag: read-writeType: stringValue: everyday = Enables quiet time everyday for the specified start time and end time.forever = Enables quiet time every day all day (you cannot enter a start or end time).mon, tue, wed, thu, fri, sat, or sun = Enables quiet time for the specified days of theweek for the specified start time and end time.

log-settingDescription: The system-wide parameters to control the logs.Flag: read-writeThis container has the following leafs:syslog-facility-level

Description: The facility level determines the priority of the syslog messages being recorded atthe server. A smaller facility level corresponds to higher priority syslog messages.Flag: read-writeType: stringValue: Valid values are log_local0, log_local1, log_local2, log_local3, log_local4, log_local5,log_local6, and log_local7 (default).


Broadcom


keep-alive-periodDescription: The RASlog keep alive timeout.Flag: read-writeType: uint16Value: 0 through 24 = Keeps logging alive for the specified time. 0 = Disables the keep alivetimeout. Default = 1.

clear-logDescription: Clears logs on the switch for the selected log.Flag: read-writeType: enumerationValues: audit-log = Clears all audit logs generated in the switch. error-log = Clears all error logsgenerated in the switch. all = Clears all audit and error logs generated in the switch.Optional: Yes

supportftpDescription: Sets, clears, or displays support File Transfer Protocol (FTP) parameters and enables ordisables auto file transfer.Flag: read-writeOptional: NoThis container has the following leafs:host

Description: The server's IP address or DNS name to which debug logs are sent.Flag: read-writeType: union {inet:host; string}Values: The server's IP address or DNS name to which debug logs are sent.Optional: Yes

user-nameDescription: The username of the account on the server.Flag: read-writeType: stringValues: The username of the account on the server.Optional: Yes

passwordDescription: The base64 encoded password for the user account on the server.Flag: read-writeType: brocade-security-type:base64-string-typeValues: The base64 encoded password for the user account on the server.Optional: Yes

remote-directoryDescription: The fully qualified path name on the server where switch logs are saved.Flag: read-writeType: stringValues: The fully qualified path name on the server where switch logs are saved.Optional: Yes

auto-enabledDescription: Enables or disables auto dump of trace, FFDC, and core files to the specifiedserver.Flag: read-writeType: booleanValues: true = Enables auto dump. false = Disables auto dump.Optional: Yes


Broadcom


protocolDescription: The protocol used to transfer the trace data as Secure Copy Protocol (SCP), FTP,or Secure File Transfer Protocol (SFTP).Flag: read-writeType: brocade-security-type:sec-crypto-cfg-file-transfer-protocol-typeValues: One of the following valid file transfer protocols: scp, sftp, or ftp.Optional: Yes

portDescription: The user-defined port number for SCP or SFTP. This parameter is availale onlywhen the protocol is SCP or SFTP.Flag: read-writeType: brocade-security-type:sec-crypto-cfg-file-transfer-protocol-typeValues: The user-defined port number for SCP or SFTP.Optional: Yes

connectivity-check-intervalDescription: The time interval in hours at which the server connectivity is tested periodically.When set to 0, this connectivity test is disabled.Flag: read-writeType: uint32Values: 0 to 9 hours.Optional: Yes

audit-logDescription: A list of all audit log events generated on the switch and accumulated over a period of time.Flag: read-onlyOptional: NoThis list has the following leafs:sequence-number

Description: The sequence number to identify the generated audit log message.Flag: read-onlyType: uint32Values: 1 to 1024.Optional: Yes

time-stampDescription: The timestamp the audit log event was generated.Flag: read-onlyType: yang:date-and-timeValues: The timestamp the audit log event was generated.Optional: Yes

message-idDescription: The audit log message identifier.Flag: read-onlyType: brocade-logging-types:message-id-typeValues: The audit log message identifier.Optional: Yes

switch-user-friendly-nameDescription: A printable ASCII name for the switch or chassis based on the context of the auditlog message.Flag: read-onlyType: string


Broadcom


Values: A printable ASCII name for the switch or chassis based on the context of the audit logmessage.Optional: Yes

message-textDescription: The message text populated with actual values from the audit log message.Flag: read-onlyType: stringValues: The message text populated with actual values from the audit log message.Optional: Yes

severity-levelDescription: The severity level of the audit log message.Flag: read-onlyType: brocade-logging-types:severity-level-typeValues: One of the following security levels: info, warning, error, or critical.Optional: Yes

event-classDescription: The event class of the audit log message.Flag: read-onlyType: brocade-logging-types:event-class-typeValues: zone = Log generated by zone module. security = Log generated by security module.configuration = Log generated by configuration event. firmware = Log generated by firmwareevent. fabric = Log generated by fabric event. ls = Log generated by logical switch module. cli= Log generated by CLI. maps = Log generated by MAPS module. ras = Log generated by RASmodule. system = Log generated by system event.Optional: Yes

ip-addressDescription: The IP address from which the user is logged in to the switch.Flag: read-onlyType: union {inet:host; string}Values: The IP address from which the user is logged in to the switch.Optional: Yes

user-nameDescription: The switch user that generated the audit log. 'None' if the generated audit logdoesn’t have a user at the specific context.Flag: read-onlyType: union {brocade-security-type:user-config-user-name-type; string}Values: The switch user that generated the audit log.Optional: Yes

roleDescription: The user's role for the logical fabric context where the audit log was generated.Flag: read-onlyType: brocade-security-type:user-config-role-typeValues: The user's role for the logical fabric context where the audit log was generated.Optional: Yes

interfaceDescription: The interface used to login to the switch which generated the audit log.Flag: read-onlyType: fibrechannel-yang-types:interface-typeValues: The interface used to login to the switch which generated the audit log.Optional: Yes


Broadcom


application-nameDescription: The name of the switch Manageability application run by user.Flag: read-onlyType: stringValues: The name of the switch Manageability application run by user.Optional: Yes

fabric-idDescription: The Fabric ID of switch that generated the audit log.Flag: read-onlyType: uint32Values: 0 = Chassis. 1 to 128 = The fabric ID of the logical switch.Optional: Yes

error-logDescription: A list of all the raslog events generated on a switch and accumulated over a period of time.Flag: read-onlyOptional: NoThis list has the following leafs:sequence-number

Description: An externally assigned sequence number to identify the generated raslog message.Flag: read-onlyType: uint32Values: An externally assigned sequence number to identify the generated raslog message.Optional: Yes

time-stampDescription: The timestamp of the generated raslog event.Flag: read-onlyType: yang:date-and-timeValues: The timestamp of the generated raslog event.Optional: Yes

message-idDescription: The raslog message ID.Flag: read-onlyType: brocade-logging-types:message-id-typeValues: The raslog message ID.Optional: Yes

fabric-idDescription: The Fabric ID of switch that generated the audit log.Flag: read-onlyType: uint32Values: 0 = Chassis. 1 to 128 = The fabric ID of the logical switch.Optional: Yes

slot-idDescription: The slot id of the cp that generated the raslog. It is zero for standalone switches.Flag: read-onlyType: uint32Values: The slot id of the cp that generated the raslog.Optional: Yes

severity-levelDescription: The severity level of the log message.


Broadcom


Flag: read-onlyType: brocade-logging-types:severity-level-typeValues: One of the following security levels: info, warning, error, or critical.Optional: Yes

ffdc-generated-eventDescription: Whether the generated raslog is an FFDC event.Flag: read-onlyType: booleanValues: true = The raslog is an FFDC event. false = The raslog is not an FFDC event.Optional: Yes

switch-user-friendly-nameDescription: A printable ASCII name for the switch or chassis based on the context of the raslogmessage.Flag: read-onlyType: stringValues: A printable ASCII name for the switch or chassis based on the context of the raslogmessage.Optional: Yes

message-textDescription: The message text populated with actual values in the raslog.Flag: read-onlyType: stringValues: The message text populated with actual values in the raslog.Optional: Yes

Supported Methods

Only the OPTIONS, HEAD, GET, POST, PATCH, and DELETE operations are supported in this module.

History



Fabric OS 9.0.0 This API call was modified to add the supportftp, audit-log, and error-log lists.

Fabric OS 9.0.1 This API call was modified to add the port parameter to the supportftp container.


Broadcom


brocade-logging ExamplesThis section provides examples for the brocade-logging module.

Viewing the Current Audit Log Configuration

The following example uses the GET request to view the audit log configuration.

StructureGET <base_URI>/running/brocade-logging/auditURIGET https://10.10.10.10/rest/running/brocade-logging/audit

Request BodyNo request body is required.Response BodyWhen the operation is successful, the response has a message body similar to the following and a “200 OK”status appears in the headers.


<Response>

<audit>

<audit-enabled>true</audit-enabled>

<severity-level>info</severity-level>

<filter-class-list>

<filter-class>zone</filter-class>

<filter-class>security</filter-class>

<filter-class>configuration</filter-class>

<filter-class>firmware</filter-class>

<filter-class>fabric</filter-class>

<filter-class>ls</filter-class>

<filter-class>cli</filter-class>

<filter-class>maps</filter-class>

</filter-class-list>

</audit>

</Response>

Enabling Audit Logging

The following example uses the PATCH request to enable audit logging.

StructurePATCH <base_URI>/running/brocade-logging/audit/audit-enabled/trueURIPATCH https://10.10.10.10/rest/running/brocade-logging/audit/audit-enabled/true



Broadcom



Disabling Audit Logging

The following example uses the PATCH request to disable audit logging.

StructurePATCH <base_URI>/running/brocade-logging/audit/audit-enabled/falseURI RequestPATCH https://10.10.10.10/rest/running/brocade-logging/audit/audit-enabled/false

Request BodyNo request body is required.Response BodyWhen the operation is successful, the response contains an empty message body and a "204 No Content”status appears in the header.

Configuring the Security Level

The following example uses the PATCH request to configure the security level to info. Only log messages of the specifiedseverity level and higher display.

StructurePATCH <base_URI>/running/brocade-logging/audit/severity-level/infoURI RequestPATCH https://10.10.10.10/rest/running/brocade-logging/audit/severity-level/info

Request BodyNo request body is required.Response BodyWhen the operation is successful, the response contains an empty message body and a “204 No Content”status appears in the header.

Configuring the Filter Class

The following example uses the PATCH request to configure the filter class list to include zone, fabric, and MAPS.

StructurePATCH <base_URI>/running/brocade-logging/audit/filter-class-listURI RequestPATCH https://10.10.10.10/rest/running/brocade-logging/audit/filter-class-list

Request Body

<filter-class-list>

<filter-class>zone</filter-class>

<filter-class>fabric</filter-class>


Broadcom


<filter-class>maps</filter-class>

</filter-class-list>


Viewing the Current Syslog Configuration

The following example uses the GET request to display the current syslog configuration.

StructureGET <base_URI>/running/brocade-logging/syslog-serverURI RequestGET https://10.10.10.10/rest/running/brocade-logging/syslog-server



<Response>

<syslog-server>

<server>10.10.10.11</server>

<port>514</port>

<secure-mode>false</secure-mode>

</syslog-server>

<syslog-server>


<port>514</port>


</syslog-server>

<syslog-server>


<port>514</port>


</syslog-server>

</Response>

Configuring a Non-secure Syslog Server

The following example uses the POST request to configure a non-secure syslog server '17.14.15.16'.

StructurePOST <base_URI>/running/brocade-logging/syslog-serverURI RequestPOST https://10.10.10.10/rest/running/brocade-logging/syslog-server


Broadcom


Request Body

<syslog-server>



</syslog-server>

Response BodyWhen the operation is successful, the response has a message body similar to the following, and a “201Created” status appears in the headers.

Configuring a Secure Syslog Server

The following example uses the POST request to configure a secure syslog server '17.14.15.17'.

StructurePOST <base_URI>/running/brocade-logging/syslog-serverURI RequestPOST https://10.10.10.10/rest/running/brocade-logging/syslog-server

Request Body

<syslog-server>


<port>5670</port>

<secure-mode>true</secure-mode>

</syslog-server>

Response BodyWhen the operation is successful, the response has a message body similar to the following, and a “201Created” status appears in the headers.

Removing a Syslog Server

The following example uses the DELETE request to remove syslog server '17.14.15.16'.

StructureDELETE <base_URI>/running/brocade-logging/syslog-server/server/ip_address

URI RequestDELETE https://10.10.10.10/rest/running/brocade-logging/syslog-server/server/17.14.15.16

Request BodyNo request body is required.Response BodyWhen the operation is successful, the response contains an empty message body and a “204 No Content"status appears in the header.

Viewing all External RASlog Messages

The following example uses the GET request to displays all external RASlog messages, their status (enabled or disabled),their configured severity and their default severity.


Broadcom


StructureGET <base_URI>/running/brocade-logging/raslogURI RequestGET https://10.10.10.10/rest/running/brocade-logging/raslog



<Response>

<raslog>

<message-id>FCIP-1000</message-id>

<current-severity>error</current-severity>

<default-severity>error</default-severity>

<message-enabled>true</message-enabled>

<message-flooded>false</message-flooded>

</raslog>

<raslog>


<current-severity>critical</current-severity>

<default-severity>critical</default-severity>



</raslog>

<raslog>


<current-severity>info</current-severity>

<default-severity>info</default-severity>



</raslog>

.

.

.

<raslog>

<message-id>CONF-1053</message-id>





</raslog>

<raslog>






</raslog>


Broadcom


<raslog>






</raslog>

</Response>

Viewing the Status of a Specific RASlog Message

The following example uses the GET request to view the status of a specific RASlog message 'AUTH-1002'.

StructureGET <base_URI>/running/brocade-logging/raslog/message-id/message_id

URI RequestGET https://10.10.10.10/rest/running/brocade-logging/raslog/message-id/<message_id>


<xml version="1.0">

<Response>

<raslog>

<message-id>AUTH-1002</message-id>




<default-severity>error</default-severity>

</raslog>

</Response>

Enabling Logging for a Specific RASlog Message

The following example uses the PATCH request to enable logging for a specific RASlog message 'AUTH-1002'.

StructurePATCH <base_URI>/running/brocade-logging/raslog/message-id/message_id/message-enabled/trueURI RequestPATCH https://10.10.10.10/rest/running/brocade-logging/raslog/message-id/AUTH-1002/message-enabled/

true

Request BodyNo request body is required.Response BodyWhen the operation is successful, the response has an empty message body and a “204 No Content” statusmessage.


Broadcom


Disabling Logging for a Specific RASlog Message

The following example uses the PATCH request to disable logging for a specific RASlog message 'AUTH-1002'.

StructurePATCH <base_URI>/running/brocade-logging/raslog/message-id/message_id/message-enabled/falseURI RequestPATCH https://10.10.10.10/rest/running/brocade-logging/raslog/message-id/AUTH-1002/message-enabled/

false


Enabling Syslog for a Specific Internal RASlog Message

The following example uses the PATCH request to enable an internal RASlog message 'CONF-5000' to be sent to syslog(this is done per instruction from support). The syslog-enabled parameter is only supported for internal RASlog messages.Internal RASlog messages have an ID number equal to or greater than 5000.

StructurePATCH <base_URI>/running/brocade-logging/raslog/message-id/message_id/syslog-enabled/trueURI RequestPATCH https://10.10.10.10/rest/running/brocade-logging/raslog/message-id/CONF-5000/syslog-enabled/

true


Disabling Syslog for a Specific RASlog Message

The following example uses the PATCH request to disable an internal RASlog message 'CONF-5000' for syslog (thisis done per instruction from support). The syslog-enabled parameter is only supported for internal RASlog messages.Internal RASlog messages have an ID number equal to or greater than 5000.

StructurePATCH <base_URI>/running/brocade-logging/raslog/message-id/message_id/syslog-enabled/falseURI RequestPATCH https://10.10.10.10/rest/running/brocade-logging/raslog/message-id/CONF-5000/syslog-enabled/

false



Broadcom



Configuring Settings for a Specific External RASlog Message

The following example uses the PATCH request to configure the following settings for a specific external RASlog message'AUTH-1002':

• message-enabled = true• default-severity = info

External RASlog messages have an ID number equal to or less than 4999.

Configuring Settings for a Specific External RASlog MessageThe following example uses the PATCH request to configure the following settings for a specific externalRASlog message 'AUTH-1002':

• message-enabled = true• default-severity = info

External RASlog messages have an ID number equal to or less than 4999.StructurePATCH <base_URI>/running/brocade-logging/raslogURI RequestPATCH https://10.10.10.10/rest/running/brocade-logging/raslog

Request Body

<raslog>

<message-id>AUTH-1002</message-id>



</raslog>


Configuring Settings for a Specific Internal RASlog Message

The following example uses the PATCH request to configure the following settings for a specific Internal RASlog message'CONF-5000':

• default-severity = error• syslog-enabled = true

The syslog-enabled parameter is only supported for internal RASlog messages. Internal RASlog messages have an IDnumber equal to or greater than 5000.

StructurePATCH <base_URI>/running/brocade-logging/raslog


Broadcom


URI RequestPATCH https://10.10.10.10/rest/running/brocade-logging/raslog

Request Body

<raslog>


<syslog-enabled>true</syslog-enabled>


</raslog>


Viewing a List of the Current RASlog Modules

The following example uses the GET request to view a list of all RASlog modules.

StructureGET <base_URI>/running/brocade-logging/raslog-moduleURI RequestGET https://10.10.10.10/rest/running/brocade-logging/raslog-module



<Response>

<raslog-module>

<module-id>UT</module-id>

</raslog-module>

<raslog-module>

<module-id>TRCE</module-id>

</raslog-module>

<raslog-module>

<module-id>KTRC</module-id>

</raslog-module>

.

.

.

<raslog-module>

<module-id>UCID</module-id>

</raslog-module>

<raslog-module>

<module-id>AMPM</module-id>

</raslog-module>

<raslog-module>


Broadcom


<module-id>BCMG</module-id>

</raslog-module>

</Response>

Enabling Logging for all Messages in a RASlog Module Group

The following example uses the PATCH request to enable logging for all messages in the RASlog module group 'UT'.

StructurePATCH <base_URI>/running/brocade-logging/raslog-module/module_id/log-enabled/trueURI RequestPATCH https://10.10.10.10/rest/running/brocade-logging/raslog-module/UT/log-enabled/true


Disabling Logging for all Messages in a RASlog Module Group

The following example uses the PATCH request to disable logging for all RASlog messages in the RASlog module group'TRCE'.

StructurePATCH <base_URI>/running/brocade-logging/raslog-module/module_id/log-enabled/falseURI RequestPATCH https://10.10.10.10/rest/running/brocade-logging/raslog-module/TRCE/log-enabled/false


Viewing the Quiet Time Configuration

The following example uses the GET request to display the current quiet time configuration.

StructureGET <base_URI>/running/brocade-logging/log-quiet-controlURI RequestGET https://10.10.10.10/rest/running/brocade-logging/log-quiet-control



Broadcom


<Response>

<log-quiet-control>

<log-type>audit</log-type>

<quiet-enabled>false</quiet-enabled>

<days-of-week/>

</log-quiet-control>

<log-quiet-control>

<log-type>raslog</log-type>

<quiet-enabled>false</quiet-enabled>

<days-of-week/>


</Response>

Enabling Quiet Time for a Specific Log Type

The following example uses the PATCH request to enable quiet time for audit logs.

StructurePATCH <base_URI>/running/brocade-logging/log-quiet-control/log-type/log_type/quiet-enabled/trueURI RequestPATCH https://10.10.10.10/rest/running/brocade-logging/log-quiet-control/log-type/audit/quiet-

enabled/true


Disabling Quiet Time for a Specific Log Type

The following example uses the PATCH request to disable quiet time for audit logs.

StructurePATCH <base_URI>/running/brocade-logging/log-quiet-control/log-type/log_type/quiet-enabled/falseURI RequestPATCH https://10.10.10.10/rest/running/brocade-logging/log-quiet-control/log-type/audit/quiet-

enabled/false


Configuring the Quiet Time

The following example uses the PATCH request to configure quiet time for a duration of forever for audit logs.


Broadcom


StructurePATCH <base_URI>/running/brocade-logging/log-quiet-controlURI RequestPATCH https://10.10.10.10/rest/running/brocade-logging/log-quiet-control

Request Body

<log-quiet-control>


<days-of-week>forever</days-of-week>



Configuring Quiet Time for a Specific Log Type with Start Time, End Time, and Days of Week Specified

The following example uses the PATCH request to enable quiet time for audit logs on Monday, Wednesday, and Friday at7:00 AM and turns off at 1:00 PM.

StructurePATCH <base_URI>/running/brocade-logging/log-quiet-controlURI RequestPATCH https://10.10.10.10/rest/running/brocade-logging/log-quiet-control

Request Body

<log-quiet-control>


<quiet-enabled>true</quiet-enabled>

<start-time>0700</start-time>

<end-time>1300</end-time>

<days-of-week>

<day>mon</day>

<day>wed</day>

<day>fri</day>

</days-of-week>



Configuring the Syslog Facility

The following example uses the PATCH request to set the syslog facility to 'log_local2'.

StructurePATCH <base_URI>/running/brocade-logging/log-setting


Broadcom


URI RequestPATCH https://10.10.10.10/rest/running/brocade-logging/log-setting

Request Body

<log-setting>

<syslog-facility-level>log_local2</syslog-facility-level>

</log-setting>


Configuring the Keep Alive Period

The following example uses the PATCH request to set the system keepalive period to '1'. The valid values are from 0through 24; where 0 disables keepalive period.

StructurePATCH <base_URI>/running/brocade-logging/log-setting/keep-alive-period/[0-24]URI RequestPATCH https://10.10.10.10/rest/running/brocade-logging/log-setting/keep-alive-period/1


Viewing the Support FTP Settings

This example uses a GET request to view supportFTP settings.

Structure

GET <base_URI>/running/brocade-logging/supportftp

URI

GET https://10.10.10.10/rest/running/brocade-logging/supportftp

Request Body


Response Body


<Response>

<supportftp>

<host/>

<user-name/>

<password/>


Broadcom


<remote-directory/>

<auto-enabled>false</auto-enabled>

<protocol>ftp</protocol>

<connectivity-check-interval>0</connectivity-check-interval>

</supportftp>

</Response>

Configuring Support FTP

This example uses a PATCH request to configure supportFTP.

Structure

PATCH <base_URI>/running/brocade-logging/supportftp

URI

PATCH https://10.10.10.10/rest/running/brocade-logging/supportftp

Request Body

<supportftp>

<host>10.10.10.10</host>

<user-name>Bob</user-name>

<password>base64-pass</password>

<remote-directory> </remote-directory>

<auto-enabled>false</auto-enabled>


<connectivity-check-interval>0</connectivity-check-interval>

</supportftp>

Response Body


Viewing Audit Logs

This example uses a GET request to view audit logs.

Structure

GET <base_URI>/running/brocade-logging/audit-log

URI

GET https://10.10.10.10/rest/running/brocade-logging/audit-log

Request Body


Response Body


<Response>

<audit-log>

<sequence-number>1</sequence-number>



Broadcom


<message-id>RAS-3005</message-id>

<message-text>CLI: ## REST Operation: GET /brocade-maps/rule/name/defALL_32GSWL_SFPSFP_TEMP_85/

actions ##</message-text>


<event-class>cli</event-class>

<user-name>root</user-name>

<role>root</role>


<interface>ssh</interface>

<application-name>CLI</application-name>

<switch-user-friendly-name>BrocadeX6-4</switch-user-friendly-name>


</audit-log>

...

<audit-log>



<message-id>SEC-3022</message-id>

<message-text>Event: logout, Status: success, Info: Successful logout by user [admin].</message-text>


<event-class>security</event-class>

<user-name>admin</user-name>

<role>admin</role>

<ip-address>2620:100:4:f800:215:5dff:fe26:3e0c</ip-address>

<interface>https</interface>

<application-name>SANnavMP-2.1.0-f</application-name>



</audit-log>

</Response>

Viewing Error Logs

This example uses a GET request to view error logs.

Structure

GET <base_URI>/running/brocade-logging/error-log

URI

GET https://10.10.10.10/rest/running/brocade-logging/error-log

Request Body


Response Body


<Response>

<error-log>


<message-id>HAM-1004</message-id>


Broadcom




<ffdc-generated-event>false</ffdc-generated-event>



<switch-user-friendly-name>BrocadeX6-4</switch-user-friendly-name>

<message-text>Processor rebooted - Reset.</message-text>

</error-log>

...

<error-log>


<message-id>MAPS-1132</message-id>



<ffdc-generated-event>false</ffdc-generated-event>




<message-text>Monitoring on members 8/16 of type PORT is restarted.</message-text>

</error-log>

</Response>


Broadcom


brocade-mapsThis module provides a detailed view of the Monitoring and Alerting Policy Suite (MAPS) features available in the FabricOS REST API. It assumes a knowledge of MAPS as performed in Fabric OS. For information on that topic, refer to theBrocade Fabric OS MAPS User Guide.

Module Tree

This is the tree view of the module from the brocade-maps.yang-tree.txt file. See YANG Module Overview forYANG node field definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-maps

+--rw brocade-maps

+--ro switch-status-policy-report

| +--ro switch-health? maps-types:ssp-state-type

| +--ro power-supply-health? maps-types:ssp-state-type

| +--ro fan-health? maps-types:ssp-state-type

| +--ro wwn-health? maps-types:ssp-state-type

{fibrechannel:fibrechannel_chassis_platform}?

| +--ro temperature-sensor-health? maps-types:ssp-state-type

| +--ro ha-health? maps-types:ssp-state-type


| +--ro control-processor-health? maps-types:ssp-state-type


| +--ro core-blade-health? maps-types:ssp-state-type


| +--ro blade-health? maps-types:ssp-state-type


| +--ro flash-health? maps-types:ssp-state-type

| +--ro marginal-port-health? maps-types:ssp-state-type

| +--ro faulty-port-health? maps-types:ssp-state-type

| +--ro missing-sfp-health? maps-types:ssp-state-type

| +--ro error-port-health? maps-types:ssp-state-type

| +--ro expired-certificate-health? maps-types:ssp-state-type

| +--ro airflow-mismatch-health? maps-types:ssp-state-type

| +--ro marginal-sfp-health? maps-types:ssp-state-type

| +--ro trusted-fos-certificate-health? maps-types:ssp-state-type

+--ro system-resources

| +--ro cpu-usage? uint32

| +--ro memory-usage? uint32

| +--ro total-memory? uint32

| +--ro flash-usage? uint32

+--rw paused-cfg* [group-type]

| +--rw group-type enumeration

| +--rw members

| +--rw member* string

+--rw group* [name]

| +--rw name maps-types:maps-group-name-type

| +--rw group-type maps-types:maps-group-type-type

| +--rw group-feature? maps-types:maps-group-feature-type

| +--rw feature-pattern? string

| +--ro is-predefined? boolean

| +--ro is-modifiable? boolean


Broadcom


| +--rw un-quarantine-clear? boolean

+--rw maps-policy* [name]

| +--rw name maps-types:maps-policy-name-type

| +--rw rule-list

| | +--rw rule* maps-types:maps-rule-name-type

| +--rw is-active-policy? boolean

| +--ro is-predefined-policy? boolean

+--ro monitoring-system-matrix* [monitoring-system group-type]

| +--ro monitoring-system maps-types:maps-monitoring-system-type

| +--ro group-type maps-types:maps-group-type-type

| +--ro dashboard-category? maps-types:maps-dashboard-category-type

| +--ro base-time-bases

| | +--ro time-base* maps-types:maps-time-base-type

| +--ro rule-on-rule-time-bases

| | +--ro rule-on-rule-time-base* maps-types:maps-time-base-type

| +--ro is-read-only? boolean

| +--ro monitored-logical-switch? enumeration

| +--ro is-rule-on-rule-supported? boolean

| +--ro is-quiet-time-supported? boolean

| +--ro minimum-quiet-time? uint32

| +--ro monitoring-type? maps-types:monitoring-type-type

| +--ro data-type? maps-types:data-type-type

| +--ro description? string

| +--ro actions

| | +--ro action* maps-types:maps-generic-action-type

| +--ro unit? maps-types:maps-data-unit

| +--ro data-range? string

| +--ro logical-operators

| +--ro logical-operator* maps-types:maps-logical-operator-type

+--rw fpi-profile* [name]

| +--rw name maps-types:maps-policy-name-type

| +--ro predefined-profile? boolean

| +--rw performance-impact

| | +--rw transmit-queue-latency uint32

| | +--rw credit-zero-percentage-1-sec uint32



| +--rw frame-loss

| | +--rw transmit-queue-latency uint32

| +--ro port-oversubscription

| +--ro transmit-percentage? uint32

+--ro dashboard-history* []

+--ro category? string

+--ro date? string

+--ro crc-errors

| +--ro port-data* string

+--ro itw-errors


x--ro port-loss


+--ro loss-of-sync


+--ro link-failure


Broadcom



+--ro signal-loss


+--ro protocol-errors


+--ro state-change


+--ro link-reset


+--ro c3-tx-to


+--ro rx-perf


+--ro tx-perf


+--ro utilization

+--ro port-data* string

URI Format


• <base_URI>/running/brocade-maps/switch-status-policy-report to display the Switch Status Policyreport.

• <base_URI>/running/brocade-maps/system-resources to display system resources (such as memory, CPU,and flash).

• <base_URI>/running/brocade-maps/paused-cfg to display or configure the paused objects list.

• <base_URI>/running/brocade-maps/group to display or configure groups.

• <base_URI>/running/brocade-maps/maps-config to display or configure the current configuration.

• <base_URI>/running/brocade-maps/dashboard-rule to display the dashboard rules.

• <base_URI>/running/brocade-maps/dashboard-misc to display the dashboard miscellaneous information (suchas start time and operation).

• <base_URI>/running/brocade-maps/credit-stall-dashboard to display the Credit Stall dashboard.

• <base_URI>/running/brocade-maps/oversubscription-dashboard to display the Oversubscriptiondashboard.

• <base_URI>/running/brocade-maps/rule to display or configure rules.

• <base_URI>/running/brocade-maps/maps-policy to display or configure MAPS policies.

• <base_URI>/running/brocade-maps/monitoring-systems-matrix to display the monitoring system matrix.

• <base_URI>/running/brocade-maps/fpi-profile to display or configure the FPI profile.

• <base_URI>/running/brocade-maps/dashboard-history to display the dashboard history.

Parametersbrocade-maps

Description: The manageable MAPS features.Flag: read-writeThis container has the following leafs:


Broadcom


switch-status-policy-reportDescription: The Switch Status Policy report. The SSP report provides the overall health status of theswitch and includes enough information for you to investigate further, if necessary.Flag: read-onlyConfig: falseThis container has the following leafs:switch-health

Description: The overall status of the switch. The switch state is determined by the state of oneor more of its components (power supply, fan, wwn, and so on).Flag: read-onlyType: maps-types:ssp-state-typeValue:unknown = The switch is in an unknown state.down = The switch is in a down state and service is impacted. Review the health of the switchcomponents to determine the cause of the down state. If a FRU is down, fix or replace it with anew FRU.marginal = The switch is in a marginal state. You must take action immediately or service may beimpacted. For example, if a FRU is marginal, fix or replace it with a new FRU. Review the healthof the switch components to determine the cause of the marginal state.healthy = The switch is within normal operating conditions.Optional: Yes

power-supply-healthDescription: The state of the power supplies.Flag: read-onlyType: maps-types:ssp-state-typeValue:unknown = The FRU is in an unknown state.down = The FRU is in a down state and service is impacted. If a FRU is down, fix or replace itwith a new FRU.marginal = The FRU is in a marginal state. You must take action immediately or service may beimpacted. If a FRU is marginal, fix or replace it with a new FRU.healthy = The FRU is within normal operating conditions.Optional: Yes

fan-healthDescription: The state of the fans.Flag: read-onlyType: maps-types:ssp-state-typeValue:unknown = The FRU is in an unknown state.down = The FRU is in a down state and service is impacted. If a FRU is down, fix or replace itwith a new FRU.marginal = The FRU is in a marginal state. You must take action immediately or service may beimpacted. If a FRU is marginal, fix or replace it with a new FRU.healthy = The FRU is within normal operating conditions.Optional: Yes

wwn-healthDescription: The state of the WWN cards.Flag: read-onlyType: maps-types:ssp-state-typeValue:unknown = The FRU is in an unknown state.


Broadcom


down = The FRU is in a down state and service is impacted. If a FRU is down, fix or replace itwith a new FRU.marginal = The FRU is in a marginal state. You must take action immediately or service may beimpacted. If a FRU is marginal, fix or replace it with a new FRU.healthy = The FRU is within normal operating conditions.Optional: Yes

temperature-sensor-healthDescription: The state of the temperature sensors.Flag: read-onlyType: maps-types:ssp-state-typeValue:unknown = The temperature sensor is in an unknown state.down = The temperature sensor is in a down state and service is impacted.marginal = The temperature sensor is in a marginal state. You must take action immediately orservice may be impacted.healthy = The temperature sensor is within normal operating conditions.Optional: Yes

ha-healthDescription: The state of the high availability (both control processors are in sync).Flag: read-onlyType: maps-types:ssp-state-typeValue:unknown = The HA is in an unknown state.down = The HA is in a down state and service is impacted.marginal = The HA is in a marginal state. You must take action immediately or service may beimpacted.healthy = The HA is within normal operating conditions.Optional: Yes

control-processor-healthDescription: The state of the control processors.Flag: read-onlyType: maps-types:ssp-state-typeValue:unknown = The FRU is in an unknown state.down = The FRU is in a down state and service is impacted. If a FRU is down, fix or replace itwith a new FRU.marginal = The FRU is in a marginal state. You must take action immediately or service may beimpacted. If a FRU is marginal, fix or replace it with a new FRU.healthy = The FRU is within normal operating conditions.Optional: Yes

core-blade-healthDescription: The state of the core blades.Flag: read-onlyType: maps-types:ssp-state-typeValue:unknown = The blade is in an unknown state.down = The blade is in a down state and service is impacted. If a blade is down, fix or replace itwith a new blade.marginal = The blade is in a marginal state. You must take action immediately or service may beimpacted. If a blade is marginal, fix or replace it with a new blade.healthy = The blade is within normal operating conditions.


Broadcom


Optional: Yesblade-health

Description: The state of the application blades.Flag: read-onlyType: maps-types:ssp-state-typeValue:unknown = The blade is in an unknown state.down = The blade is in a down state and service is impacted. If a blade is down, fix or replace itwith a new blade.marginal = The blade is in a marginal state. You must take action immediately or service may beimpacted. If a blade is marginal, fix or replace it with a new blade.healthy = The blade is within normal operating conditions.Optional: Yes

flash-healthDescription: The state of the flash usage.Flag: read-onlyType: maps-types:ssp-state-typeValue:unknown = The flash usage is in an unknown state.down = The flash usage is in a down state and service is impacted.marginal = The flash usage is in a marginal state. You must take action immediately or servicemay be impacted.healthy = The flash usage is within normal operating conditions.Optional: Yes

marginal-port-healthDescription: The state of the marginal portsFlag: read-onlyType: maps-types:ssp-state-typeValue:unknown = The port is in an unknown state.down = The port is in a down state and service is impacted.marginal = The port is in a marginal state. You must take action immediately or service may beimpacted.healthy = The port is within normal operating conditions.Optional: Yes

faulty-port-healthDescription: The state of the faulty portsFlag: read-onlyType: maps-types:ssp-state-typeValue:unknown = The port is in an unknown state.down = The port is in a down state and service is impacted.marginal = The port is in a marginal state. You must take action immediately or service may beimpacted.healthy = The port is within normal operating conditions.Optional: Yes

missing-sfp-healthDescription: The state of the SFP.Flag: read-onlyType: maps-types:ssp-state-typeValue:


Broadcom


unknown = The SFP is in an unknown state.down = The SFP is in a down state and service is impacted. If a SFP is down, fix or replace itwith a new SFP.marginal = The SFP is in a marginal state. You must take action immediately or service may beimpacted. If a SFP is marginal, fix or replace it with a new SFP.healthy = The SFP is within normal operating conditions.Optional: Yes

error-port-healthDescription: The state of the error ports.Flag: read-onlyType: maps-types:ssp-state-typeValue:unknown = The port is in an unknown state.down = The port is in a down state and service is impacted.marginal = The port is in a marginal state. You must take action immediately or service may beimpacted.healthy = The port is within normal operating conditions.Optional: Yes

expired-certificate-healthDescription: The state of the certificate.Flag: read-onlyType: maps-types:ssp-state-typeValue:unknown = The certificate is in an unknown state.down = The certificate is in a down state and service is impacted.marginal = The certificate is in a marginal state. You must take action immediately or service maybe impacted.healthy = The certificate is within normal operating conditions.Optional: Yes

airflow-mismatch-healthDescription: The state of the airflow. This parameter monitors the air flow direction of the powersupply fan FRUs and blower FRUs and generates an alert if there is a mismatch in the air flowdirection of any two power supply fans or any two blowers.Flag: read-onlyType: maps-types:ssp-state-typeValue:unknown = The airflow is in an unknown state.down = The airflow is in a down state and service is impacted.marginal = The airflow is in a marginal state. You must take action immediately or service may beimpacted.healthy = The airflow is within normal operating conditions.Optional: Yes

marginal-sfp-healthDescription: The state of the SFPs. If a certain percentage of SFPs are in SFP_MARGINAL, theswitch state is moved to marginal or critical.Flag: read-onlyType: maps-types:ssp-state-typeValue:unknown = The SFP is in an unknown state.down = The SFP is in a down state and service is impacted.


Broadcom


marginal = The SFP is in a marginal state. You must take action immediately or service may beimpacted.healthy = The SFP is within normal operating conditions.Optional: Yes

trusted-fos-certificate-healthDescription:When a certificate expires, the switch state is moved to marginal or critical.Flag: read-onlyType: maps-types:ssp-state-typeValue: unknown = The unknown state. down = The down state and service is impacted.marginal = The marginal state. You must take action immediately or service may be impacted.healthy = The healthy state, within normal operating conditions.Optional: Yes

system-resourcesDescription: The system resources (such as CPU, RAM, and flash memory usage). Note that usage is not realtime and may be delayed up to 2 minutes.Flag: read-onlyConfig: falseThis container has the following leafs:cpu-usage

Description: The percentage of CPU usage.Flag: read-onlyType: uint32Value: The percentage of CPU usage (0 to 100%).Optional: Yes

memory-usageDescription: The percentage of memory usage.Flag: read-onlyType: uint32Value: The percentage of memory usage (0 to 100%).Optional: Yes

total-memoryDescription: The total memory usage in kilobytes.Flag: read-onlyType: uint32Value: The total memory usage in kilobytes.Optional: Yes

flash-usageDescription: The percentage of flash usage.Flag: read-onlyType: uint32Value: The percentage of flash usage (0 to 100%).Optional: Yes

paused-cfgDescription: A list of elements or element groups on which you want to pause or restart monitoring. You canonly pause or restart monitoring on the following group types: FC port, FCIP circuit (and QOS), SFP, and switch(logical switch). You can also pause or restart monitoring on all groups using the group type all.Flag: read-writeKey: group-typeThis list has the following leafs:


Broadcom


group-typeDescription: The element group on which you want to pause or restart monitoring.Flag: read-writeType: enumerationValue:fc-port = This group manages FC ports. sfp = This group manages FC SFPs. Note that the system mayhave different SFPs based on the speed or vendor. circuit = This group manages FCIP circuits. A circuitis a virtual connection between two extension systems. switch = This group manages logical switches. all= This group represents all supported group types for the pause and continue feature.Optional: Yes

membersDescription: A list of elements (FC ports, FCIP circuits, SFPs, or switches) or all members in the grouptype. There must be at least one member in the list. This parameter is not required when the group type isall (group-type = all) or switch (group-type = switch).Flag: read-writeThis list has the following leaf:member

Description: An element (FC port, FCIP circuit, SFP, or switch) or all members in the grouptype. For a switch, when you enter all, it includes all FC ports, SFPs, and circuits in the logicalswitch as well as the switch group.Flag: read-writeType: stringValue: One or more individual elements (FC port, FCIP circuit, SFP, or switch) or all membersin the group type. Valid values use the following formats: <slot>/<port>, <slot>/<port>/<circuit>,<slot>/<sfp>, <port>, and <sfp>.Optional: Yes

groupDescription: A list of groups to be monitored using the same set of thresholds. For example, you can create agroup of ports that behave in a similar manner, such as UNIX ports or long-distance ports. Note that all elements(ports, FCIP circuits, or SFPs) in a group must be of the same type. By creating a group of similar elements, youcan manage these elements as a single entity. You can create up to 64 user-defined groups per logical switch.Flag: read-writeKey: nameThis list has the following leafs:name

Description: The group name. The group name must be unique; it is not case sensitive and can containup to 32 characters.Flag: read-writeType: maps-types:maps-group-name-typeValue: 1 to 32 alphanumeric characters.Optional: Yes

group-typeDescription: The type of elements (such as, fc-port, sfp, fan, and so on) contained in the group.Flag: read-writeType: maps-types:maps-group-type-typeValue: power-supply = The power supply group type. The device may have multiple power suppliesand may be integrated with a fan. fan = The fan group type. The device may have multiple fans may beintegrated with power supplies. fc-port = The FC port group type. sfp = The FC SFP group type. Thedevice may have different SFPs based on speed or vendor. blade = The blade group type. This grouptype manages all blades including core, CP, or switch blades. circuit = The FCIP circuit group type.circuit-qos = The circuit QOS traffic group type. Note that each circuit can carry multiple QOS traffic.


Broadcom


temperature-sensor = The temperature sensor group type. This group manages temperature sensors.flash = The flash memory group type. switch = The switch group type. chassis = The chassis grouptype. cpu = The CPU group type. wwn = The WWN card group type. flow = The flow group type. tunnel= The tunnel group type. tunnel-qos = The tunnel qos group type. backend-port = The back end grouptype. ge-port = The giga bit ethernet port group type. certificate = The security certificate group type. dp= The data process group type. device-pid = The device PID group type. ethernet-port = The Ethernetport group type. vtap-port = The vtap port group type. asic = The ASIC group type.Optional: Yes

group-featureDescription: The existing group feature name (such as node-wwn, port-name, or unknown). Thisparameter is empty when no group feature is assigned to the group.Flag: read-writeType: maps-group-feature-typeValue: node-wwn = The node WWN feature. port-name = The port name feature. unknown = Thefeature is unknown.Optional: Yes

feature-patternDescription: The feature pattern. This parameter is applicable when the group feature is node WWN(group-feature = node-wwn) or port name (group-feature = port-name). Specifies the wildcard characterswhile defining the feature characteristics. The wildcard characters "*" for any string, "?" for any singlecharacter, "[expr]" for one character from the set specified in the expression, or '!' for negation of thestring, are supported. If '!' is specified in the pattern, the pattern must be in single quotes. For example, ifyou create a group where group feature is "port-name" and the feature pattern is "brcdhost*", the grouphas a membership defined as ports with a port name that begins with "brcdhost."Flag: read-writeType: stringValue: The feature patternOptional: Yes

is-predefinedDescription: Whether the group is a system-defined or user-defined group. You cannot delete system-defined groups; however, you can augment the ports managed by the group.Flag: read-onlyType: booleanConfig: falseValue: true = The group is system-defined. false = The group is user-defined.Optional: Yes

is-modifiableDescription: Whether you can modify the group. You can modify all user-defined groups, and predefinedport type groups, except for the ALL_QUARANTINED_PORTS group and any flow group (although theparameter is true).Flag: read-onlyType: booleanConfig: falseValue: true = The system-defined group can be modified. false = The system-defined group cannot bemodified.Optional: Yes

membersDescription: A list of members (groups) (such as node-wwn or port-name). This parameter is availableonly when the group feature parameter is node WWN or port name (group-feature=node-wwn or port-name). There must be at least one member in the list.Flag: read-write


Broadcom


This list has the following leaf:member

Description: A member (group) (such as, node-wwn or port-name).Flag: read-writeType: stringValue: A group (such as node-wwn or port-name). Valid values use the following formats: <slot>/<port>, <slot>/<port>/<circuit>, <slot>/<sfp>, <port>, <sfp>, <slot>/<asic>, <slot or blade>,<switch>, <fan index>, <temperature sensor index>, <power supply index>, 'All PIDs monitored',and 'Monitored Flows'.Optional: Yes

maps-configDescription: The MAPS configuration for the switch. You can perform the following MAPS configurations usingthis container:• View the current MAPS configuration.• Define the actions to take on the switch when a threshold is triggered.• Specify the e-mail addresses to which the alerts are sent.• Delete all user-defined MAPS configurations related to rules, groups, policies, and so on.Flag: read-writeThis container has the following leafs:actions

Description: The global MAPS actions list.Flag: read-writeThis container has the following leafs:action

Description: The MAPS actions. You can enable one or more actions globally at the switch levelor per rule.Flag: read-writeType: maps-types:maps-generic-action-typeValue: port-fence = This action immediately takes ports offline, which mightcause loss of traffic.snmp-trap = This action generates a message (called a “trap”) that notifies a managementstation when specific events occur on a switch. raslog = This action adds an entry to the switchevent log for an individual switch. sddq = This action moves the traffic destined to a port affectedby device-based latency to a low-priorityvirtual channel. This action does not disable the port,but it reduces the effect of its latency on other flows in the fabric. un-quarantine = This actionreleases the previously quarantined ports. decommission = This action takes a port offlinewithout loss of traffic. port-toggle = This action temporarily disables a port and then re-enables it,allowing the port to reset and recover from some device-based issues. e-mail = This action sendsinformation about the event to one or more specified e-mail addresses. The e-mail alert specifiesthethreshold and describes the event, much like an error message. fms = This action MAPSsends a notification event information to the FICON management service. vtap-uninstall = Thisaction uninstalls vTAP feature if the mirrored frame count exceeds 250K IOPS and encryptionis enabled on the 16Gb/s-capable ASIC. If encryption is not enabled on the ASIC, vTAP is notuninstalled. re-balance = This action brings the port group state back to balance state. This maytake 3 or more seconds. sw-marginal = This action places the switch into a marginal operatingstate. sw-critical = = This action places the switch into a down operating state. sfp-marginal =This action places the SFP into a marginal operating state.Optional: Yes

decommission-cfgDescription: The decommission behavior (with-disable or impair). For Gen 7, the decommissionbehavior is impair. For Gen 6, the decommission behavior is with-disable.Flag: read-write


Broadcom


Type: enumerationValue: impair = The decommission behavior is to impair the link instead of a decommission anddisable (or fence if the process fails). After this action triggers, the port remains online with noroutes unless no other shortest path links exist. with-disable = The decommission behavior is todecommission the port with disable (or fence if the process fails).Optional: Yes

recipient-address-listDescription: The recipient list for email alerts.Flag: read-writeThis container contains the following leafs:recipient-address

Description: The email address (such as [email protected] or [email protected]) forrecipients of email alerts.Flag: read-writeType: stringValue: Up to 5 email addresses for recipients of email alerts. An email address can bebetween 0 and 128 alphanumeric characters.Optional: Yes

sender-addressDescription: The email address of the sender.Flag: read-writeType: stringValue: The email address of the sender. An email address can be between 0 and 128alphanumeric characters.Optional: Yes

domain-nameDescription: The domain name. Enter none to clear the name.Flag: read-writeType: stringValue: The domain name. A domain name can be between 0 and 63 alphanumeric characters.Optional: Yes

relay-ip-addressDescription: The relay IP address. Enter none to clear the IP address.Flag: read-writeType: inet:ip-addressValue: The relay IP address.Optional: Yes

quiet-timeDescription: The global quiet time. The rules in the policy are not triggered until the quiet timehas expired after the first rules notification.Flag: read-writeType: uint32Values: 0 to 720 hours.Optional: No

test-emailDescription: The test e-mail container.Flag: read-writeThis container has the following leafs:


Broadcom


subjectDescription: The subject for the e-mail alert.Flag: read-writeType: stringValue: 0 to 256 alpha characters.Optional: Yes

bodyDescription: The message for the e-mail alert.Flag: read-writeType: stringValue: 0 to 512 alpha characters.Optional: Yes

f-port-fpi-profileDescription: Enables the custom FPI profile for the F_Ports.Flag: read-writeType: maps-types:maps-policy-name-typeValues: The MAPS FPI profile name.Optional: No

e-port-fpi-profileDescription: Enable the custom FPI profile for the E_Ports.Flag: read-writeType: maps-types:maps-policy-name-typeValues: The MAPS FPI profile name.Optional: No

dashboard-ruleDescription: A list of dashboards. The dashboard enables you to view the events or rules that were triggered andthe objects on which the rules were triggered over a specified period of time. You can also clear the dashboarddata. You can view a triggered rules list for the last 7 days (in addition to the current day), and it maintainsone rule entry per day. You need the rule list to get the complete picture of switch operation. The dashboarddata provides two views of the operating state: the state since midnight and the state for the last 7 days. Forboth views, you need complete details of each rule triggered and all of the rule data. There are several logicalcategories in which to classify the rules. Each category can have a maximum of five rules per hour, and each rulecan have a maximum of five objects.Flag: read-onlyConfig: falseThis container has the following leafs:category

Description: The dashboard category. Each rule can belong to only one category.Flag: read-onlyType: maps-types:maps-dashboard-category-typeValue: port-health = The Port Health category monitors port statistics and takes action based onthe configuration thresholds and actions. You can configure thresholds per port type and apply theconfiguration to all ports of the specified type. Ports whose thresholds can be monitored include physicalports, D_Ports, E_Ports, and F_Ports. The Port Health category also monitors the physical aspectsof a small form-factor pluggable (SFP) transceiver, such as voltage, current, receive power (RXP),and transmit power (TXP) in physical ports, D_Ports, E_Ports, and F_Ports. backend-port-health =The Backend Port Health category monitors the health of backend switch ports such as CRC, link reseterrors, frame length (either too long or truncated), and ITW. extension-ge-port-health = The GigabitEthernet (GE) ports category monitors statistics for GE ports and takes action based on the configurationthresholds and actions. You can configure thresholds and apply the configuration to all ports. security-violations = The Security Violations category monitors security violations on the switch and takes


Broadcom


action based on the configuration thresholds and their actions. fabric-state-changes = The FabricState Changes category monitors areas of potential fabric-related or switch-related problems, such aszone changes, fabric segmentation, E_Port down, fabric reconfiguration, domain ID changes, and fabriclogins. fru-health = The FRU Health category enables you to define rules for field replaceable units(FRUs). extension-health = The Extension Health category enables you to define rules for Extensionhealth, including circuit state changes, circuit state utilization, and packet loss. switch-resources =The Switch Resources category monitors your system's temperature, flash usage, memory usage, andCPU. fabric-performance-impact = The Fabric Performance Impact category monitors the currentcondition of the latency detected on E_Ports and F_Ports in a fabric over different time windows, andit uses this to determine the performance impact to the fabric and network. traffic-performance = TheTraffic Performance category monitors flows.Optional: Yes

nameDescription: The rule name.Flag: read-onlyType: maps-types:maps-rule-name-typeValue: A rule name of 1 to 72 alphanumeric characters.Optional: Yes

triggered-countDescription: The number of times the rule was triggered for the category. Note that the triggered count isalways higher than the repetition count.Flag: read-onlyType: uint32Value: The number of times the rule was triggered for the category.Optional: Yes

time-stampDescription: The date and time that the rule was last triggered.Flag: read-onlyType: yang:date-and-timeValue: The date and time that the rule was last triggered.Optional: Yes

repetition-countDescription: The number of times a rule was triggered. The same rule can be triggered multiple times forthe same or different objects. For example, if the defALL_D_PORTSCRC_10 rule is triggered 20 times inan hour for different objects, then the repetition count is 20.Flag: read-onlyType: uint32Value: The number of times a rule was triggered.Optional: Yes

objectsDescription: The objects that violated the rule. The object format is as follows: <element>:<value>. Theelement can be a port, FRU, certificate, circuit, or tunnel. Each rule can have a maximum of five objects.Flag: read-onlyThis container has the following leaf:object

Description: The object that violated the rule. The object format is as follows:<element>:<value>. For example, 'F-Port 10:90' and 'U-Port 11:11'.Flag: read-onlyType: stringValue: The object that violated the rule.


Broadcom


Optional: Yesdashboard-misc

Description: The dashboard miscellaeous infomation (such as start time and operation).Flag: read-writeThis container has the following leaf:maps-start-time

Description: The MAPS start time. MAPS is restartable service which means the start time could bedifferent than system up time.Flag: read-onlyType: yang:date-and-timeConfig: falseValue: The MAPS start time.Optional: Yes

clear-dataDescription: Whether to clear the dashboard data. Note that this is a write-only leaf node and is notpresent in GET requests.Flag: read-writeType: booleanValue: true = Clears the dashboard data. false = Does not clear the dashboard data.Optional: Yes

credit-stall-dashboardDescription: The credit-stall dashboard displays the list of potentially congested ports determined by monitoringTransient Queue Latency (TQL) and credit zero statistics.Flag: read-onlyConfig: falseOptional: NoThis list has the following leafs:slot-port

Description: The slot and port information in slot/port format.Flag: read-onlyType: fibrechannel:slot-port-name-typeValues: The slot and port information in slot/port format.Optional: No

timestampDescription: The system time of the congestion data sample. The congestion data sample is availableper minute and displays from latest to oldest.Flag: read-onlyType: yang:date-and-timeValues: The system time of the congestion data sample.Optional: No

stateDescription: The port congestion credit-stall state of the sample for a given minute.Flag: read-onlyType: maps-types:credit-stall-state-typeValues: Valid values are frame-loss, perf-impact, medium, low, info, no-congestion, and monitoring-paused.Optional: No

frequencyDescription: The number of times the port is in the congestion state for a given minute.


Broadcom


Flag: read-onlyType: uint8Values: 0 to 60Optional: No

oversubscription-dashboardDescription: The oversubsription dashboard monitors port oversubscription for F_Ports, F_Port Trunks, E_Ports,E_Port Trunks, and EX_Ports.Flag: read-onlyOptional: NoThis list has the following leafs:slot-port

Description: The slot and port information in slot/port format.Flag: read-onlyType: fibrechannel:slot-port-name-typeValues: The slot and port information in slot/port format.Optional: No

timestampDescription: The system time of the congestion data sample. The congestion data sample is availableper minute and displays from latest to oldest.Flag: read-onlyType: yang:date-and-timeValues: The system time of the congestion data sample.Optional: No

stateDescription: The port congestion oversubscription state of the sample for a given minute.Flag: read-onlyType: maps-types:oversubscription-state-typeValues: Valid values are oversubscription, no-oversubscription, and monitoring-paused.Optional: No

ruleDescription: A list of rules. You can use the rules container to configure and manage MAPS monitoring rulesand to display configured rules. A rule associates a condition (threshold) with actions that are triggered when thespecified condition is reached. A rule must be in the enabled MAPS policy to be active. When you modify a rule inthe enabled MAPS policy, the rule does not take effect until you re-enable the policy.Flag: read-writeKey: nameThis list has the following leafs:name

Description: The rule name.Flag: read-writeType: maps-types:maps-rule-name-typeValue: 1 to 72 alphanumeric character rule name.Optional: Yes

is-rule-on-ruleDescription: The rule name. A rule can be one of two types: base or rule-on-rule. A base rule monitorsthe statistics or FRUs whereas a rule-on-rule monitors the base rule.Flag: read-writeType: maps-types:maps-rule-typeValue: true = It is rule-on-rule. false = It is a base rule.Mandatory: true


Broadcom


Optional: Yesmonitoring-system

Description: The statistic or error to be monitored (such as CRC, ITW, PS_STATE, and so on).Flag: read-writeType: maps-types:maps-monitoring-system-typeValue: The statistic or error to be monitored (such as CRC, ITW, PS_STATE, and so on)Mandatory: trueOptional: Yes

time-baseDescription: The time interval between two samples to be compared.Flag: read-writeType: maps-types:maps-time-base-typeValue: none = The time base is not applicable. second = The samples are compared every second.minute = The samples are compared every minute. five-minute = The samples are compared every fiveminutes. hour = The samples are compared every hour. day = The samples are compared every day.week = The samples are compared every week.Mandatory: trueOptional: Yes

logical-operatorDescription: The relational operation to be used in evaluating the condition.Flag: read-writeType: maps-types:maps-logical-operator-typeValue: l = The less than logical operator. le = The less than or equal to logical operator. g = The greaterthan logical operator. ge = The greater than or equal to logical operator. eq = The equal to logicaloperator. ne = The not equal to logical operator.Mandatory: trueOptional: Yes

threshold-valueDescription: The threshold value. Thresholds are the values at which potential problems might occur. Forexample, in configuring a port threshold, you can select a specific value at which an action is triggeredbecause of too many threshold violations.• For numerical values: 0-999999999. The upper limit may vary depending on the monitoring systemcategory.• For percentage values: 0-100.• For FRU states: ON, OFF, IN, OUT, or FAULTY.• For temperature monitoring: IN_RANGE or OUT_OF_RANGE.• For SYSTEM_TEMP: HEALTHY, MARG_OUT_OF_RANGE, CRIT_OUT_OF_RANGE.• For FPI states: IO_FRAME_LOSS, IO_PERF_IMPACT, IO_LATENCY_CLEAR.• For Ethernet port state: UP or DOWNFlag: read-writeType: maps-types:threshold-value-typeValue: The threshold value.Mandatory: trueOptional: Yes

group-nameDescription: The group name. The group name must be unique; it is not case sensitive and can containup to 32 characters.Flag: read-writeType: maps-types:maps-group-name-typeValue: The group name.Mandatory: true


Broadcom


Optional: Yesactions

Description: The MAPS actions.Flag: read-writeThis container has the following leaf:action

Description: The MAPS action.Flag: read-writeType: maps-types:maps-generic-action-typeValue:Value: port-fence = This action immediately takes ports offline, which mightcause loss of traffic.snmp-trap = This action generates a message (called a “trap”) that notifies a managementstation when specific events occur on a switch. raslog = This action adds an entry to the switchevent log for an individual switch. sddq = This action moves the traffic destined to a port affectedby device-based latency to a low-priorityvirtual channel. This action does not disable the port,but it reduces the effect of its latency on other flows in the fabric. un-quarantine = This actionreleases the previously quarantined ports. decomission = This action takes a port offline withoutloss of traffic. port-toggle = This action temporarily disables a port and then re-enables it,allowing the port to reset and recover from some device basedissues. e-mail = This action sendsinformation about the event to one or more specified e-mail addresses. The e-mail alert specifiesthethreshold and describes the event, much like an error message. f's = This action MAPS sendsa notification event information to the FICON management service. vtap-uninstall = This actionuninstalls vTAP feature if the mirrored frame count exceeds 250K IOPS and encryption is enabledon the 16Gb/s-capable ASIC. If encryption is not enabled on the ASIC, vTAP is not uninstalled.re-balance = This action brings the port group state back to balance state. This may take 3 ormore seconds. sw-marginal = This action places the switch into a marginal operating state. sw-critical = = This action places the switch into a down operating state. sfp-marginal = This actionplaces the SFP into a marginal operating state.Optional: Yes

is-predefinedDescription: Whether the group is a system-defined or user-defined group. You cannot delete system-defined groups; however, you can augment the ports managed by the group.Flag: read-onlyType: booleanConfig: falseValue: true = The group is system-defined. false = The group is user-defined.Optional: Yes

event-severityDescription: The user-configured severity (warning, error, critical, info, or default). If the value is empty,the system assigns a severity to the rule. For more information about the default severity, refer to theBrocade Fabric OS MAPS User Guide.Flag: read-writeType: maps-types:maps-event-severity-typeValue: Valid values are warning, error, critical, info, or default.Optional: Yes

toggle-timeDescription: The port's toggle time in seconds. This parameter is available only when the rule's action isport-toggle.Flag: read-writeType: uint32Value: 2 to 3600 seconds.


Broadcom


Optional: Yesquiet-time

Description: The quiet time in seconds. The rule is not triggered until the quiet time has expired. Thisparameter is not supported for the IT_FLOW monitoring system.Flag: read-writeType: uint32Value: 0|6 to 31536000 seconds. Enter 0 to clear the quiet time on the rule.Optional: Yes

quiet-time-clearDescription: This parameter is deprecated. Use the quiet-time parameter to clear quiet time by enteringa value of 0. Use to clear quiet time.

NOTEThis is a write-only leaf and does not display in a GET request.

Flag: read-writeType: booleanValue: true = Clears the quiet time from the rule. false = Does not clear the quiet time from the rule.Optional: Yes

un-quarantine-timeoutDescription: The unquarantine timeout in seconds. This parameter is available only when the rule'saction is un-quarantine.Flag: read-writeType: uint32Value: 0 to 2147483647 seconds.Optional: Yes

un-quarantine-clearDescription: Whether to clear the unquarantine timeout.

NOTEThis is a write-only leaf and does not display in a GET request.

Flag: read-writeType: booleanValue: true = Clears the unquarantine timeout from the rule. false = Does not clear the unquarantinetimeout from the rule.Optional: Yes

maps-policyDescription: The MAPS policy. This container enables you to create and manage monitoring policies. A MAPSpolicy is a set of rules that define thresholds for measures and actions to take when a threshold is triggered.When you enable a policy, all of the rules in the policy are in effect. A switch can have multiple policies.Flag: read-writeThis container has the following leafs:name

Description: The MAPS policy name. The name for the policy must be unique; it is case-sensitive andcan contain up to 32 characters.Flag: read-writeType: maps-types:maps-policy-name-typeValue: The MAPS policy name. 1 to 32 alphanumeric characters and underscores.Optional: Yes

rule-listDescription: A list of rules in the policy


Broadcom


Flag: read-writeThis container has the following leaf:rule

Description: The rule name.Flag: read-writeType: maps-types:maps-rule-name-typeValue: The MAPS rule name. 1 to 72 alphanumeric characters and underscores.Optional: Yes

is-active-policyDescription: Whether the policy is active. You can configure multiple policies; however, only one policycan be active at a time.Flag: read-writeType: booleanValue: true = This policy is active. false = This policy is not active.Optional: Yes

is-predefined-policyDescription: Whether the policy is predefined or user-defined. Fabric OS ships with 4 predefined policies- dflt_conservative_policy, dflt_aggressive_policy, dflt_moderate_policy, and dflt_base_policy.Flag: read-writeType: booleanValue: true = This policy is predefined. false = This policy is user-defined.Optional: Yes

monitoring-system-matrixDescription: A list of monitoring systems. Each monitoring system can support different time bases, actions,and thresholds. Some monitoring systems are supported only on specific systems. For example, circuit or tunnelmonitoring systems are only supported on extension platforms.Flag: read-onlyKey: monitoring-system group-typeThis list has the following leafs:monitoring-system

Description: The monitoring system name (CRC, BLADE_STATE, ITW, and so on). A 'monitoringsystem' is a value (measure or statistic) that can be monitored. For information about MAPS monitoringsystems, refer to MAPS monitoring categories in the Fabric OS Brocade MAPS User Guide.Flag: read-onlyType: maps-types:maps-monitoring-system-typeValue: The monitoring system name (CRC, BLADE_STATE, ITW, and so on).Optional: Yes

group-typeDescription: The group type.Flag: read-onlyType: maps-types:maps-group-type-typeValue:power-supply = The power supplies group type. This group manages power supplies. The system canhave multiple power supplies and can be integrated with a fan. fan = The fan group type. This groupmanages fans present in the system. The system can have multiple fans and can be integrated with thepower supplies. fc-port = The FC_Port group type. This group manages the FC_Ports. sfp = The FCSFP group type. This group manages the FC SFPs. The system can have different SFPs based on speedor vendor. blade = The blade group type. This group manages all blades such as core, CP, or switchblade. circuit = The circuit group type. This group manages circuits. A circuit is a virtual connectionbetween two extension systems. circuit-qos = The circuit QOS group type. This group manages circuits


Broadcom


QOS traffic. Each circuit can carry multiple QOS traffic. temperature-sensor = The temperature sensorgroup type. This group manages temperature sensors. flash = The flash memory group type. switch =The switch group type. chassis = The chassis group type. cpu = The CPU group type. wwn = The WWNgroup type. This group manages the WWN cards. flow = The flow group type. tunnel = The tunnel grouptype. This group manages the tunnels - A tunnel is group of circuits. tunnel-qos = The tunnel QOS grouptype. This group manages tunnels QOS. backend-port = The backend group type. This group managesthe backend ports. ge-port = The giga bit ethernet port group type. certificate = The security certificategroup type. dp = The data process group type. device-pid = The device PID group type. ethernet-port =The ethernet port group type. vtap-port = The vtap port group type. asic = The asic group type.Optional: Yes

dashboard-categoryDescription: The dashboard category of the monitoring system.Flag: read-onlyType: maps-types:maps-dashboard-category-typeValue:Value: port-health = The Port Health category monitors port statistics. backend-port-health = The FRUHealth category monitors the health of field replacable units (FRUs). extension-ge-port-health = TheGigabit Ethernet (GE) ports category monitors statistics for GE ports. security-violations = The SecurityHealth category monitors security violations on the switch. fabric-state-changes = The Fabric StateChanges category monitors areas of potential fabric related or switch related problems. FRU-health =The FRU Health category monitors field replacable units (FRUs). extension-health = The ExtensionHealth category monitors Extension health. switch-resources = The Switch Resource category monitorsyour system's temperature, flash usage, memory usage, and CPU. fabric-performance-impact = TheFabric Performance Impact category monitors the current condition of the latency detected on E_Portsand F_Ports in a fabric over different time windows and uses this to determine the performance impact tothe fabric and network traffic-performance = The Traffic Performance category monitors flows.Optional: Yes

group-typeDescription: The group type.Flag: read-onlyType: maps-types:maps-group-type-typeValue: power-supply = The power supply group type. The device may have multiple power suppliesand may be integrated with a fan. fan = The fan group type. The device may have multiple fans may beintegrated with power supplies. fc-port = The FC port group type. sfp = The FC SFP group type. Thedevice may have different SFPs based on speed or vendor. blade = The blade group type. This grouptype manages all blades including core, CP, or switch blades. circuit = The FCIP circuit group type.circuit-qos = The circuit QOS traffic group type. Note that each circuit can carry multiple QOS traffic.temperature-sensor = The temperature sensor group type. This group manages temperature sensors.flash = The flash memory group type. switch = The switch group type. chassis = The chassis grouptype. cpu = The CPU group type. wwn = The WWN card group type. flow = The flow group type. tunnel= The tunnel group type. tunnel-qos = The tunnel qos group type. backend-port = The back end grouptype. ge-port = The giga bit ethernet port group type. certificate = The security certificate group type. dp= The data process group type. device-pid = The device PID group type. ethernet-port = The Ethernetport group type. vtap-port = The vtap port group type. asic = The ASIC group type.Optional: Yes

dashboard-categoryDescription: The dashboard category of the monitoring system.Flag: read-onlyType: maps-types:maps-dashboard-category-typeValue:port-health = This category monitors port statistics and takes action based on the configurationthresholds and actions. You can configure thresholds per port type and apply the configuration to all


Broadcom


ports of the specified type. Ports whose thresholds can be monitored include physical ports, D_Ports,E_Ports, and F_Ports. The Port Health category also monitors the physical aspects of a small form-factorpluggable (SFP) transceiver, such as voltage, current, receive power (RXP), and transmit power (TXP)in physical ports, D_Ports, E_Ports, and F_Ports. backend-port-health = This category monitors thehealth of the back-end switch ports for invalid ordered sets, CRC and link reset error rates, frame length(either too long or truncated), and invalid transmission words. extension-ge-port-health = This categorymonitors statistics for GE_Ports and takes action based on the configuration thresholds and actions.You can configure thresholds and apply the configure to all ports. security-violations = This categorymonitors security violations on the switch and takes action based on the configured thresholds and theiractions. fabric-state-changes = This category monitors areas of potential fabric related or switch relatedproblems, such as zone changes, fabric segmentation, E_Port down, fabric reconfiguration, domain IDchanges, and fabric logins. fru-health = This category monitors the state (off, on, out, or faulty) of fieldreplaceable units (FRUs). extension-health = This category monitors Extension health, including circuitstate changes, circuit state utilization, and packet loss. switch-resources = This category monitors yoursystem's temperature, flash usage, memory usage, and CPU. fabric-performance-impact = Thiscategory monitors congestion related issues on all physical E_Ports and F_Ports at all times. Specifically,FPI monitors abnormal device latency and over subscription issues using the following monitoringsystems and rules. io-latency = This category monitors the flow IO performance. This includes exchangecompletion time, first response time, and so on. io-scsi-health = This category monitors the importantSCSI commands (abort, timeout, and reserve). traffic-performance = This category monitors the flows.

base-time-basesDescription: The time bases.Flag: read-onlyThis container has the following leaf:time-base

Description: A list of the supported time bases for the monitoring system.Flag: read-onlyType: maps-types:maps-time-base-typeValue: none = The time base is not applicable. second = The samples are compared everysecond. minute = The samples are compared every minute. five-minute = The samples arecompared every five minutes. hour = The samples are compared every hour. day = The samplesare compared every day. week = The samples are compared every week.Optional: Yes

rule-on-rule-time-basesDescription: The rule on rules time bases for the monitoring system. This parameter is only availablewhen the is-rule-on-rule-supported parameter is active (is-rule-on-rule-supported = true)Flag: read-onlyThis container has the following leaf:rule-on-rule-time-base

Description: A list of the supported time bases for rule on rules for the monitoring system.Flag: read-onlyType: maps-types:maps-time-base-typeValue: none = The time base is not applicable. second = The samples are compared everysecond. minute = The samples are compared every minute. five-minute = The samples arecompared every five minutes. hour = The samples are compared every hour. day = The samplesare compared every day. week = The samples are compared every week.Optional: Yes

is-read-onlyDescription: Whether the monitoring system is read only.Flag: read-onlyType: boolean


Broadcom


Value: true = The monitoring system is read only. false = The monitoring system is not read only.Optional: Yes

monitored-logical-switchDescription: Whether the monitoring system is in all logical switches or only the default logical switch.Flag: read-onlyType: enumerationValue: all-logical-switches = The monitoring system is in all logical switches. default-switch-only = Themonitoring system is only in the default logical switch.Optional: Yes

is-rule-on-rule-supportedDescription: Whether rule on rule is supported.Flag: read-onlyType: booleanValue: true = Rule on rule is supported. false = Rule on rule is not supported.Optional: Yes

is-quiet-time-supportedDescription: Whether quiet time is supported.Flag: read-onlyType: booleanValue: true = Quiet time is supported. false = Quiet time is not supported.Optional: Yes

minimum-quiet-timeDescription: The minimum quiet time in seconds. This parameter is available only when quiet time issupported (is-quiet-time-supported = true).Flag: read-onlyType: uint32Value: 6 to 31536000 seconds.Optional: Yes

monitoring-typeDescription: The monitoring type (event based or poll based) for the monitoring system.Flag: read-onlyType: maps-types:monitoring-type-typeValue: event-based = Event based monitoring. poll-based = Poll based monitoring.Optional: Yes

data-typeDescription: The data type support. Each monitoring system supports different data types for thresholds.Flag: read-onlyType: maps-types:data-type-typeValue: unsigned-int32 = The unsigned integer 32 bits data type. int32 = The integer 32 bits data type.float = The float data type unsigned-int64 = The unsigned int 64 bits data type. enum = The enums datatype.Optional: Yes

descriptionDescription: A description of the monitoring system.Flag: read-onlyType: stringValue: A 1 to 128 character description of the monitoring system.Optional: Yes


Broadcom


actionsDescription: The global MAPS actions list.Flag: read-onlyThis container has the following leafs:action

Description: A list of the MAPS actions defined for this monitoring system.Flag: read-onlyType: maps-types:maps-generic-action-typeValue: port-fence = The port fence action immediately takes ports offline, which mightcauseloss of traffic. snmp-trap = This action generates a message (called a “trap”) that notifies amanagement station when specific events occur on a switch. raslog = This action adds an entryto the switch event log for an individual switch. sddq = This action moves the traffic destined to aport affected by device-based latency to a low-priorityvirtual channel. This action does not disablethe port, but it reduces the effect of its latency on other flows in the fabric. un-quarantine = Thisaction releases the previously quarantined ports. decomission = This action takes a port offlinewithout loss of traffic. port-toggle = This action temporarily disables a port and then re-enables it,allowing the port to reset and recover from some device basedissues. e-mail = This action sendsinformation about the event to one or more specified e-mail addresses. The e-mail alert specifiesthethreshold and describes the event, much like an error message. f's = This action MAPS sendsa notification event information to the FICON management service. vtap-uninstall = This actionuninstalls vTAP feature if the mirrored frame count exceeds 250K IOPS and encryption is enabledon the 16Gb/s-capable ASIC. If encryption is not enabled on the ASIC, vTAP is not uninstalled.re-balance = This action brings the port group state back to balance state. This may take 3 ormore seconds. sw-marginal = This action places the switch into a marginal operating state. sw-critical = = This action places the switch into a down operating state. sfp-marginal = This actionplaces the SFP into a marginal operating state.Optional: Yes

unitDescription: The data unit of the monitoring system.Flag: read-onlyType: maps-types:maps-data-unitValue: CRCs, ITWs, timeouts, milli-ampere, days, errors, loss-of-signals, loss-of-synchronizations,violations, ports, extension-flows, it-flows, certificates, segmentations, changes, logins, IOs,IOPS, MBps, %, hours, centigrade, bytes, micro-seconds, milli-seconds, milli-volts, milli-amps, andmicro-wattsOptional: Yes

data-rangeDescription: The data range of the monitoring system.Flag: read-onlyType: stringValue: 1 to 100 alphanumeric characters plus hyphens, commas, and underscore characters.Optional: Yes

logical-operatorsDescription: The supported operations.Flag: read-onlyThis container has the following leaf:logical-operator

Description: The relational operation to be used in evaluating the condition.Flag: read-onlyType: maps-types:maps-logical-operator-type


Broadcom


Value: l = The less than logical operator. le = The less than or equal to logical operator. g = Thegreater than logical operator. ge = The greater than or equal to logical operator. eq = The equal tological operator. ne = The not equal to logical operator.Optional: Yes

fpi-profileDescription: The Fabric Performance Impact (FPI) profile. This container enables you to create and manageFPI monitoring thresholds. The FPI Profile is a set of FPI monitoring states (performance impact, frame loss, andoversubscribed) and the thresholds (transmit queue latency (TXQL) and credit-zero) for each state. The FPI rulesin the MAPS policy obtains the thresholds for each state from the active FPI profile. The FPI profile is per logicalswitch.Flag: read-writeKey: nameOptional: NoThis list has the following leafs:name

Description: The FPI profile name.Flag: read-writeType: maps-types:maps-policy-name-typeValues: The FPI profile name.Optional: No

predefined-profileDescription: Whether the profile is predefined or user-defined. Fabric OS ships with 1 predefined profile(dflt_fpi_profile).Flag: read-onlyType: booleanConfig: falseValues: true = This profile is predefined. false = This profile is user-defined.Optional: No

performance-impactDescription: The performance impact FPI state is due to a TXQL or credit-zero stats violation.Flag: read-writeOptional: Notransmit-queue-latency

Description: The TXQL threshold.Flag: read-writeType: uint32Values: 1 to 50 milliseconds.Mandatory: TrueOptional: No

credit-zero-percentage-1-secDescription: The credit-zero buffer stats threshold percentage in 1-second.Flag: read-writeType: uint32Config: falseValues: 50 to 100 %.Mandatory: TrueOptional: No

credit-zero-percentage-5-secDescription: The credit-zero buffer stats threshold percentage in 5 seconds.Flag: read-write


Broadcom


Type: uint32Config: falseValues: 30 to 100 %.Mandatory: TrueOptional: No

credit-zero-percentage-10-secDescription: The credit-zero buffer stats threshold percentage in 10 seconds.Flag: read-writeType: uint32Config: falseValues: 10 to 100 %.Mandatory: TrueOptional: No

frame-lossDescription: The frame loss FPI state is due to frame transmit timeout or high TXQL that could possiblylead to a frame drop condition.Flag: read-writeOptional: NoThis container has the following leafs:transmit-queue-latency

Description: The Transmit Queue Latency(TXQL) threshold in milliseconds.Flag: read-writeType: uint32Values: 50 to 100 milliseconds.Mandatory: TrueOptional: No

port-oversubscriptionDescription: The port-oversubscription FPI state is due to high TXQL than regular traffic condition andmore than 98% TX utilization.Flag: read-onlyOptional: Notransmit-percentage

Description: The transmit (TX) utilization percentage.Flag: read-onlyType: uint32Values: 98 to 100 %.Optional: No

dashboard-historyDescription: The historical data of various counters.Flag: read-onlyConfig : falseOptional: NoThis list has the following leafs:category

Description: A logical grouping of the counters.Flag: read-onlyType: stringValues: A logical grouping of the counters.Optional: No


Broadcom


dateDescription: The date when the counters' data was cached.Flag: read-onlyType: stringValues: The date when the counters' data was cached.Optional: No

crc-errorsDescription: The group of ports on which the CRC (Cyclic Redundancy Check) errors were detected.The list of ports is sorted based on the number of errors detected on the ports.Flag: read-onlyOptional: NoThis container has the following leaf:port-data

Description: A list of ports where the error was detected.Flag: read-onlyType: stringValues: The list of ports sorted based on the number of errors detected on the ports.Optional: No

itw-errorsDescription: The group of ports on which the ITW (Invalid Transmit Words) errors were detected. The listof ports is sorted based on the number of errors detected on the ports.Flag: read-onlyOptional: NoThis container has the following leaf:port-data


port-lossDescription: This parameter is deprecated. Use the loss-of-sync parameter instead. The group of portson which the port loss errors were detected. The list of ports is sorted based on number of errors detectedon the ports.Flag: read-onlyOptional: NoThis container has the following leaf:port-data

Description: A list of ports where the error was detected.Flag: read-onlyType: stringValues: The list of ports is sorted based on the number of errors detected on the ports.Optional: No

loss-of-syncDescription: The group of ports on which the Loss of Sync errors were detected. The list of ports issorted based on number of errors detected on the ports.Flag: read-onlyOptional: NoThis container has the following leaf:


Broadcom


port-dataDescription: A list of ports where the error was detected.Flag: read-onlyType: stringValues: The list of ports is sorted based on the number of errors detected on the ports.Optional: No

link-failureDescription: The group of ports on which the Link Failure errors were detected. The list of ports is sortedbased on the number of errors detected on the ports.Flag: read-onlyOptional: NoThis container has the following leaf:port-data


signal-lossDescription: The group of ports on which the Signal Loss errors were detected. The list of ports is sortedbased on the number of errors detected on the ports.Flag: read-onlyOptional: NoThis container has the following leaf:port-data


protocol-errorsDescription: The group of ports on which the Protocol Errors were detected. The list of ports is sortedbased on the number of errors detected on the ports.Flag: read-onlyOptional: NoThis container has the following leaf:port-data


state-changeDescription: The group of ports on which state changes were detected. The list of ports is sorted basedon the number of state changes detected on the ports.Flag: read-onlyOptional: NoThis container has the following leaf:


Broadcom


port-dataDescription: A list of ports where the error was detected.Flag: read-onlyType: stringValues: The list of ports sorted based on the number of errors detected on the ports.Optional: No

link-resetDescription: The group of ports on which the Link Resets were detected. The list of ports is sorted basedon the number of link resets detected on the ports.Flag: read-onlyOptional: NoThis container has the following leaf:port-data


c3-tx-toDescription: The group of ports on which the Class-3 frame time-outs were detected. The list of ports issorted based on the number of frames that timed-out on the ports.Flag: read-onlyOptional: NoThis container has the following leaf:port-data

Description: A list of ports where the error was detected.Flag: read-onlyType: stringValues: A list of ports sorted based on the number of errors detected on the ports.Optional: No

rx-perfDescription: A list of ports sorted based on percentage of RX bandwidth used on the port.Flag: read-onlyOptional: NoThis container has the following leaf:port-data


tx-perfDescription: A list of ports sorted based on percentage of TX bandwidth used on the port.Flag: read-onlyOptional: NoThis container has the following leaf:port-data

Description: A list of ports where the error was detected.Flag: read-only


Broadcom


Type: stringValues: The list of ports sorted based on the number of errors detected on the ports.Optional: No

utilizationDescription: A list of ports sorted based on percentage of total bandwidth (RX + TX) used on the port.Flag: read-onlyOptional: NoThis container has the following leaf:port-data


Supported Methods

Only the OPTIONS, HEAD. GET, DELETE, PATCH, and POST operations are supported in this module.

History



Fabric OS 9.0.0 This API call was modified to add the marginal-sfp-health, trusted-fos-certificate-health, quiet-time, f-port-fpi-profile, and e-port-fpi-profile parameters; added the credit-stall-dashboard, oversubscription-dashboard, fpi-profile, and dashboard-history lists.

Fabric OS 9.0.1 This API call was modified to add the loss-of-sync container to the dashboard-history list;edit the member, recipient-address-list, sender-address, domain-name, event-severity,quiet-time, minimum-quiet-time, group-feature, dashboard rule, and triggered-countparameter. The port-loss parameter is deprecated. Use the loss-of-sync parameter instead.


Broadcom


brocade-maps ExamplesThis section provides examples for the brocade-maps module.

It assumes a knowledge of Monitoring and Alerting Policy Suite as performed in Fabric OS. For information on that topic,refer to the Brocade Monitoring and Alerting Policy Suite Configuration Guide.

Viewing the Switch Status Policy Report

The following example uses the GET request to display the Switch Status Policy report.

StructureGET <base_URI>/running/brocade-maps/switch-status-policy-reportURIGET https://10.10.10.10/rest/running/brocade-maps/switch-status-policy-report



<Response>

<switch-status-policy-report>

<switch-health>healthy</switch-health>

<power-supply-health>healthy</power-supply-health>

<fan-health>healthy</fan-health>

<wwn-health>healthy</wwn-health>

<temperature-sensor-health>healthy</temperature-sensor-health>

<ha-health>healthy</ha-health>

<control-processor-health>healthy</control-processor-health>

<core-blade-health>healthy</core-blade-health>

<blade-health>healthy</blade-health>

<flash-health>healthy</flash-health>

<marginal-port-health>healthy</marginal-port-health>

<faulty-port-health>healthy</faulty-port-health>

<missing-sfp-health>healthy</missing-sfp-health>

<error-port-health>healthy</error-port-health>

<expired-certificate-health>healthy</expired-certificate-health>

<airflow-mismatch-health>healthy</airflow-mismatch-health>

<marginal-sfp-health>healthy</marginal-sfp-health>

<trusted-fos-cert-health>healthy</trusted-fos-cert-health>

</switch-status-policy-report>

</Response>

Viewing System Resources

The following example uses the GET request to display the system resources .

StructureGET <base_URI>/running/brocade-maps/system-resources


Broadcom


URIGET https://10.10.10.10/rest/running/brocade-maps/system-resources



<Response>

<system-resources>

<cpu-usage>2</cpu-usage>

<memory-usage>8</memory-usage>

<total-memory>15003372</total-memory>

<flash-usage>13</flash-usage>

</system-resources>

</Response>

Viewing the Paused Configuration

The following example uses the GET request to display the current paused configurations. To display a specific pausedconfiguration, specify the group name in the request.

For example, the following shows specifying the group name (fc-port) in the request:

GET https://10.10.10.10/rest/running/brocade-maps/paused-cfg/group-type/fc-port

StructureGET <base_URI>/running/brocade-maps/paused-cfgURIGET https://10.10.10.10/rest/running/brocade-maps/paused-cfg



<Response>

<paused-cfg>

<group-type>fc-port</group-type>

<members>

<member>8/9</member>






</members>


Broadcom


</paused-cfg>

</Response>

Pausing MAPS Monitoring

The following example uses the POST request to pause MAPS monitoring port 8/9, 8/17, 8/18 and 6/23 in the f-portsgroup.

StructurePOST <base_URI>/running/brocade-maps/paused-cfg/URIPOST https://10.10.10.10/rest/running/brocade-maps/paused-cfg/

Request Body

<paused-cfg>


<members>





</members>

</paused-cfg>

Response BodyWhen the operation is successful, the response has an empty message body and a “201 Created” statusmessage.

Resuming MAPS Monitoring

The following example uses the DELETE request to resume MAPS monitoring port 8/17, 8/18 and 6/23 in the f-portsgroup by deleting them from the paused configuration.

StructureDELETE <base_URI>/running/brocade-maps/paused-cfg/URIDELETE https://10.10.10.10/rest/running/brocade-maps/paused-cfg/

Request Body

<paused-cfg>


<members>




</members>

</paused-cfg>


Broadcom



Viewing MAPS Groups

The following example uses the GET request to display the configured MAPS groups.

StructureGET <base_URI>/running/brocade-maps/groupURIGET https://10.10.10.10/rest/running/brocade-maps/group



<Response>

<group>

<name>ALL_PORTS</name>


<members>








.

.

.

<group>

<name>ALL_FCOE_100G_SR4_QSFP</name>

<group-type>sfp</group-type>

<members>

<member/>

</members>

<is-predefined>true</is-predefined>

<is-augmentable>false</is-augmentable>

</group>

<group>

<name>ALL_OTHER_F_PORTS_1</name>


<members>


</members>

<is-predefined>false</is-predefined>


Broadcom


<is-augmentable>false</is-augmentable>

</group>

</Response>

Configuring a New MAPS Group

The following example uses the POST request to configure a new group ALL_OTHER_F_PORTS_1 with one port 5/8.

StructurePOST <base_URI>/running/brocade-maps/groupURIPOST https://10.10.10.10/rest/running/brocade-maps/group

Request Body

<group>

<name>ALL_OTHER_F_PORTS_1</name>


<members>


</members>

</group>


Modifying an Existing MAPS Group

The following example uses the PATCH request to modify an existing group ALL_FCOE_100G_SR4_QSFP with two ports5/8 and 5/17.

StructurePATCH <base_URI>/running/brocade-maps/groupURIPATCH https://10.10.10.10/rest/running/brocade-maps/group

Request Body

<group>

<name>ALL_FCOE_100G_SR4_QSFP</name>

<group-type>sfp</group-type>

<members>



</members>

</group>



Broadcom


Viewing the MAPS Configuration

The following example uses the GET request to display the current MAPS configuration.

StructureGET <base_URI>/running/brocade-maps/maps-configURIGET https://10.10.10.10/rest/running/brocade-maps/maps-config



<Response>

<maps-config>

<recipient-address-list>

<recipient-address>[email protected]</recipient-address>

</recipient-address-list>

<relay-ip-address/>

<quiet-time/>

<domain-name/>

<actions>

<action>raslog</action>

<action>e-mail</action>

<action>sw-critical</action>

<action>sw-marginal</action>

</actions>

<sender-address>[email protected]</sender-address>

<decommission-cfg>impair</decommission-cfg>

<f-port-fpi-profile/>

<e-port-fpi-profile/>

</maps-config>

</Response>

Changing the MAPS Configuration

The following example uses the PATCH request to edit the current MAPS configuration by adding an e-mail recipient'[email protected]' and configuring the quiet time to 2 hours and the F_Port FPI profile name to new-fport-fpi.

StructurePATCH <base_URI>/running/brocade-maps/maps-configURIPATCH https://10.10.10.10/rest/running/brocade-maps/maps-config

Request Body

<maps-config>

<recipient-address-list>


Broadcom




</recipient-address-list>

<quiet-time>2</quiet-time>

<actions>



<action>sw-critical</action>

<action>sw-marginal</action>

</actions>

<sender-address>[email protected]</sender-address>

<decommission-cfg>impair</decommission-cfg>

<f-port-fpi-profile>new-fport-fpi</f-port-fpi-profile>

</maps-config>


Viewing the MAPS Dashboard

The following example uses the GET request to display the MAPS dashboard for Virtual Fabric ID 77.

Note that a dashboard rule captures only the top five threshold violations (objects).

StructureGET <base_URI>/running/brocade-maps/dashboard-rule?vf-id=<VF_ID>URIGET https://10.10.10.10/rest/running/brocade-maps/dashboard-rule?vf-id=77



<Response>

<dashboard-rule>

<category>port-health</category>

<triggered-count>10</triggered-count>

<name>defALL_16GSWL_SFPCURRENT_2</name>


<repetition-count>2</repetition-count>

<objects>

<object>SFP 1:0</object>


</objects>

</dashboard-rule>

<dashboard-rule>




Broadcom


<name>defALL_32GSWL_SFPTXP_251</name>



<objects>






</objects>

</dashboard-rule>

<dashboard-rule>



<name>defALL_32GSWL_SFPCURRENT_1</name>



<objects>






</objects>

</dashboard-rule>

<dashboard-rule>

<category>fabric-state-changes</category>


<name>defSWITCHFLOGI_4</name>



<objects>

<object>Switch:11</object>





</objects>

</dashboard-rule>

</Response>

The response body contains the same content that you would see in the Rules Affecting Health section ofthe MAPS dashboard generated from the CLI (see below).

switch:admin> mapsdb --show

1 Dashboard Information:

=======================

DB start time: Mon May 18 22:17:15 2020

Active policy: dflt_aggressive_policy

Configured Notifications: SW_CRITICAL,SW_MARGINAL,SFP_MARGINAL,FPIN

Fenced Ports : None


Broadcom


| | | |SFP 22 |0 mAmps

|

| | | |SFP 17 |0 mAmps

|

| | | |SFP 22 |0 mAmps

|

Fabric State Changes(5) |5 |defSWITCHFLOGI_4 |05/18/20 22:31:30 |Switch |11 Logins

|

| | | |Switch |5 Logins

|


|


|


|

Viewing MAPS Dashboard Settings

The following example uses the GET request to display the date and time that monitoring began with MAPS.

StructureGET <base_URI>/running/brocade-maps/dashboard-miscURIGET https://10.10.10.10/rest/running/brocade-maps/dashboard-misc



<Response>

<dashboard-misc>

<maps-start-time>Wed Jun 27 07:35:06 2018</maps-start-time>

</dashboard-misc>

</Response>

Clearing the MAPS Dashboard Data

The following example uses the PATCH request to clear the dashboard data for MAPS.

StructurePATCH <base_URI>/running/brocade-maps/dashboard-misc/clear-data/trueURIPATCH https://10.10.10.10/rest/running/brocade-maps/dashboard-misc/clear-data/true


Broadcom



Viewing MAPS Rules

The following example uses the GET request to display the configured MAPS rules. To display a specific MAPS rule,specify the rule name in the request.

For example, the following provides specifying the rule name (defALL_100G_QSFPCURRENT_10) in the request:

GET https://10.10.10.10/rest/running/brocade-maps/rule/name/defALL_100G_QSFPCURRENT_10

StructureGET <base_URI>/running/brocade-maps/ruleURIGET https://10.10.10.10/rest/running/brocade-maps/rule



<Response>

<rule>

<name>defALL_100G_QSFPCURRENT_10</name>

<is-rule-on-rule>false</is-rule-on-rule>

<monitoring-system>CURRENT</monitoring-system>

<time-base>NONE</time-base>

<logical-operator>ge</logical-operator>

<threshold-value>10</threshold-value>

<group-name>ALL_FCOE_100G_SR4_QSFP</group-name>

<actions>


<action>snmp-trap</action>


<action>sfp-marginal</action>

</actions>

<is-predefined>true</is-predefined>

</rule>

.

.

.

<rule>

<name>ALL_PORTS_IO_FRAME_LOSS_UNQUARtest</name>



Broadcom


<monitoring-system>DEV_LATENCY_IMPACT</monitoring-system>

<time-base>NONE</time-base>

<logical-operator>eq</logical-operator>

<threshold-value>IO_FRAME_LOSS</threshold-value>

<group-name>ALL_PORTS</group-name>

<actions>




<action>port-toggle</action>

<action>un-quarantine</action>

<action>sddq</action>

</actions>

<is-predefined>false</is-predefined>

<toggle-time>2</toggle-time>


<un-quarantine-timeout>1</un-quarantine-timeout>

</rule>

</Response>

Configuring a MAPS Rule

The following example uses the POST request to create new MAPS rule BaseRule_statechanges12.

StructurePOST <base_URI>/running/brocade-maps/ruleURIPOST https://10.10.10.10/rest/running/brocade-maps/rule

Request Body

<rule>

<name>BaseRule_statechanges12</name>


<monitoring-system>STATE_CHG</monitoring-system>

<time-base>min</time-base>

<logical-operator>g</logical-operator>


<group-name>ALL_F_PORTS</group-name>

<actions>




</actions>


<event-severity>WARNING</event-severity>

</rule>



Broadcom


Manually Clearing Quiet Time

The following example uses the PATCH request to manually clear quiet time for RASlog and e-mail alerts.

StructurePATCH <base_URI>/running/brocade-maps/rule/name/rule_name/quiet-time/0URI

PATCH https://10.10.10.10/rest/running/brocade-maps/rule/name/BaseRule_statechanges12/quiet-time/0


Manually Clearing Quarantined Ports

The following example uses the PATCH request to manually clear quarantined ports.

StructurePATCH <base_URI>/running/brocade-maps/rule/name/rule_name/un-quarantine-clear/true|falseURI

PATCH https://10.10.10.10/rest/running/brocade-maps/rule/name/BaseRule_statechanges12/un-

quarantine-clear/true


Viewing MAPS Policies

The following example uses the GET request to display the MAPS policy configurations. To display a specific MAPSpolicy, specify the policy name in the request.

For example, the following provides specifying the rule name URI structure and URI:

GET <base_URI>/running/brocade-maps/maps-policy/name/policy_name.GET https://10.10.10.10/rest/running/brocade-maps/maps-policy/name/defALL_100G_QSFPCURRENT_10

StructureGET <base_URI>/running/brocade-maps/maps-policyURIGET https://10.10.10.10/rest/running/brocade-maps/maps-policy



Broadcom



<Response>

<maps-policy>

<name>dflt_aggressive_policy</name>

<rule-list>

<rule>defALL_100G_QSFPCURRENT_10</rule>


<rule>defALL_100G_QSFPRXP_2187</rule>


<rule>defALL_100G_QSFPSFP_TEMP_75</rule>

<rule>defALL_100G_QSFPSFP_TEMP_n5</rule>

<rule>defALL_100G_QSFPTXP_3467</rule>

<rule>defALL_100G_QSFPTXP_48</rule>

<rule>defALL_100G_QSFPVOLTAGE_2970</rule>

<rule>defALL_100G_QSFPVOLTAGE_3630</rule>

.

.

.

<rule>defSWITCHSEC_TS_D2</rule>

<rule>defSWITCHSEC_TS_H1</rule>

<rule>defSWITCHZONE_CFGSZ_PER_70</rule>

<rule>defSWITCHZONE_CHG_2</rule>

</rule-list>

<is-predefined-policy>false</is-predefined-policy>

<is-active-policy>false</is-active-policy>

</maps-policy>

</Response>

Response BodyWhen the operation is successful, the response has an empty message body and a “200 OK” status message.

Configuring a MAPS Policy

The following example uses the POST request to create a new MAPS policy test_aggressive_policy. You can use aPATCH request to edit an existing policy.

StructurePOST <base_URI>/running/brocade-maps/maps-policyURIPOST https://10.10.10.10/rest/running/brocade-maps/maps-policy

Request Body

<maps-policy>

<name>test_aggressive_policy</name>

<rule-list>




<rule>defSWITCHZONE_CHG_2</rule>

</rule-list>

</maps-policy>


Broadcom



Activating a MAPS Policy

The following example uses the PATCH request to activate a MAPS policy test_aggressive_policy.

StructurePATCH <base_URI>/running/brocade-maps/maps-policy/name/policy_name/is-active-policy/trueURI

PATCH https://10.10.10.10/rest/running/brocade-maps/maps-policy/name/test_aggressive_policy/is-

active-policy/true


Viewing the MAPS Monitoring System Matrix

The following example uses the GET request to display the MAPS monitoring system matrix.

StructureGET <base_URI>/running/brocade-maps/monitoring-system-matrixURIGET https://10.10.10.10/rest/running/brocade-maps/monitoring-system-matrix



<Response>

<monitoring-system-matrix>

<monitoring-system>CRC</monitoring-system>

<data-type>unsigned-int32</data-type>

<data-range>0-999999999</data-range>


<dashboard-category>Port</dashboard-category>

<description>CRC errors (CRC)</description>

<unit>CRCs</unit>

<base-time-bases>

<time-base>min</time-base>

<time-base>hour</time-base>

<time-base>day</time-base>


Broadcom


</base-time-bases>

<actions>




<action>port-fence</action>

<action>decomission</action>

<action>fms</action>

</actions>

<is-quiet-time-supported>true</is-quiet-time-supported>

<is-rule-on-rule-supported>true</is-rule-on-rule-supported>

<rule-on-rule-time-bases>

<rule-on-rule-time-base>hour</rule-on-rule-time-base>

<rule-on-rule-time-base>day</rule-on-rule-time-base>

<rule-on-rule-time-base>week</rule-on-rule-time-base>

</rule-on-rule-time-bases>

<monitoring-type>poll-based</monitoring-type>

<monitored-logical-switch>all-logical-switches</monitored-logical-switch>

<logical-operators>


<logical-operator>ge</logical-operator>

</logical-operators>

<minimum-quiet-time>60</minimum-quiet-time>

<is-read-only>false</is-read-only>

</monitoring-system-matrix>

.

.

.

<monitoring-system-matrix>

<monitoring-system>DEV_LOGIN_DIST</monitoring-system>

<data-type>enum</data-type>

<data-range>BALANCED,IMBALANCED,BALANCE_FAILED</data-range>


<dashboard-category>Fabric Performance</dashboard-category>

<description>Device logins distribution (DEV_LOGIN_DIST)</description>

<unit/>

<base-time-bases>

<time-base>none</time-base>

</base-time-bases>

<actions>




<action>port-fence</action>

<action>decomission</action>

<action>fms</action>

<action>re-balance</action>

</actions>

<is-quiet-time-supported>true</is-quiet-time-supported>

<is-rule-on-rule-supported>true</is-rule-on-rule-supported>

<rule-on-rule-time-bases>

<rule-on-rule-time-base>hour</rule-on-rule-time-base>

<rule-on-rule-time-base>day</rule-on-rule-time-base>


Broadcom


<rule-on-rule-time-base>week</rule-on-rule-time-base>

</rule-on-rule-time-bases>

<monitoring-type>event-based</monitoring-type>

<monitored-logical-switch>all-logical-switches</monitored-logical-switch>

<logical-operators>

<logical-operator>eq</logical-operator>

</logical-operators>

<minimum-quiet-time>60</minimum-quiet-time>

<is-read-only>false</is-read-only>

</monitoring-system-matrix>

</Response>

Viewing the Credit Stall Dashboard

This example uses a GET request to display the Credit Stall dashboard.

Structure

GET base_URI/running/brocade-maps/credit-stall-dashboard

URI

GET https://10.10.10.10/rest/running/brocade-maps/credit-stall-dashboard

Request Body


Response Body


<Response>

<credit-stall-dashboard>


<timestamp>2020-02-26T15:20:00-07:00</timestamp>

<state>no-congestion</state>

<frequency>0</frequency>

</credit-stall-dashboard>







...













Broadcom



</Response>

Viewing the Oversubscription Dashboard

This example uses a GET request to display the Oversubscription dashboard.

Structure

GET base_URI/running/brocade-maps/oversubscription-dashboard

URI

GET https://10.10.10.10/rest/running/brocade-maps/oversubscription-dashboard

Request Body


Response Body


<Response>

<oversubscription-dashboard>



<state>no-oversubscription</state>

</oversubscription-dashboard>






...











</Response>

Viewing the Dashboard History

This example uses a GET request to display the dashboard history.

Structure

GET base_URI/running/brocade-maps/dashboard-history

URI


Broadcom


GET https://10.10.10.10/rest/running/brocade-maps/dashboard-history

Request Body


Response Body


<Response>

<dashboard-history>

<category>fc-port</category>

<date>current</date>

<crc-errors/>

<itw-errors/>

<port-loss/>

<loss-of-sync/>

<link-failure>

<port-data>8/56:7</port-data>



</link-failure>

<signal-loss>




</signal-loss>

<protocol-errors/>

<state-change>



...



</state-change>

<link-reset>



...



</link-reset>

<c3-tx-to/>

<rx-perf>

<port-data>7/42:4.49</port-data>



</rx-perf>

<tx-perf>




</tx-perf>

<utilization>



Broadcom




</utilization>

</dashboard-history>

...

</Response>

Configuring an FPI Profile

This example uses a PATCH request to configure an FPI profile.

Structure

PATCH base_URI/running/brocade-maps/fpi-profile/name/[name]

URI

PATCH https://10.10.10.10/rest/running/brocade-maps/fpi-profile/name/new_fpi_profile

Request Body

<fpi-profile>

<name>new_fpi_profile</name>

<performance-impact>

<transmit-queue-latency>10</transmit-queue-latency>

<credit-zero-percentage-1-sec>70</credit-zero-percentage-1-sec>



</performance-impact>

<frame-loss>

<transmit-queue-latency>80</transmit-queue-latency>

</frame-loss>

</fpi-profile>

Response Body

When the resource is successfully deleted, the response contains an empty message body and a "204 No Content" statusin the first line of the headers.


Broadcom


brocade-mediaThis module provides a detailed summary of the Small Form-factor Pluggable (SFP) transceivers media data forall available ports. For each SFP, the summary includes information that describes the SFP capabilities, interfaces,manufacturer, and other information. Refer to the Module Tree below for a complete list of parameters included in the SFPsummary..

Module Tree

This is the tree view of the module from the brocade-media.yang-tree.txt file. See YANG Module Overview forYANG node field definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-media

+--ro brocade-media

+--ro media-rdp* [name]

+--ro name interface-type

+--ro identifier? string

+--ro connector? string

+--ro media-speed-capability

| +--ro speed* capable-speed-type

+--ro media-distance

| +--ro distance* string

+--ro encoding? string

+--ro vendor-oui? string

+--ro part-number? fru:part-number-type

+--ro serial-number? fru:serial-number-type

+--ro vendor-name? vendor-name-type

+--ro vendor-revision? vendor-revision-type

+--ro date-code? date-code-type

+--ro temperature? temperature-type

+--ro rx-power? media-power-type

+--ro tx-power? media-power-type

+--ro current? current-type

+--ro voltage? voltage-type

+--ro wavelength? uint32

+--ro power-on-time? int32

+--ro peer-data-available? boolean

+--ro remote-identifier? string

+--ro remote-laser-type? string

+--ro remote-media-speed-capability

| +--ro speed* capable-speed-type

+--ro remote-optical-product-data



| +--ro vendor-name? vendor-name-type

| +--ro vendor-revision? vendor-revision-type

| +--ro date-code? date-code-type

+--ro remote-media-temperature? temperature-type

+--ro remote-media-rx-power? media-power-type

+--ro remote-media-tx-power? media-power-type

+--ro remote-media-current? current-type

+--ro remote-media-voltage? voltage-type

+--ro remote-media-voltage-alert


Broadcom


| +--ro high-alarm? alert-type

| +--ro low-alarm? alert-type

| +--ro high-warning? alert-type

| +--ro low-warning? alert-type

+--ro remote-media-temperature-alert





+--ro remote-media-tx-bias-alert





+--ro remote-media-tx-power-alert





+--ro remote-media-rx-power-alert

+--ro high-alarm? alert-type

+--ro low-alarm? alert-type

+--ro high-warning? alert-type

+--ro low-warning? alert-type

URI format


• <base_URI>/running/brocade-media/media-rdp followed by the leafs as listed in the module tree to display asummary of the SFP media data for all available ports.

• <base_URI>/running/brocade-media/media-rdp/name/ followed by the leafs as listed in the module tree todisplay media data for a specific SFP.

Parametersbrocade-media

Description: Provides SFP media details for the switch port and remote port.Flag: read-onlyConfig: falseThis container has the following leafs:media-rdp

Description: A list of switch port and peer port details. Displays SFP transceiver information. These SFPparameters provide extended information that describes the SFP capabilities, interfaces, manufacturer,and so on.Key: nameFlag: read-onlyThis container has the following leafs:


Broadcom


nameDescription: The name of the SFP interface in the format interface-id/slot/port. The interface IDsinclude fc, ge, and te.Flag: read-onlyType: interface-typeValue: 6 to 16 alphanumeric characters in the format interface-id/slot/port.Optional: Yes

identifierDescription: The type of serial transceiver inserted in the port module.Flag: read-onlyType: stringValue: 1 to 32 alphanumeric characters. Options include SFP, XFP, QSFP, QSFP+, QSFP28,GBIC, and on-board.Optional: Yes

connectorDescription: The type of connector.Flag: read-onlyType: stringValue: Valid values include SC, style-1 copper, style-2 copper, BNC/TNC, coaxial, fiberjack,LC, MT-RJ, MU, SG, optical pigtail, MPO parallel optic, HSSDC II, and copper pigtail.Optional: Yes

media-speed-capabilityDescription: A list of capable speeds supported by the media.Flag: read-onlyThis container contains the following leaf:speed

Description: The supported transmission speeds of the media in Gb/s.Flag: read-onlyType: capable-speed-typeValue: 1 to 1000 Gb/s.Optional: Yes

media-distanceDescription: A list of distances supported by the media.Flag: read-onlyThis container contains the following leaf:distance

Description: The distance supported by the media transceiver.Flag: read-onlyType: stringValue: Valid values include intermediate, long, short, extended, extended short,extended intermediate, extended long, and unknown.Optional: Yes

encodingDescription: The serial encoding algorithm used in transmitting data on Fibre Channel andGigabit Ethernet. Encoding supports continuous transmission with a balanced number of onesand zeros in the code stream, and it detects single-bit transmission errors.Flag: read-onlyType: stringValue: Valid values include 8B10B and 64B66B.Optional: Yes


Broadcom


vendor-ouiDescription: The vendor IEEE company ID for the media. An organizationally unique identifier(OUI) is a 24-bit number that uniquely identifies a vendor, manufacturer, or other organization.Flag: read-onlyType: stringValue: 1 to 8 characters.Optional: Yes

part-numberDescription: The part number assigned by the organization responsible for producing ormanufacturing the media.Flag: read-onlyType: fru:part-number-typeValue: The part number assigned by the organization responsible for producing or manufacturingthe media.Optional: Yes

serial-numberDescription: The factory's serial number for the blade.Flag: read-onlyType: fru:serial-number-typeValue: The factory's serial number for the blade.Optional: Yes

vendor-nameDescription: The vendor number of the media.Flag: read-onlyType: vendor-name-typeValue: The vendor number of the media.Optional: Yes

vendor-revisionDescription: The vendor revision number of the media.Flag: read-onlyType: vendor-revision-typeValue: The vendor revision number of the media.Optional: Yes

date-codeDescription: The vendor's manufacturing date code.Flag: read-onlyType: date-code-typeValue: The vendor's manufacturing date code.Optional: Yes

temperatureDescription: The temperature of the media in centigrade.Flag: read-onlyType: temperature-typeValue: —128 to 1000 centigrade.Optional: Yes

rx-powerDescription: The receive power of the media in microwatts (uW).Flag: read-onlyType: media-power-typeValue: 0 to 9999.99 uW.


Broadcom


Optional: Yestx-power

Description: The transmit power of the media in microwatts (uW).Flag: read-onlyType: media-power-typeValue: 0 to 9999.99 uW.Optional: Yes

currentDescription: The transceiver current of the media in milliamperes (mA).Flag: read-onlyType: current-typeValue: 0 to 9999.99 mA.Optional: Yes

voltageDescription: The voltage of the media in millivolts (mV).Flag: read-onlyType: voltage-typeValue: 0 to 9999.99 mV.Optional: Yes

wavelengthDescription: The laser wavelength of the media connector.Flag: read-onlyType: uint32Value: 1 to 10000 nanometers.Optional: Yes

power-on-timeDescription: The current value of the power-on time in hours. This parameter displays for 16Gb/s, 32Gb/s, or 64Gb/s SFPs and QSFPs only.Flag: read-onlyType: int32Value: –1 to the maximum number of hours. –1 displays for SFPs that do not support thisparameter.Optional: Yes

peer-data-availableDescription: Indicates whether peer data is available.Flag: read-onlyType: booleanValue: false = Peer data is not available. true = Peer data is available.Optional: Yes

remote-identifierDescription: The identifier for the remote media. This parameter is available only when peer datais available (peer-data-available = true).Flag: read-onlyType: stringValue: Valid values include: SFP+, QSFP, and other.Optional: Yes

remote-laser-typeDescription: The laser type of the remote media connector. This parameter is available onlywhen peer data is available (peer-data-available = true).


Broadcom


Flag: read-onlyType: stringValue: Valid values include: short wave laser, long wave laser LC 1310nm, long wave laserLC 1550nm, not optical or other type SFP, and unknown SFP type.Optional: Yes

remote-media-speed-capabilityDescription: A list of capable speeds supported by the media. This parameter is available onlywhen peer data is available (peer-data-available = true).Flag: read-onlyThis container has the following leaf:speed

Description: The supported transmission speed of the remote port in Gb/s.Flag: read-onlyType: capable-speed-typeValue: 1 to 1000 Gb/s.Optional: Yes

remote-optical-product-dataDescription: The optical product data of the remote media. This parameter is available onlywhen peer data is available (peer-data-available = true).Flag: read-onlyThis container has the following leafs:part-number

Description: The part number assigned by the organization responsible for producing ormanufacturing the media.Flag: read-onlyType: fru:part-number-typeValue: The part number assigned by the organization responsible for producing ormanufacturing the media.Optional: Yes

serial-numberDescription: The factory's serial number for the blade.Flag: read-onlyType: fru:serial-number-typeValue: The factory's serial number for the blade.Optional: Yes

vendor-nameDescription: The vendor number of the media.Flag: read-onlyType: vendor-name-typeValue: The vendor number of the media.Optional: Yes

vendor-revisionDescription: The vendor revision number of the media.Flag: read-onlyType: vendor-revision-typeValue: The vendor revision number of the media.Optional: Yes

date-codeDescription: The vendor's manufacturing date code.


Broadcom


Flag: read-onlyType: date-code-typeValue: The vendor's manufacturing date code.Optional: Yes

remote-media-temperatureDescription: The temperature of the remote media in centigrade. This parameter is availableonly when peer data is available (peer-data-available = true).Flag: read-onlyType: temperature-typeValue: —128 to 1000 centigrade.Optional: Yes

remote-media-rx-powerDescription: The receive power of the remote media in microwatts (uW). This parameter isavailable only when peer data is available (peer-data-available = true).Flag: read-onlyType: media-power-typeValue: 0 to 9999.99 uW.Optional: Yes

remote-media-tx-powerDescription: The transmit power of the remote media in microwatts (uW). This parameter isavailable only when peer data is available (peer-data-available = true).Flag: read-onlyType: media-power-typeValue: 0 to 9999.99 uW.Optional: Yes

remote-media-currentDescription: The transceiver current of the remote media in milliamperes (mA). This parameteris available only when peer data is available (peer-data-available = true).Flag: read-onlyType: current-typeValue: 0 to 9999.99 mA.Optional: Yes

remote-media-voltageDescription: The transceiver voltage of the remote media in millivolts (mV). This parameter isavailable only when peer data is available (peer-data-available = true).Flag: read-onlyType: voltage-typeValue: 0 to 9999.99 mV.Optional: Yes

remote-media-voltage-alertDescription: A list of warning and alarm levels for the remote media voltage. This parameter isavailable only when peer data is available (peer-data-available = true).Flag: read-onlyThis list contains the following leafs:high-alarm

Description: The high alarm for the media.Flag: read-onlyType: alert-typeValue: -128 to 32767 mV.Optional: Yes


Broadcom


low-alarmDescription: The low alarm for the media.Flag: read-onlyType: alert-typeValue: -128 to 32767 mV.Optional: Yes

high-warningDescription: The high warning for the media.Flag: read-onlyType: alert-typeValue: -128 to 32767 mV.Optional: Yes

low-warningDescription: The low warning for the media.Flag: read-onlyType: alert-typeValue: -128 to 32767 mV.Optional: Yes

remote-media-temperature-alertDescription: A list of warning and alarm levels for the remote media temperature. Thisparameter is available only when peer data is available (peer-data-available = true).Flag: read-onlyThis list contains the following leafs:high-alarm

Description: The high alarm for the media.Flag: read-onlyType: alert-typeValue: -128 to 32767 centigrade.Optional: Yes

low-alarmDescription: The low alarm for the media.Flag: read-onlyType: alert-typeValue: -128 to 32767 centigrade.Optional: Yes

high-warningDescription: The high warning for the media.Flag: read-onlyType: alert-typeValue: -128 to 32767 centigrade.Optional: Yes

low-warningDescription: The low warning for the media.Flag: read-onlyType: alert-typeValue: -128 to 32767 centigrade.Optional: Yes


Broadcom


remote-media-tx-bias-alertDescription: A list of warning and alarm levels for the remote media transceiver. This parameteris available only when peer data is available (peer-data-available = true).Flag: read-onlyThis list contains the following leafs:high-alarm

Description: The high alarm for the media.Flag: read-onlyType: alert-typeValue: -128 to 32767 uA.Optional: Yes

low-alarmDescription: The low alarm for the media.Flag: read-onlyType: alert-typeValue: -128 to 32767 uA.Optional: Yes

high-warningDescription: The high warning for the media.Flag: read-onlyType: alert-typeValue: -128 to 32767 uA.Optional: Yes

low-warningDescription: The low warning for the media.Flag: read-onlyType: alert-typeValue: -128 to 32767 uA.Optional: Yes

remote-media-tx-power-alertDescription: A list of warning and alarm levels for the remote media transceiver power. Thisparameter is available only when peer data is available (peer-data-available = true).Flag: read-onlyThis list contains the following leafs:high-alarm

Description: The high alarm for the media.Flag: read-onlyType: alert-typeValue: -128 to 32767 uW.Optional: Yes

low-alarmDescription: The low alarm for the media.Flag: read-onlyType: alert-typeValue: -128 to 32767 uW.Optional: Yes

high-warningDescription: The high warning for the media.Flag: read-only


Broadcom


Type: alert-typeValue: -128 to 32767 uW.Optional: Yes

low-warningDescription: The low warning for the media.Flag: read-onlyType: alert-typeValue: -128 to 32767 uW.Optional: Yes

remote-media-rx-power-alertDescription: A list of warning and alarm levels for the remote media receiver power. Thisparameter is available only when peer data is available (peer-data-available = true).Flag: read-onlyThis list contains the following leafs:high-alarm

Description: The high alarm for the media.Flag: read-onlyType: alert-typeValue: -128 to 32767 uW.Optional: Yes

low-alarmDescription: The low alarm for the media.Flag: read-onlyType: alert-typeValue: -128 to 32767 uW.Optional: Yes

high-warningDescription: The high warning for the media.Flag: read-onlyType: alert-typeValue: -128 to 32767 uW.Optional: Yes

low-warningDescription: The low warning for the media.Flag: read-onlyType: alert-typeValue: -128 to 32767 uW.Optional: Yes

Supported methods

Only the OPTIONS, GET, and HEAD operations are supported in this module.

ExamplesViewing all SFP Media Data on a DeviceThe following example uses the GET request to view all SFP media data on a device.StructureGET <base_URI>/running/brocade-media/media-rdp


Broadcom


URIGET https://10.10.10.10/rest/running/brocade-media/media-rdp



<Response>

<media-rdp>

<name>fc/7/14</name>

<identifier>SFP</identifier>

<connector>LC</connector>

<encoding>64B66B</encoding>

<vendor-name>BROCADE</vendor-name>

<vendor-oui>00:05:1e</vendor-oui>


<vendor-revision>A</vendor-revision>

<serial-number>JAF315530000BLE</serial-number>

<date-code>151228</date-code>


<rx-power>0.90</rx-power>

<tx-power>764.00</tx-power>

<current>7.87</current>

<voltage>3352.30</voltage>

<wavelength>850</wavelength>

<power-on-time>15861</power-on-time>

<media-distance>

<distance>short</distance>

</media-distance>

<media-speed-capability>

<speed>8</speed>

<speed>16</speed>

<speed>32</speed>

</media-speed-capability>

</media-rdp>

<media-rdp>









<serial-number>JAF417230000A3W</serial-number>





Broadcom







<media-distance>


</media-distance>


<speed>8</speed>

<speed>16</speed>

<speed>32</speed>


<remote-identifier>SFP+</remote-identifier>

<remote-laser-type>short wave laser</remote-laser-type>

<remote-media-speed-capability>

<speed>2</speed>

<speed>4</speed>

<speed>8</speed>

<speed>16</speed>

</remote-media-speed-capability>

<remote-optical-product-data>


<serial-number>HAA111451047B72</serial-number>




</remote-optical-product-data>

<remote-media-temperature>49</remote-media-temperature>

<remote-media-rx-power>714.40</remote-media-rx-power>

<remote-media-tx-power>544.10</remote-media-tx-power>

<remote-media-current>7.43</remote-media-current>

<remote-media-voltage>3325.80</remote-media-voltage>

<remote-media-voltage-alert>

<high-alarm>-29536</high-alarm>

<low-alarm>30000</low-alarm>

<high-warning>-30936</high-warning>

<low-warning>31300</low-warning>

</remote-media-voltage-alert>

<remote-media-temperature-alert>

<high-alarm>85</high-alarm>

<low-alarm>-5</low-alarm>

<high-warning>75</high-warning>


</remote-media-temperature-alert>

<remote-media-tx-bias-alert>





</remote-media-tx-bias-alert>

<remote-media-tx-power-alert>



Broadcom





</remote-media-tx-power-alert>

<remote-media-rx-power-alert>





</remote-media-rx-power-alert>

</media-rdp>

</Response>

Viewing the SFP Media Data for a Specific InterfaceThe following example uses the GET request to view the SFP media data for a specific interface (fc/7/14).StructureGET <base_URI>/running/brocade-media/media-rdp/name/interface-id/slot/port

URIGET https://10.10.10.10/rest/running/brocade-media/media-rdp/name/fc%2f7%2f14



<Response>

<media-rdp>









<serial-number>JAF315530000BLE</serial-number>









<media-distance>


</media-distance>



Broadcom


<speed>8</speed>

<speed>16</speed>

<speed>32</speed>


</media-rdp>

</Response>

Viewing the Temperature Alerts for a Specific InterfaceThe following example uses the GET request to view the SFP temperature alerts for a specific interface(fc/7/41).StructureGET <base_URI>/running/brocade-media/media-rdp/name/interface-id/slot/port

URIGET https://10.10.10.10/rest/running/brocade-media/media-rdp/name/fc%2f7%2f41/remote-media-

temperature-alert



<Response>

<media-rdp>


<remote-media-temperature-alert>


<low-alarm>-5</low-alarm>



</remote-media-temperature-alert>

</media-rdp>

</Response>

History



Fabric OS 9.0.0 This API call was modified to add the peer-data-available parameter.

Fabric OS 9.0.1 This API call was modified to include support for the 64-Gb/s SFPs for the power-on-timeparameter.


Broadcom


brocade-name-serverThis module is used to monitor the operation of one or more instances of Name Server functionality.

NOTEThe brocade-name-server module is supported in Fabric OS 8.2.0a and later.

Module Tree

This is the tree view of the module from the brocade-name-server.yang-tree.txt file. See YANG ModuleOverview for YANG node field definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-name-server

+--ro brocade-name-server

+--ro fibrechannel-name-server* [port-id]

+--ro port-id fibrechannel:fcid-hex-string-type

+--ro port-name? fibrechannel:wwn-type

+--ro port-symbolic-name? string

+--ro fabric-port-name? fibrechannel:wwn-type

+--ro permanent-port-name? fibrechannel:wwn-type

+--ro node-name? fibrechannel:wwn-type

+--ro node-symbolic-name? string

+--ro class-of-service? fibrechannel:class-of-service-type

+--ro fc4-type? fibrechannel:fc4-type-type

+--ro fc4-features? fibrechannel:fc4-features-type


+--ro state-change-registration? string

+--ro name-server-device-type? string


+--ro share-area? string

+--ro frame-redirection? string

+--ro partial? string

+--ro lsan? string

+--ro link-speed? string

+--ro port-properties? string

+--ro cascaded-ag? string

+--ro connected-through-ag? string

+--ro real-device-behind-ag? string

+--ro fcoe-device? string

+--ro slow-drain-device-quarantine? string

URI Format


• <base_URI>/running/brocade-name-server/fibrechannel-name-server to view Name Server attributes forthe switch.

• <base_URI>/running/brocade-name-server/fibrechannel-name-server/port-id to view the NameServer attributes for a specific port.


Broadcom


Parametersbrocade-name-server

Description: The proprietary Name Server directory entry container.Flag: read-onlyConfig: falseThis container has the following leafs:fibrechannel-name-server

Description: The port identifier serves as the unique data base key for the Name Server. Note that theswitch must be an FC switch in Native mode.Key: port-idFlag: read-onlyThis container has the following leaves.port-id

Description: A Fibre Channel address identifier assigned to an Nx_Port during either implicit orexplicit fabric logins. The format of the port identifier is identical to the address identifier format.The port identifier serves as the unique data base key for the Name Server.Flag: read-onlyType: fibrechannel:fcid-typeValue: A valid Fibre Channel address.Optional: Yes

port-nameDescription: The device port world wide name (WWN).Flag: read-onlyType: fibrechannel:wwn-typeValue: A valid WWN name.Optional: Yes

port-symbolic-nameDescription: The symbolic port name registered with the Name Server. It is subject to all thedescription and constraints of that object.Flag: read-onlyType: stringValue: The symbolic port name registered with the Name Server. 1 to 384 alphanumericcharacters.Optional: Yes

fabric-port-nameDescription: The F_Port WWN to which the N_Port connects.Flag: read-onlyType: fibrechannel:wwn-typeValue: A valid WWN name.Optional: Yes

permanent-port-nameDescription: The Name_Identifier associated with the physical Nx_Port. If there are multipleName_Identifiers associated with a single physical Nx_Port via FDISC (see FC-FS), thepermanent port name is the original Name_Identifier associated with that physical Nx_Port atfabric login.Flag: read-onlyType: fibrechannel:wwn-typeValue: A valid port WWN name.Optional: Yes


Broadcom


node-nameDescription: The device port world wide name (WWN).Flag: read-onlyType: fibrechannel:wwn-typeValue: A valid port WWN name.Optional: Yes

node-symbolic-nameDescription: The name registered with the Name Server as a Name Server symbolic node nameobject and is subject to all the description and constraints of that object. If not all Nx_Ports onthe host bus adapter have the same node name, the node-symbolic-name resource will not bereturned for the host bus adapter.Flag: read-onlyType: stringValue: Between 4 and 255 alphanumeric characters. Not case-sensitive. Must not contain specialcharacters (high-ASCII) or keywords such as ‘all’ or ‘none’.Optional: Yes

class-of-serviceDescription: The class of service levels supported by the device. A device can support multipleclass of service levels.Flag: read-onlyType: fibrechannel:class-of-service-typeValue: These can be class f, class 1, class 2, or class 3. Only the numeric value displays:0 = class-f1 = class-12 = class-23 = class-3Optional: Yes

fc4-typeDescription: A set of supported data structure type values (for example, supported values of thetype field in frame headers) for Device_Data and FC-4 Link_Data frames. For each possible typevalue, this leaf has a bit in the fc4-type leaf that indicates whether frames with that type value aresupported. For each supported type value, the bit is set in the leaf. For each unsupported typevalue, the bit is not set in the leaf.Flag: read-onlyType: fibrechannel:fc4-type-typeValue: The fc4 type (such as, FCP).Optional: Yes

fc4-featuresDescription: The registered FC-4 features bits for a given FC-4 type.Flag: read-onlyType: fibrechannel:fc4-features-typeValue: The registered FC-4 features in relation to a given FC-4 type.FCP-InitiatorFCP-TargetFC-NVMe-Discovery-ServiceFC-NVMe-InitiatorFC-NVMe-TargetOptional: Yes

port-typeDescription: The port type of the device.Flag: read-only


Broadcom


Type: fibrechannel:port-type-string-typeValue: The port type is one of the following options:n-port (0x01)nl-port (0x02)f/nl-port (0x03)nx-port (0x7F)f-port (0x81)fl-port (0x82)e-port (0x84)b-port (0x85)a-port (0x86)0xnn (Other: A two-digit numeric value of the undefined/unrecognized type supplied by the port(hexadecimal).)Optional: Yes

state-change-registrationDescription: The state change registration (SCR) of the device. Returns an empty tag if the SCRvalue is not known.Flag: read-onlyType: stringValue: The state change registration is one of the following options:None - No registration. Device has not registered for any RSCN function.Fabric-Detected - Registered to receive all RSCN for events detected by the fabric.Nx-Port-Detected - Registered to receive all RSCN requests issued for events detected by theaffected Nx_Port.Fabric-Name - Fabric Name change registration (FC Standard variant). Registered to receive anRSCN when the Fabric Principal switch changes.Peer-Zone - Registered to receive an RSCN when an associated Peer Zone changes.Brocade-Principal-Switch - Principal switch change registration (proprietary).Brocade-QoS - Access Gateway Quality-of-Service change registration (proprietary).Optional: Yes

name-server-device-typeDescription: The definition for the type and role of a device.Flag: read-onlyType: stringValue: 0 to 64 characters.Types can be ‘Physical’, ‘Virtual’, ‘NPIV’, or ‘iSCSI’. If the device registers a type that is not one ofthese, the type is listed as ‘Undefined’.Roles can be ‘Initiator’, ‘Target’, or ‘Initiator+Target’. If the device role is not registered, the role islisted as ‘Unknown’.Pattern: (Undefined|Physical|Virtual|NPIV|iSCSI|FCoE)(Undefined|Unknown$initiator/target$|Initiator|(Target|Initiator\+Target)Optional: Yes

port-indexDescription: The index number of the physical N_Port to which the device connects.Flag: read-onlyType: fibrechannel:user-port-number-typeValue: The Fibre Channel port user port number.Optional: Yes


Broadcom


share-areaDescription: Indicates whether the port utilizes the Brocade Shared Area method of FibreChannel addressing.


Flag: read-onlyType: stringValue:yes - The port shares an area.no - The port does not share an area.Optional: Yes

frame-redirectionDescription: Indicates whether the port is involved in Frame Redirection zoning. The deviceinvolved in frame redirection is specified as either ‘virtual’ , ‘host’, or ‘target’.Flag: read-onlyType: stringValue:yes - The port is involved in frame redirection.no - The port is not involved in frame redirection.Optional: Yes

partialDescription: Indicates whether the device entry is incomplete. Incomplete devices have routingestablished, but are not considered during device discovery (for example, during FC-GS NameServer queries).Flag: read-onlyType: stringValue:yes - The device entry is incomplete.no - The device entry is complete.Optional: Yes

lsanDescription: Indicates whether the device is part of an active LSAN zone. If the LSAN zonestatus is not known, then an empty tag is returned. Flag: read-onlyType: enumerationValue: yes = The device is a member of an active LSAN zone. no = The device is not a memberof an active LSAN zone. unknown = The LSAN zone status is not known.Optional: Yes

link-speedDescription: The link speed of the device.The link speed of end devices that log in to the edge fabric through F_Port trunk display thebandwidth of the F_Port trunk. For example, if an 8G host attached to AG login to fabric through a32G F_Port trunk, the device link speed for the 8G host is displayed as 32G.Flag: read-onlyType: stringValue:4G8G16G32G


Broadcom


Optional: Yesport-properties

Description: A list of proprietary port properties (for example, ‘SIM Port’ for Brocade SIM ports).Flag: read-onlyType: stringValue:SIM PortMirror PortI/O Analytics PortOptional: Yes

cascaded-agDescription: Indicates whether the device is connected through a cascaded Access Gateway(AG) connection.Flag: read-onlyType: stringValue:yes - The device is connected through a cascaded AG connection (for example, a 2-hop AGconnection).no - The device is not connected through a cascaded AG connection.Optional: Yes

connected-through-agDescription: Indicates whether the device is connected through Access Gateway (AG).Flag: read-onlyType: stringValue:yes - The device is connected through Access Gateway.no - The device is not connected through Access Gateway.Optional: Yes

real-device-behind-agDescription: Indicates whether the device is a virtualized device (NPIV) connected via AccessGateway (AG).Flag: read-onlyType: stringValue:yes - The device is not a virtualized device (NPIV) connected through Access Gateway.no - The device is a virtualized device (NPIV) connected through Access Gateway.Optional: Yes

fcoe-deviceDescription: Indicates whether the device is an FCoE device.Flag: read-onlyType: stringValue:yes - The device is an FCoE device.no - The device is not an FCoE device.Optional: Yes

slow-drain-device-quarantineDescription: Indicates whether the device has been identified as having symptoms of creditstalling.Flag: read-onlyType: string


Broadcom


Value:yes - The device has been identified as having a credit stalled condition, and has its incomingtraffic quarantined to a Low Priority VC.no - The device has not been flagged for having a credit stalled issue.Optional: Yes

Supported Methods

Only the GET, HEAD, and OPTIONS operations are supported in this module.

ExamplesRetrieving Name Server Information for a SwitchThis example uses a GET request to retrieve the Name Server information for a switch.StructureGET <base_URI>/running/brocade-name-server/fibrechannel-name-serverURI RequestGET https://10.10.10.10/rest/running/brocade-name-server/fibrechannel-name-server



<Response>

<fibrechannel-name-server>

<port-id>10a00</port-id>

<port-symbolic-name>[30] "dsim:brcdtgt:sw0[10.38.18.116]"</port-symbolic-name>

<node-symbolic-name>[30] "dsim:brcdtgt:sw0[10.38.18.116]"</node-symbolic-name>

<port-name>30:0a:c4:f5:7c:4e:59:54</port-name>

<node-name>10:00:c4:f5:7c:4e:59:54</node-name>


<share-area> No </share-area>

<frame-redirection> No </frame-redirection>

<partial> No </partial>

<lsan> No </lsan>

<link-speed>16</link-speed>

<state-change-registeration>0000000000</state-change-registeration>

<port-type>N</port-type>

<class-of-service>2,3</class-of-service>

<fc4-type>FCP</fc4-type>

<fabric-port-name>20:0a:c4:f5:7c:16:99:f4</fabric-port-name>

<connected-through-ag>No</connected-through-ag>

<port-properties/>

<nameserver-devicetype>Physical Initiator</nameserver-devicetype>

<real-device-behind-ag>No</real-device-behind-ag>

<cascaded-ag>No</cascaded-ag>

<slow-drain-device-quarantine>No</slow-drain-device-quarantine>


Broadcom


<fcoe-device>No</fcoe-device>

<fc4-features>FCP-Initiator</fc4-features>

<permanent-port-name>30:03:00:05:33:a3:e8:85</permanent-port-name>

</fibrechannel-name-server>


<port-id>10b00</port-id>

<port-symbolic-name>[30] "dsim:brcdtgt:sw0[10.38.18.116]"</port-symbolic-name>

<node-symbolic-name>[30] "dsim:brcdtgt:sw0[10.38.18.116]"</node-symbolic-name>

<port-name>30:0b:c4:f5:7c:4e:59:54</port-name>

<node-name>10:00:c4:f5:7c:4e:59:54</node-name>


<share-area> No </share-area>

<frame-redirection> No </frame-redirection>

<partial> No </partial>

<lsan> No </lsan>

<link-speed>16</link-speed>

<state-change-registeration>0000000000</state-change-registeration>



<fc4-type>FCP </fc4-type>

<fabric-port-name>20:0b:c4:f5:7c:16:99:f4</fabric-port-name>


<port-properties/>









</Response>

Retrieving Name Server information for a PortThis example uses a GET request to retrieve the Name Server information for a specific port.StructureGET <base_URI>/running/brocade-name-server/fibrechannel-name-server/port-idURI RequestGET https://10.10.10.10/running/brocade-name-server/fibrechannel-name-server/port-id/0xeb1200



<Response>


<port-id>0xeb1200</port-id>


Broadcom


<port-symbolic-name/>

<node-symbolic-name>[41] "dsim:fdmi_host:edsim-b11-160[10.38.79.70]"</node- symbolic-

name>

<port-name>30:03:00:05:33:a3:e8:85</port-name>

<node-name>10:00:00:05:33:a3:e8:85</node-name>


<share-area>No</share-area>

<frame-redirection>No</frame-redirection>

<partial>No</partial>

<lsan>No</lsan>

<link-speed>16G</link-speed>

<state-change-registration>Fabric-Detected Nx-Port-Detected Fabric-Name Peer-Zone</state-

change-registration>



<fc4-type>FCP</fc4-type>

<fabric-port-name>20:12:c4:f5:7c:c0:fd:5d</fabric-port-name>


<port-properties/>









</Response>

History



Fabric OS 8.2.1 Refined descriptions and headings.

Fabric OS 9.0.0 This API call was modified to edit the lsan leaf and to make the share-area leaf is obsolete.


Broadcom


brocade-securityThis module provides a detailed view of Fabric OS System Security configuration.

The brocade-security module enables you to manage the following features:

• IP filter policies

• IP filter rules

• User accounts

• Password configuration

• SSH configuration

• Remote authentication

• Security protocols

• Security certificate

• AAA services

• LDAP role mapping

It assumes a knowledge of System Security as performed in Fabric OS. For information on these topics, refer to theBrocade Fabric OS Administration Guide.

Module Tree

This is the tree view of the module from the brocade-security.yang-tree.txt file. See YANG Module Overview for YANGnode field definitions and possible values, and see Supported Data Types for data type descriptions.module: brocade-security

+--rw brocade-security

+--rw ipfilter-policy* [name]

| +--rw name brocade-security-type:ipfilter-name-type

| +--rw ip-version? brocade-security-type:ipfilter-ip-version-type

| +--ro is-policy-active? boolean

| +--ro is-default-policy? boolean

| +--rw action? brocade-security-type:ipfilter-action-type

| +--rw clone-destination-policy-name? brocade-security-type:ipfilter-name-type

+--rw ipfilter-rule* [policy-name index]

| +--rw policy-name brocade-security-type:ipfilter-name-type

| +--rw index uint16

| +--rw source-ip? brocade-security-type:host-type

| +--rw destination-start-port inet:port-number

| +--rw destination-end-port? inet:port-number

| +--rw protocol? brocade-security-type:ipfilter-protocol-type

| +--rw permission brocade-security-type:ipfilter-permission-type

| o--rw traffic-type? brocade-security-type:ipfilter-traffic-type

| +--rw destination-ip? brocade-security-type:host-type

+--rw user-specific-password-cfg* [user-name]

| +--rw user-name brocade-security-type:user-config-user-name-type

| +--rw minimum-password-age? int32

| +--rw maximum-password-age? int32

| +--rw warn-on-expire? int32

| +--rw enforce-expire? boolean

| +--ro hash-type? brocade-security-type:hash-algorithm-type


Broadcom


+--rw password-cfg

| +--rw minimum-length? int32

| +--rw character-set? int32

| +--rw user-name-allowed? boolean

| +--rw minimum-lower-case-character? int32

| +--rw minimum-upper-case-character? int32

| +--rw minimum-numeric-character? int32

| +--rw minimum-special-character? int32

| +--rw past-password-history? int32

| +--rw minimum-password-age? int32

| +--rw maximum-password-age? int32

| +--rw warn-on-expire? int32

| +--rw lock-out-threshold? int32

| +--rw lock-out-duration? int32

| +--rw admin-lock-out-enabled? boolean

| +--rw repeat-character-limit? int32

| +--rw sequence-character-limit? int32

| +--ro password-config-changed? boolean

| +--rw reverse-user-name-allowed? boolean

| +--rw hash-type? brocade-security-type:hash-algorithm-type

| +--rw manual-hash-enabled? boolean

| +--rw enforce-expire? boolean

| +--rw minimum-difference? uint16

| +--rw password-action? brocade-security-type:password-cfg-operation-type

+--rw user-config* [name]

| +--rw name brocade-security-type:user-config-user-name-type

| +--rw password? brocade-security-type:user-password-type

| +--rw role? brocade-security-type:user-config-role-type

| +--rw account-description? string

| +--rw account-enabled? boolean

| +--rw password-change-enforced? boolean

| +--rw account-locked? boolean

| +--rw access-start-time? string

| +--rw access-end-time? string

| +--rw home-virtual-fabric? home-virtual-fabric-type

| +--rw chassis-access-role? user-config-role-type

| +--rw virtual-fabric-role-id-list

| | +--rw role-id* brocade-security-type:virtual-fabric-role-id-type

| +--ro auth-token-present? boolean

+--rw auth-spec

| +--rw authentication-mode? brocade-security-type:aaa-authspec-type

| +--rw activate-no-log-out? boolean

| +--rw primary-auth-log-messages? boolean

+--rw radius-server* [server]



| +--rw secret? string

| +--rw timeout? brocade-security-type:aaa-timeout-type

| +--rw authentication? union

| +--rw encryption-type? brocade-security-type:aaa-encryption-algorithm-type

| +--rw position? uint16

+--rw tacacs-server* [server]



Broadcom



| +--rw secret? string


| +--rw authentication? brocade-security-type:aaa-protocols-type

| +--rw encryption-type? brocade-security-type:aaa-encryption-algorithm-type


+--rw ldap-server* [server]



| +--rw domain? inet:domain-name


| +--rw tls-mode? brocade-security-type:ldap-tls-mode-type


+--rw ldap-role-map* [ldap-role]

| +--rw ldap-role string

| +--rw switch-role? string

| +--rw home-virtual-fabric? home-virtual-fabric-type

| +--rw chassis-access-role? user-config-role-type

+--rw sec-crypto-cfg-template-action

| +--rw template-name? brocade-security-type:sec-crypto-cfg-template-name-type

| +--rw action? brocade-security-type:sec-crypto-cfg-actions-type

| +--rw remote-user-name? string

| +--rw remote-host-ip? inet:host

| +--rw remote-user-password? string


| +--rw file-transfer-protocol-type? sec-crypto-cfg-file-transfer-protocol-type

+--ro sec-crypto-cfg-template* [name]

| +--ro name brocade-security-type:sec-crypto-cfg-template-name-type

| +--ro template? string

+--ro sec-crypto-cfg

| +--ro ssh-cipher? brocade-security-type:default-string-type

| +--ro ssh-kex? brocade-security-type:default-string-type

| +--ro ssh-mac? brocade-security-type:default-string-type

| +--ro https-cipher? brocade-security-type:default-string-type

| +--ro https-tlsv13-cipher? brocade-security-type:default-string-type

| +--ro radius-cipher? brocade-security-type:default-string-type

| +--ro ldap-cipher? brocade-security-type:default-string-type

| +--ro syslog-cipher? brocade-security-type:default-string-type

| +--ro https-tls-protocol? brocade-security-type:tls-protocol-type

| +--ro radius-tls-protocol? brocade-security-type:tls-protocol-type

| +--ro ldap-tls-protocol? brocade-security-type:tls-protocol-type

| +--ro syslog-tls-protocol? brocade-security-type:tls-protocol-type

| +--ro x509v3-validation-mode? brocade-security-type:validation-mode-type

+--rw sshutil

| +--rw allow-user-name? brocade-security-type:user-config-user-name-type

| +--rw rekey-interval? uint16

+--rw sshutil-known-host* [remote-host-name]

| +--rw remote-host-name inet:host

| +--ro key-type? string

| +--ro host-key? string

| +--rw fingerprint-list

| +--rw fingerprint* string

+--rw sshutil-key* [algorithm-type key-type]


Broadcom


| +--rw algorithm-type brocade-security-type:sshutil-algorithm-type

| +--rw key-type brocade-security-type:sshutil-key-type

| o--rw passphrase? string

| +--ro size? uint16

| +--ro fingerprint? string

+--rw sshutil-public-key* [user-name]

| +--rw user-name brocade-security-type:user-config-user-name-type

| +--ro public-key? string

+--rw sshutil-public-key-action

| +--rw action? brocade-security-type:sshutil-operation-type

| +--rw algorithm-type? brocade-security-type:sshutil-algorithm-type

| +--rw user-name? brocade-security-type:user-config-user-name-type





| +--rw public-key-name? string

+--rw password

| +--rw user-name? brocade-security-type:user-config-user-name-type

| +--rw old-password? brocade-security-type:user-password-type

| +--rw new-password? brocade-security-type:user-password-type

+--rw security-certificate-generate

| +--rw certificate-entity? brocade-security-type:gen-certificate-entity-type

| +--rw certificate-type? brocade-security-type:certificate-application-type

| +--rw algorithm-type? brocade-security-type:sshutil-algorithm-type

| +--rw key-size? brocade-security-type:keysize-type

| +--rw hash-type? brocade-security-type:seccertmgmt-hash-type

| +--rw years? uint16

| +--rw keypair-tag? string

| +--rw country-name? string

| +--rw state-name? string

| +--rw locality-name? string

| +--rw organization-name? string

| +--rw unit-name? string


| +--rw ip-address-in-subject-alternative-name? boolean

+--rw security-certificate-action





| +--rw protocol? brocade-security-type:seccertmgmt-protocol-type

| +--rw certificate-entity? brocade-security-type:certificate-entity-type

| +--rw certificate-type? brocade-security-type:certificate-application-type

| +--rw certificate-name? string

| +--rw ca-certificate? string

| +--rw operation? brocade-security-type:seccertmgmt-operation-type

| +--rw keypair-tag? string

+--ro security-certificate* [certificate-entity certificate-type]

| +--ro certificate-entity brocade-security-type:certificate-entity-type

| +--ro certificate-type union

| +--ro certificate? string

| +--ro certificate-hexdump? string


Broadcom


+--ro security-certificate-extension* [] {fibrechannel:fibrechannel_extension_platform}?

+--ro certificate-entity? brocade-security-type:certificate-entity-type

+--ro local-certificate? boolean

+--ro certificate-name? string

+--ro certificate? string

+--ro keypair-tag? string

+--ro certificate-hexdump? string

URI Format


• <base_URI>/running/brocade-security/ipfilter-policy followed by the leafs as listed in the module tree todisplay or configure IP filter policies.

• <base_URI>/running/brocade-security/ipfilter-rule followed by the leafs as listed in the module tree todisplay or configure IP filter rules.

• <base_URI>/running/brocade-security/user-specific-password-cfg to display or configure user-specificpassword policy configurations.

• <base_URI>/running/brocade-security/password-cfg followed by the leafs as listed in the module tree todisplay or configure password policy configurations.

• <base_URI>/running/brocade-security/user-config followed by the leafs as listed in the module tree todisplay or configure user configurations.

• <base_URI>/running/brocade-security/auth-spec followed by the leafs as listed in the module tree to displayor configure authentication modes.

• <base_URI>/running/brocade-security/radius-server followed by the leafs as listed in the module tree todisplay or configure a RADIUS server.

• <base_URI>/running/brocade-security/tacacs-server followed by the leafs as listed in the module tree todisplay or configure a TACACS+ server.

• <base_URI>/running/brocade-security/ldap-server followed by the leafs as listed in the module tree todisplay or configure a LDAP server.

• <base_URI>/running/brocade-security/ldap-role-map followed by the leafs as listed in the module tree todisplay or configure LDAP role mappings.

• <base_URI>/running/brocade-security/sec-crypto-cfg-template-action followed by the leafs as listedin the module tree to apply, verify, import, or export SecCryptoCfg templates.

• <base_URI>/running/brocade-security/sec-crypto-cfg-template followed by the leafs as listed in themodule tree to display the SecCryptoCfg templates.

• <base_URI>/running/brocade-security/sec-crypto-cfg followed by the leafs as listed in the module tree todisplay the active Security Crypto Configuration.

• <base_URI>/running/brocade-security/sshutil followed by the leafs as listed in the module tree to display orconfigure the allowed user and rekey configuration.

<base_URI>/running/brocade-security/sshutil-known-host to display or configure a remote SSH host.

• <base_URI>/running/brocade-security/sshutil-key followed by the leafs as listed in the module tree todisplay or generate a Host key and pub-private key, or delete an SSH Host and pub-private keys.


Broadcom


• <base_URI>/running/brocade-security/sshutil-public-key followed by the leafs as listed in the moduletree to display or configure public keys for a specific user or to delete the public keys for a specified user or all users.

• <base_URI>/running/brocade-security/sshutil-public-key-action followed by the leafs as listed in themodule tree to import or export a public key to or from a remote host.

• <base_URI>/running/brocade-security/password followed by the leafs as listed in the module tree toconfigure a user's password .

• <base_URI>/running/brocade-security/security-certificate-generate followed by the leafs as listedin the module tree to generate self-signed certificate for HTTPS and Extension or Certificate Signing Requests (CSR) on adevice.

• <base_URI>/running/brocade-security/security-certificate-action followed by the leafs as listed inthe module tree to import or export a security certificate to or from a remote host.

• <base_URI>/running/brocade-security/security-certificate followed by the leafs as listed in the moduletree to display a security certificate.

Parametersbrocade-security

Description: The container for security configuration.Flag: read-writeThis container has the following containers and lists:ipfilter-policy

Description: The IP filter policies. You use this container to manage the IP filter policies. The IP filterpolicy sets up a packet filtering firewall to provide access control on the management IP interface. TheIPv4 and IPv6 filter policies can either be in the defined configuration or in the active configuration. Therecan be a maximum of eight IP filter policies on the switch including the two default policies (default_ipv4and default_ipv6). The active policy must be the default policy or one of the IP policies in the definedconfiguration. Note that only active policies are enforced.Flag: read-writeKey: nameThis list has the following leafs:name

Description: The IP filter policy name.Flag: read-writeType: brocade-security-type:ipfilter-name-typeValue: 1 to 20 alphanumeric and underscore characters. The policy name must be unique. Notethat policy names are case-insensitive and are always stored as lower case. The IP filter policynames 'default_ipv4' and 'default_ipv6' are reserved for the default IP filter policies.Optional: No

ip-versionDescription: The IP filter policy version type (such as IPv4 or IPv6).Flag: read-writeType: brocade-security-type:ipfilter-ip-version-typeValue: IPv4 = This creates an IPv4 policy. IPv6 = This creates an IPv6 policy.Optional: Yes

is-policy-activeDescription: The current status of the policy (defined or active).Flag: read-onlyType: booleanConfig: false


Broadcom


Value: true = The active policy. False = The defined policy.Optional: Yes

is-default-policyDescription: Whether the policy is a default or user-defined policy.Flag: read-onlyType: booleanConfig: falseValue: true = The default policy. false = The user-defined policy.Optional: Yes

actionDescription: The action to take on the IP filter policy. IP filter configurations are savedautomatically after any change. You can set this parameter with a PATCH request; however, aGET request does not fetch this parameter.Flag: write-onlyType: brocade-security-type:ipfilter-action-typeValue: activate = This activates the policy. clone = This clones the policy.Optional: Yes

clone-destination-policy-nameDescription: The destination IP filter policy name for the clone operation. You can set thisparameter with a PATCH request; however, a GET request does not fetch this parameter.Flag: write-onlyType: brocade-security-type:ipfilter-name-typeValue: 1 to 20 alphanumeric and underscore characters. The policy name must be unique. TheIP filter policy names 'default_ipv4' and 'default_ipv6' are reserved for the default IP filter policies.Optional: Yes

ipfilter-ruleDescription: The IP filter rule configurations.Flag: read-writeKey: policy-nameThis list has the following leafs:policy-name

Description: The IP filter policy name.Flag: read-writeType: brocade-security-type:ipfilter-name-typeValue: 1 to 20 alphanumeric and underscore characters. The policy name must be unique. Notethat policy names are case-insensitive and are always stored as lower case. The IP filter policynames 'default_ipv4' and 'default_ipv6' are reserved for the default IP filter policies.Optional: No

indexDescription: The position of the IP filter entry in the IP filter table.Flag: read-writeType: uint16Value: 1 to the current maximum rule number plus one.Optional: No

source-ipDescription: The source IP address. Note that the source IP option is optional for FORWARDtraffic.Flag: read-writeType: brocade-security-type:host-typeValue: A valid IP address.


Broadcom


For an IPv4 filter policy, the source address must be a 32-bit IPv4 address in dot decimalnotation. The group prefix must be a CIDR block prefix representation. For example,208.130.32.0/24 represents a 24-bit IPv4 prefix starting from the most significant bit. The specialprefix 0.0.0.0/0 matches any IPv4 address. In addition, the keyword any is supported to representany IPv4 address.For an IPv6 filter policy, the source address must be a 128-bit IPv6 address, in a formatacceptable in RFC 3513. The group prefix must be a CIDR block prefix representation. Forexample, 12AB:0:0:CD30::/64 represents a 64-bit IPv6 prefix starting from the most significant bit.In addition, the keyword any is supported to represent any IPv6 address.Optional: Yes

destination-start-portDescription: The destination port number or the starting port number for a port number range.Flag: read-writeType: inet:port-numberValue: 1 to 65535.Optional: No

destination-end-portDescription: The ending destination port number of the port number range. If no destination endport is specified during IP filter rule creation, the destination end port value is equal to destinationstart port.Flag: read-writeType: inet:port-numberValue: 1 to 65535.Optional: Yes

protocolDescription: The protocol type (tcp or udp).Flag: read-writeType: brocade-security-type:ipfilter-protocol-typeValue: A valid protocol type. Supported types are tcp or udp. The default is udp.Optional: Yes

permissionDescription: The permit or deny action associated with this rule. You can permit or deny (block)ports from 1 through 65535.Flag: read-writeType: brocade-security-type:ipfilter-permission-typeValue: permit = Applies the permit action. deny = Applies the deny action.Optional: No

traffic-typeDescription: The type of traffic allowed for the specified IP address.


Flag: read-writeType: brocade-security-type:ipfilter-traffic-typeValue: input = Manages traffic on IP management interfaces. Input traffic is the default. forward= Manages bidirectional traffic between the external Ethernet interface (eth0/bond0) and theinband management interface (inbd+).Optional: Yes


Broadcom


destination-ipDescription: The destination IP address. Note that the destination IP address is optional forINPUT traffic.Flag: read-writeType: brocade-security-type:host-typeValue: A valid IP address.For an IPv4 filter policy, the source address has to be a 32-bit IPv4 address in dot decimalnotation. The group prefix has to be a CIDR block prefix representation. For example,208.130.32.0/24 represents a 24-bit IPv4 prefix starting from the most significant bit. The specialprefix 0.0.0.0/0 matches any IPv4 address. In addition, the keyword any is supported to representany IPv4 address.For an IPv6 filter policy, the source address has to be a 128-bit IPv6 address, in a formatacceptable in RFC 3513. The group prefix has to be a CIDR block prefix representation. Forexample, 12AB:0:0:CD30::/64 represents a 64-bit IPv6 prefix starting from the most significant bit.In addition, the keyword any is supported to represent any IPv6 address.Optional: Yes

user-specific-password-cfgDescription: The password policy configuration for a specific user.Flag: read-writeKey: user-nameThis list has the following leafsuser-name

Description: The user name for a specific user account.Flag: read-writeType: brocade-security-type:user-config-user-name-typeValue: 1 to 32 printable ASCII characters.Optional: Yes

minimum-password-ageDescription: The minimum number of days that must elapse before a password can be changed.When the maximum-password-age is set to non-zero value, the minimum-password-age valuemust be set to a value less than or equal to the maximum-password-age. If a minimum passwordage value is not configured, a GET request does not fetch this parameter.Flag: read-writeType: int32Value: 0 to 999 days. The default is 0.Optional: Yes

maximum-password-ageDescription: The maximum number of days that can elapse before a password can bechanged. This is the password expiration period. Setting this parameter to 0 disables passwordexpiration. If a maximum password age value is not configured, a GET request does not fetch thisparameter.Flag: read-writeType: int32Value: 0 to 999 days. The default is 0.Optional: Yes

warn-on-expireDescription: The number of days prior to password expiration that a warning about passwordexpiration displays. If a warn on expire value is not configured, a GET request does not fetch thisparameter.Flag: read-writeType: int32


Broadcom


Value: 0 to 999 days. The default is 0.Optional: Yes

enforce-expireDescription: When activated (set to true), the password for the specified user expires when theexpiration date is reached. The user is prompted to change the password on the next successfullogin. You can set this parameter with a PATCH request; however, a GET request does not fetchthis parameter.Flag: read-writeType: booleanValue: true = Password expiration is enforced. false = Password expiration is not enforced.Optional: Yes

hash-typeDescription: The hash type (such as md5, sha256, or sha512).Flag: read-writeType: brocade-security-type:hash-algorithm-typeConfig: falseValue: md5 = The md5 hash type. sha256 = The sha256 hash type. sha512 = The sha512 hashtype.Optional: Yes

password-cfgDescription: The generic password policy configuration for all user accounts.Flag: read-writeThe container has the following leafs.minimum-length

Description: The minimum length of the password. The minimum length of the password can beset from 8 to 40 characters.Flag: read-writeType: int32Value: 8 to 40.Optional: Yes

character-setDescription: The minimum length on the character set (upper and lowercase letters and specialcharacters) to use in the password. This value must be less than or equal to the minimum-lengthvalue.Flag: read-writeType: int32Value: 0 to 40. The default is 0.Optional: Yes

user-name-allowedDescription: The validation check to determine if the username is used in the password. Ifactivated, the username (in both forward and reverse direction) cannot be used in the password.For example, if the username is 'testuser', the password 'testuser123' and 'resutset567' are notallowed.Flag: read-writeType: booleanValue: true = The validation check is activated. false = The validation check is deactivated. Thedefault is true.Optional: Yes


Broadcom


minimum-lower-case-characterDescription: The minimum number of lowercase alphabetic characters that must appear in thepassword. This value must be less than or equal to the minimum-length parameter.Flag: read-writeType: int32Value: 0 to 40. The default is 0.Optional: Yes

minimum-upper-case-characterDescription: The minimum number of uppercase alphabetic characters that must appear in thepassword. This value must be less than or equal to the minimum-length parameter.Flag: read-writeType: int32Value: 0 to 40. The default is 0.Optional: Yes

minimum-numeric-characterDescription: The minimum number of numeric digits that must appear in the password. Themaximum value must be less than or equal to the minimum-length value.Flag: read-writeType: int32Value: 0 to 40. The default is 0.Optional: Yes

minimum-special-characterDescription: The minimum number of punctuation characters that must appear in the password.All displayable, non-alphanumeric punctuation characters, except the colon (:) are allowed. Themaximum value must be less than or equal to the minimum-length value.Flag: read-writeType: int32lue: 0 to 40. The default is 0.Optional: Yes

past-password-historyDescription: The number of past password values that are disallowed when setting a newpassword.Flag: read-writeType: int32Value: 0 to 24. The default is 1.Optional: Yes

minimum-password-ageDescription: The minimum number of days that must elapse before a password can be changed.When the maximum-password-age parameter is set to non-zero value, the minimum-password-age value must be set to a value less than or equal to the maximum-password-age value.Flag: read-writeType: int32Value: 0 to 999 days. The default is 0.Optional: Yes

maximum-password-ageDescription: The maximum number of days that must elapse before a password can bechanged, and is also known as the password expiration period. Setting this parameter to zerodisables password expiration.Flag: read-writeType: int32


Broadcom


Value: 0 to 999 days. The default is 0.Optional: Yes

warn-on-expireDescription: The number of days prior to password expiration that a warning about passwordexpiration displays.Flag: read-writeType: int32Value: 0 to 999 days. The default is 0.Optional: Yes

lock-out-thresholdDescription: The number of times a user can specify an incorrect password during login beforethe account is locked. The number of failed login attempts is counted from the last successfullogin. Setting this parameter to zero disables the lockout mechanism.Flag: read-writeType: int32Value: 0 to 999 days. The default is 0.Optional: Yes

lock-out-durationDescription: The time, in minutes, after which a previously locked account automatically unlocks.Setting this to zero disables lockout duration, and requires an administrative action to unlock theaccount.Flag: read-writeType: int32Value: 0 to 99999 minutes. The default is 30.Optional: Yes

admin-lock-out-enabledDescription: Whether the lockout policy is enabled for the admin account.Flag: read-writeType: booleanValue: true = Admin lockout is enabled for the admin account. false = Admin lockout is notenabled for the admin account.Optional: Yes

repeat-character-limitDescription: The length of repeated character sequences that are disallowed. For example, ifthe 'repeat' value is set to 3, a password 'passAAAword' is disallowed because it contains therepeated sequence 'AAA'. However, a password 'passAAword' is allowed because no repeatedcharacter sequence exceeds two characters.Flag: read-writeType: int32Value: 0 to 40. The default is 1.Optional: Yes

sequence-character-limitDescription: The length of sequential character sequences that are disallowed. In a charactersequence, the ASCII value of each contiguous character differs by one. The ASCII value for thecharacters in the sequence must all be increasing or decreasing. For example, if the 'sequence'value is set to 3, a password of 'passABCword' is disallowed because it contains the sequence'ABC'.Flag: read-writeType: int32Value: 0 to 40. The default is 1.


Broadcom


Optional: Yespassword-config-changed

Description: The account password policy status.Flag: read-onyType: booleanValue: true = The account password policy has been changed from the default configuration.false = The account password policy is the default configuration. The default is falseOptional: Yes

reverse-user-name-allowedDescription: The validation check to determine if the password is an exact reverse string of theusername.Flag: read-writeType: booleanValue: true = The validation check is activated. false = The validation check is deactivated.Optional: Yes

hash-typeDescription: The hash type (md5, sha258, or sha512). This parameter is available only when thepassword action parameter is configured to hash config (password-action=hash-config).Flag: read-writeType: brocade-security-type:hash-algorithm-typeValue: md5 = The md5 hash type. sha256 = The sha256 hash type. sha512 = The sha512 hashtype.Optional: Yes

manual-hash-enabledDescription: A password change due to a change in hash type can be manual or enforced atlogin. If it is configured to be manual, you must change the password now. This parameter isavailable only when the hash type parameter is configured.Flag: read-writeType: booleanValue: true = The password change due to a change in hash type is manual. false = Thepassword change due to a change in hash type is enforced at login.Optional: Yes

enforce-expireDescription: The expiration of the password for all users except the root user. If activated, theuser is prompted for a password change on the next successful login. You can set this parameterwith a PATCH request; however, a GET request does not fetch this parameter.Flag: write-onlyType: booleanValue: true = Password expiration is enforced. false = Password expiration is not enforced.Optional: Yes

minimum-differenceDescription: The number of character differences expected between the old and new password.Flag: read-writeType: uint16Value: 0 to 40.Optional: Yes

password-actionDescription: The configuration or deletion of password policies. You can set this parameter witha PATCH request; however, a GET request does not fetch this parameter.Flag: write-only


Broadcom


Type: brocade-security-type:password-cfg-operation-typeValue: hash-config = Sets the hash type. Valid values are md5, sha256, or sha512. default =Resets all password policies to their default value (sha512). delete-all = Removes the passwordexpiration policies of all users.Optional: Yes

user-configDescription: The user accounts on a switch.In a Virtual Fabric-enabled environment, you can configure the account's username, its role, and thelogical fabrics that the account may access.An account can have different roles for different logical fabrics. An account can access multiple logicalfabrics, but only one logical fabric at a time.In a logical fabric environment, you can additionally define access to chassis-level commands. Anaccount can have one role in the logical fabric, and another role regarding chassis commands.Flag: read-writeKey: nameThis list contains the following leafs:name

Description: The login name of the account to be created or modified. The name must be uniqueand must begin with an alphabetic character. User names are case-sensitive and can contain upto 32 alphanumeric characters, including periods (.) and underscores (_). NOTE:Flag: read-writeType: brocade-security-type:user-config-user-name-typeValue: The login name.Optional: Yes

passwordDescription: The password for the account. You can set this parameter with a POST or PATCHrequest; however, a GET request does not fetch this parameter. NOTE: When you assignpasswords using FOS REST API, Unicode characters are counted as 2 characters and must betaken into consideration for password length.Flag: write-onlyType: brocade-security-type:user-password-typeValue: The 8 to 40 character account password. Note that the password must be encoded withthe Base64 encoding scheme.Optional: Yes

roleDescription: The account's role for all Logical Fabrics provided with the Logical Fabric list. Youcan assign any role (user-defined or default) to the account. When you create a user account inan Logical Fabric-enabled environment, you can specify only one role for the user. This role isassociated with each of the Logical Fabric IDs.Flag: read-writeType: brocade-security-type:user-config-role-typeValue: 4 to 16 alphanumeric characters that specify the account's role.Optional: Yes

account-descriptionDescription: A printable ASCII string that specifies the description for the new account. Toinclude spaces, place the description in double quotation marks. Note that colons are notpermitted.Flag: read-writeType: stringValue: 0 or 1 to 32 printable ASCII characters.Optional: Yes


Broadcom


account-enabledDescription: Whether the account is enabled or disabled. Note that once an account is disabled,the sessions associated with the account are terminated.Flag: read-writeType: booleanValue: true = The account is enabled. false = The account is disabled.Optional: Yes

password-change-enforcedDescription: Whether an expired password must be changed the first time the user logs into anew or modified account.Flag: read-writeType: booleanValue: true = The expired password must be changed the first time the user logs into a new ormodified account. false = The expired password does not need to be changed the first time theuser logs into a new or modified account.Optional: Yes

account-lockedDescription: Whether the user account is locked after several attempts to login with an invalidpassword.Flag: read-writeType: booleanValue: true = The user account is locked after several attempts to login with an invalid password.false = The user account is not locked after several attempts to login with an invalid password.Optional: Yes

access-start-timeDescription: The time, in 24 hour format, during which users can access the switch throughTelnet, SSH, console, or Web.Flag: read-writeType: stringValue: The time, in 24 hour format, during which users can access the switch through Telnet,SSH, console, or Web.Optional: Yes

access-end-timeDescription: The time, in 24 hour format, during which users can no longer access the switchthrough Telnet, SSH, console, or Web. This parameter is available only when the access starttime parameter (access-start-time) is configured.Flag: read-writeType: stringValue: The time, in 24 hour format, during which users can no longer access the switch throughTelnet, SSH, console, or Web.Optional: Yes

virtual-fabric-role-id-listDescription: A list of Virtual Fabrics roles and IDs to be added to the user account.Flag: read-writeThis container contains the following leaf:role-id

Description: The Virtual Fabrics to be added to the user account.Flag: read-writeType: brocade-security-type:virtual-fabric-role-id-typeValue: A valid Virtual Fabric role ID.


Broadcom


Optional: Yesauth-token-present

Description: Whether the authorization token is generated for this user.Flag: read-onlyType: booleanConfig: falseValues: true = The auth-token is available for this user. false = The auth-token is not generatedfor this user.Optional: Yes

auth-specDescription: Replaces the configuration with the specified AAA service.Flag: read-writeThis container contains the following leafs:authentication-mode

Description: The authentication mode for RADIUS, TACACS+, and LDAP.Flag: read-writeType: brocade-security-type:aaa-authspec-typeValue: One of the following supported authentication modes:local (default) = Authenticates management connections against the local database only.radius = Authenticates management connections against any RADIUS databases only.ldap = Authenticates management connections against any LDAP databases only.tacacs+ = Authenticates management connections against any TACACS+ databases only.radius;local = Authenticates management connections against any RADIUS databases first. IfRADIUS fails for any reason, authenticates against the local user database.radius;localbackup = Authenticates management connections against any RADIUS databases.If RADIUS fails because the service is not available, it then authenticates against the local userdatabase. This option directs the service to try the secondary authentication database only if theprimary authentication database is not available.tacacs+;local = Authenticates management connections against any TACACS+ databases first.If TACACS+ fails for any reason, it then authenticates against the local user database.tacacs+;localbackup = Authenticates management connections against any TACACS+databases first. If TACACS+ fails for any reason, it then authenticates against the local userdatabase. This option directs the service to try the secondary authentication database only if theprimary authentication database is not available.ldap;local = Authenticates management connections against any LDAP databases first. If LDAPfails for any reason, it then authenticates against the local user database.ldap;localbackup = Authenticates management connections against any LDAP databases first.If LDAP fails for any reason it then authenticates against the local user database. This optiondirects the service to try the secondary authentication database only if the primary authenticationdatabase is not available.Optional: Yes

activate-no-log-outDescription: Whether a change in the authentication mode results in existing sessions beinglogged out automatically. This parameter is available only when the authentication modeparameter (authentication-mode) is configured. You can set this parameter with a PATCH request;however, a GET request does not fetch this parameter.Flag: write-onlyType: booleanValue: true = There is no effect on existing sessions regardless of the chosen authenticationmode. false(default) = Terminates all existing sessions when the new authentication mode is oneof the following: RADIUS only, LDAP only, TACACS+ only, or Local.


Broadcom


Optional: Yesprimary-auth-log-messages

Description: Whether log messages for authentication failure display. This parameter is availableonly when the authentication mode parameter (authentication-mode) is configured.Flag: read-writeType: booleanValue: true = Log messages display for authentication failure. false = Log messages do notdisplay for authentication failure. The default is true.Optional: Yes

radius-serverDescription: The RADIUS server configuration.Flag: read-writeKey: serverThis container has the following leafs:server

Description: The IP address or server name in dot-decimal notation. If the specified server IPaddress or name already exists in the current configuration, the command fails and generates anerror. However, the command does not validate the server name against the IP address in theconfiguration. Make sure to avoid duplicate configuration of the same server, where you specifyone by server name and the other by IP address.Flag: read-writeType: inet:hostValue: A valid IP address or server name.Optional: Yes

portDescription: The RADIUS server port number.Flag: read-writeType: inet:port-numberValue: A valid port number. The default RADIUS server port number is 1812.Optional: Yes

secretDescription: The common secret between the switch and the RADIUS server. You can setthis parameter with a POST or PATCH request; however, a GET request does not fetch thisparameter.Flag:write-onlyType: stringValue: 8 to 40 alphanumeric characters. The default secret is sharedsecret. The secret must beencoded with the Base64 encoding scheme.Optional: Yes

timeoutDescription: The response timeout for the RADIUS server.Flag: read-writeType: brocade-security-type:aaa-timeout-typeValue: 1 to 30 seconds. The default response timeout is 3 seconds.Optional: Yes

authenticationDescription: The remote authentication protocol for the RADIUS server.Flag: read-writeType: union {brocade-security-type:aaa-protocols-type; string})Value: Valid protocols include pap, chap (default), and peap-mschapv2.


Broadcom


Optional: Yesencryption-type

Description: The encryption algorithm type for the RADIUS servers sharedsecret value.Flag: read-writeType: brocade-security-type:aaa-encryption-algorithm-typeValue: Valid algorithm types include none and aes256. The default is none.Optional: Yes

positionDescription: The position to which you want to move the RADIUS server. For example, if youchange the server position to 2 (where the old position was 5), the server is moved to position 2and any existing server at position 2 is moved to position 3.Flag: read-writeType: uint16Value: 1 to 5.Optional: Yes

tacacs-serverDescription: The TACACS+ server configuration.Flag: read-writeKey: serverThis container has the following leafs:server

Description: The IP address or server name in dot-decimal notation (including IPv6 hexadecimalquadruplets notation). If the specified server IP address or name already exists in the currentconfiguration, the command fails and generates an error. However, the command does notvalidate the server name against the IP address in the configuration. Make sure to avoid duplicateconfiguration of the same server, where you specify one by server name and the other by IPaddress.Flag: read-writeType: inet:hostValue: A valid IP address or server name.Optional: Yes

portDescription: The TACACS+ server port number.Flag: read-writeType: inet:port-numberValue: A valid port number. The default TACACS+ server port number is 49.Optional: Yes

secretDescription: The common secret between the switch and the TACACS+ server. You can setthis parameter with a POST or PATCH request; however, a GET request does not fetch thisparameter.Flag:write-onlyType: stringValue: 8 to 40 alphanumeric characters. The default secret is sharedsecret. The secret must beencoded with the Base64 encoding scheme.Optional: Yes

timeoutDescription: The response timeout for the TACACS+ server.Flag: read-writeType: brocade-security-type:aaa-timeout-type


Broadcom


Value: 1 to 30 seconds. The default response timeout is 3 seconds.Optional: Yes

authenticationDescription: The remote authentication protocol for the TACACS+ server.Flag: read-writeType: union (brocade-security-type:aaa-protocols-type and string)Value: Valid protocols include pap and chap (default).Optional: Yes

encryption-typeDescription: The encryption algorithm type for the TACACS+ servers sharedsecret value.Flag: read-writeType: brocade-security-type:aaa-encryption-algorithm-typeValue: Valid algorithm types include none and aes256. The default is none.Optional: Yes

positionDescription: The position to which you want to move the TACACS+ server. For example, if youset the position to 2 for a server (where the old position was 5), the server is moved to position 2and any existing server at position 2 is moved to position 3.Flag: read-writeType: uint16Value: 1 to 5.Optional: Yes

ldap-serverDescription: The LDAP server configuration.Flag: read-writeKey: serverThis container has the following leafs:server

Description: The IP address or server name in dot-decimal notation (including IPv6 hexadecimalquadruplets notation). If the specified server IP address or name already exists in the currentconfiguration, the command fails and generates an error. However, the command does notvalidate the server name against the IP address in the configuration. Make sure to avoid duplicateconfiguration of the same server, where you specify one by server name and the other by IPaddress.Flag: read-writeType: inet:hostValue: A valid IP address or server name.Optional: Yes

portDescription: The LDAP server port number.Flag: read-writeType: inet:port-numberValue: A valid port number. The default LDAP server port number is 389.Optional: Yes

domainDescription: The name of the active directory domain. For example, brocade.comFlag: read-writeType: inet:domain-nameValue: The fully qualified domain name or IP address. The default domain is local.Optional: Yes


Broadcom


timeoutDescription: The response timeout for the LDAP server.Flag: read-writeType: brocade-security-type:aaa-timeout-typeValue: 1 to 30 seconds. The default response timeout is 3 seconds.Optional: Yes

tls-modeDescription: The Transport Layer Security (TLS) mode for the LDAP server.Flag: read-writeType: brocade-security-type:ldap-tls-mode-typeValue: starttls = Enter to use StartTLS. ldaps = Enter to use LDAPS.Optional: Yes

positionDescription: The position to which you want to move the LDAP server. For example, if you setthe position to 2 for a server (where the old position was 5), the server is moved to position 2 andany existing server at position 2 is moved to position 3.Flag: read-writeType: uint16Value: 1 to 5.Optional: Yes

ldap-role-mapDescription: A list of the LDAP AD server role to default switch role mappings.Flag: read-writeKey: ldap-roleThis list contains the following leafs:ldap-role

Description: The LDAP role to be mapped to a default switch role. The role must be a valid ADserver role.Flag: read-writeType: stringValue: A valid AD server role. A maximum length of 64 printable ASCII characters. The followingcharacters are not allowed '/[]:;|=,+*?<>'.Optional: Yes

switch-roleDescription: The default switch role to be mapped to an LDAP role.For GET requests, this parameter also contains the virtual fabric role ID. The format is eithera string containing the switch user type or the switch user type with the virtual fabric roleID separated by a semicolon (;). For example a string can be user (switch user type) oruser=1-10;admin=11-128 (switch user type with the virtual fabric role ID separated by asemicolon)Flag: read-writeType: stringValue: A valid default switch role.Optional: Yes

home-virtual-fabricDescription: The account's home Virtual Fabric. If the ldap-role-map parameter value is notconfigured, a GET request fetches a 0 value.Flag: read-writeType: home-virtual-fabric-typeValue: A valid Virtual Fabric.


Broadcom


Optional: Yeschassis-access-role

Description: The account's access permissions regarding chassis-level commands.Flag: read-writeType: user-config-role-typeValue: A valid role for the account.Optional: Yes

sec-crypto-cfg-template-actionDescription: Allows you to perform actions on the crypto template files. You cannot overwrite or deletethe default templates; however, they can be uploaded, edited, and then downloaded with a differentname. You can use the default or user defined templates to applying or verifying crypto configurations.Flag: read-writeThis container has the following leafs:template-name

Description: The template name.Flag: read-writeType: brocade-security-type:sec-crypto-cfg-template-name-typeValue: The template name.Optional: Yes

actionDescription: The operation you want to perform.Flag: read-writeType: brocade-security-type:seccrypto-cfg-actions-typeValue: apply = Activates a default or user-defined template file. verify = Verifies the runningconfiguration against a required configuration specified in the template file. import = Importsa template file from a specified external host. export = Exports a template file to the specifiedexternal host.Note that the template name should not be same as any of the default template nameswhen importing or exporting the file. The default templates are as follows: default_generic,default_strong, default_fips, and default_cc.Optional: Yes

file-transfer-protocol-typeDescription: The file transfer protocol (SCP, SFTP, or FTP).Flag: read-writeType: brocade-security-type:sec-crypto-cfg-file-transfer-protocol-typeValue: One of the following valid file transfer protocols: scp, sftp, or ftp.Optional: Yes

sec-crypto-cfg-templateDescription: A list of available templates.Flag: read-onlyKey: nameConfig: falseThis list has the following leafs:name

Description: The template name.Flag: read-onlyType: brocade-security-type:sec-crypto-cfg-template-name-typeValue: The template name.Optional: Yes


Broadcom


templateDescription: The template content.Flag: read-onlyType: stringValue: The template content.Optional: Yes

sec-crypto-cfgDescription: The active sec-crypto configurations.Flag: read-onlyConfig: falseThis container has the following leafs:ssh-cipher

Description: The active SSH cipher configuration.Flag: read-onlyType: brocade-security-type:default-string-typeValue: The active SSH cipher configuration.Optional: Yes

ssh-kexDescription: The active SSH kex configuration.Flag: read-onlyType: brocade-security-type:default-string-typeValue: The active SSH kex configuration.Optional: Yes

ssh-macDescription: The active SSH mac configuration.Flag: read-onlyType: brocade-security-type:default-string-typeValue: The active SSH mac configuration.Optional: Yes

https-cipherDescription: The active HTTPS cipher configuration.Flag: read-onlyType: brocade-security-type:default-string-typeValue: The active HTTPS cipher configuration.Optional: Yes

https-tlsv13-cipherDescription: The active HTTPS TLSv1.3 cipher configuration.Flag: read-onlyType: brocade-security-type:default-string-typeValues: The active HTTPS TLSv1.3 cipher configuration.Optional: Yes

radius-cipherDescription: The active RADIUS cipher configuration.Flag: read-onlyType: brocade-security-type:default-string-typeValue: The active RADIUS cipher configuration.Optional: Yes

ldap-cipherDescription: The active LDAP cipher configuration.


Broadcom


Flag: read-onlyType: brocade-security-type:default-string-typeValue: The active LDAP cipher configuration.Optional: Yes

syslog-cipherDescription: The active syslog cipher configuration.Flag: read-onlyType: brocade-security-type:default-string-typeValue: The active syslog cipher configuration.Optional: Yes

https-tls-protocolDescription: The active HTTPS TLS protocol.Flag: read-onlyType: brocade-security-type:tls-protocol-typeValue: The active HTTPS TLS protocol.Optional: Yes

radius-tls-protocolDescription: The active RADIUS TLS protocol.Flag: read-onlyType: brocade-security-type:tls-protocol-typeValue: The active RADIUS TLS protocol.Optional: Yes

ldap-tls-protocolDescription: The active LDAP TLS protocol.Flag: read-onlyType: brocade-security-type:tls-protocol-typeValue: The active LDAP TLS protocol.Optional: Yes

syslog-tls-protocolDescription: The active Syslog TLS protocol.Flag: read-onlyType: brocade-security-type:tls-protocol-typeValue: The active Syslog TLS protocol.Optional: Yes

x509v3-validation-modeDescription: The X509v3 certificate validation mode type. X509v3 certificate validation permitsFabric OS to enable or disable certificate validation during certificate import and sessionestablishment. The following identifies the differences between Basic mode and Strict mode forX509v3 certificate validation.Basic mode• 'Certificate Sign' is not mandatory for 'KeyUsage' in a CA certificate.• OCSP validation for identity certificates is not performed.• 'BasicConstraints' field is not mandatory in a CA certificate.• 'CA:True' value is not mandatory in a CA certificate.• 'Digital Signature' is not mandatory for 'KeyUsage' in a identity certificate.• Audit logs for establishing and terminating TLS session are not printed.• SSH sessions with a switch, the 1GB data transfer limit is not enforced for rekeying.• For RADIUS, LDAP, or Syslog secure authentication using a certificate, a hostname mismatcherror is ignored.


Broadcom


• For RADIUS, LDAP, or Syslog secure authentication using a certificate, hostname validation isnot performed.• For RADIUS, LDAP, or Syslog secure authentication over TLS using a certificate, if there is ahostname mismatch error, no audit log entry is generated.Strict mode• 'Certificate Sign' is mandatory for 'KeyUsage' in a CA certificate.• OCSP validation for identity certificates is performed.• 'BasicConstraints' field is mandatory in a CA certificate.• 'CA:True' value is mandatory in a CA certificate.• 'Digital Signature' is mandatory for 'KeyUsage' in a identity certificate.• Audit log for establishing and terminating TLS session is printed for each TLS sessionestablished. In a switch this applies both as client and as server.• In SSH sessions with a switch, the 1GB data transfer limit is enforced for rekeying.• For RADIUS, LDAP, or Syslog secure authentication using a certificate, a hostname mismatcherror causes authentication failure o For RADIUS, LDAP, or Syslog secure authentication,hostname validation is enforced and a hostname mismatch error causes authentication failure(hostname resolution failure also causes authentication failure).• For RADIUS, LDAP, or Syslog secure authentication over TLS using a certificate, if there is ahostname mismatch error, an audit log entry is generated.Flag: read-onlyType: brocade-security-type:validation-mode-typeValue: The X509v3 certificate validation mode type: Basic or Strict.Optional: Yes

sshutilDescription: The allowed user configuration. This container is used to configure or display the alloweduser and to configure or display the SSH rekey interval.Flag: read-writeThis container has the following leafs:allow-user-name

Description: The user name. User names are case-sensitive and can contain up to 32alphanumeric characters, including periods (.) and underscores (_). For GET requests, this leaf isapplicable only for the default admin user account.Flag: read-writeType: brocade-security-type:user-config-user-name-typeValue: A valid user name.Optional: Yes

rekey-intervalDescription: The rekey duration in seconds.Flag: read-writeType: uint16Value: 900 to 3600 seconds. 0 to define no rekey interval.Optional: Yes

sshutil-known-hostDescription: The known host IP configuration.Flag: read-writeKey: remote-host-nameOptional: NoThis list has the following leafs:remote-host-name

Description: The IP address or FQDN of the remote host.Flag: read-write


Broadcom


Type: inet:hostValues: The IP address or FQDN of the remote host.Optional: No

key-typeDescription: The key type (rsa,dsa and ecdsa).Flag: read-onlyType: stringConfig: falseValues: The key type (rsa,dsa and ecdsa).Optional: Yes

host-keyDescription: The remote host key in the known hosts file.Flag: read-onlyType: stringConfig: falseValues: The remote host key in the known hosts file.Optional: Yes

fingerprint-listDescription: A list of fingerprints.Flag: read-writeOptional: NoThis list has has the following leaf:fingerprint

Description: The fingerprint of the remote host key. For a POST request, only 1 elementis allowed. For GET requests, the system fetches 5 elements.Flag: read-writeType: stringConfig: falseValues: The fingerprint of the remote host key.Optional: No

sshutil-keyDescription: A list of host, public, and private keys. This container is used to generate or delete hostkeys and public/private keypairs for outgoing SSH connections. This container is also used to display theswitch host keys.Flag: read-writeKeys: algorithm-type; key-typeThis list contains the following leafs:algorithm-type

Description: The algorithm type (rsa, dsa, or ecdsa).Flag: read-writeType: brocade-security-type:sshutil-algorithm-typeValue: The algorithm type: rsa, dsa, or ecdsa.Optional: Yes

key-typeDescription: The SSH utility key type (public-private-key or host-key).Flag: read-writeType: brocade-security-type:sshutil-key-typeValue: The SSH utility key type: public-private-key or host-key.Optional: Yes


Broadcom


passphraseDescription: The password for generating a key. A strong passphrase is 10 to 30 characterslong, fairly complex and difficult to guess and contains a mix of upper and lowercase letters,numbers, and nonalphanumeric characters. This parameter is available only when the key typeparameter is set to public-private-key (key-type=public-private-key).


Flag: write-onlyType: stringValue: 0 or 5 to 21242 alphanumeric characters. The passphrase must be encoded with theBase64 encoding scheme.Optional: Yes

sizeDescription: The size of the Host key.Flag: read-onlyType: uint16Value: 0 to 2048.Config: falseOptional: Yes

fingerprintDescription: The host key fingerprint installed in the switch.Flag: read-onlyType: stringValue: 0 to 1024 alphanumeric characters.Config: falseOptional: Yes

sshutil-public-keyDescription: A list of public keys. You can delete the public keys for a specified user or all users.Flag: read-writeKey: user-nameThis list contains the following leafs:user-name

Description: The user name. User names are case-sensitive and can contain up to 32alphanumeric characters, including periods (.) and underscores (_).Flag: read-writeType: brocade-security-type:user-config-user-name-typeValue: A user name. If you specify \"all\" as the user name, the public keys for all user accountsare deleted.Optional: Yes

public-keyDescription: The public key installed in the switch.Flag: read-onlyType: stringValue: The public key installed in the switch.Config: falseOptional: Yes

sshutil-public-key-actionDescription: The public key import and export container.Flag: read-write


Broadcom


This container has the follwoing leafs:action

Description: The import or export action to be performed on the public key. Imported publickeys are used for passwordless incoming SSH connections. Exported public keys are used forpasswordless outgoing SSH connections.Flag: read-writeType: brocade-security-type:sshutil-operation-typeValue: import = Imports a public key from a remote host to the local switch for a specified user.export = Exports a public key from a local switch to a remote host for a specified user.Optional: Yes

algorithm-typeDescription: The algorithm type (rsa, dsa, or ecdsa). The algorithm type is only available duringexport (action=export).Flag: read-writeType: brocade-security-type:sshutil-algorithm-typeValue: The algorithm type: rsa, dsa, or ecdsa.Optional: Yes

user-nameDescription: The user name. The user name is only available during import (action=import).Flag: read-writeType: brocade-security-type:user-config-user-name-typeValue: A user name.Optional: Yes

remote-user-nameDescription: The user name for the host.Flag: read-writeType: stringValue: The user name for the host .Optional: Yes

remote-host-ipDescription: The remote host IP address.Flag: read-writeType: stringValue: The remote host IP address.Optional: Yes

remote-user-passwordDescription: The password for the remote user.Flag: read-writeType: stringValue: The password for the remote user. The password must be encoded with Base64 encodingscheme.Optional: Yes

remote-directoryDescription: The remote directory fully qualified path name.Flag: read-writeType: stringValue: The remote directory fully qualified path name.Optional: Yes


Broadcom


public-key-nameDescription: The name of the file in which the public key is stored on the remote host. This is auser-generated file name that must have a .pub extension. The public key name is only availableduring import (action=import).Flag: read-writeType: stringValue: The public key file name.Optional: Yes

passwordDescription: The user account password container.Flag: read-writeThis container has the following leafs:user-name

Description: The user name. User names are case-sensitive and can contain up to 32alphanumeric characters, including periods (.) and underscores (_). Note that user name ismandatory parameter for changing the password.Flag: read-writeType: brocade-security-type:user-config-user-name-typeValue: A user name.Optional: No

old-passwordDescription: The old password for the user.Flag: read-writeType: brocade-security-type:user-password-typeValue: The old password for the user. The password must be encoded with Base64 encodingscheme.Optional: No

new-passwordDescription: The new password for the user. The password must be encoded with the Base64encoding scheme. Note that new password is mandatory parameter for changing the password.NOTE: When you assign passwords using FOS REST API, Unicode characters are counted as 2characters and must be taken into consideration for password length.Flag: read-writeType: brocade-security-type:user-password-typeValue: 1 to 40 characters encoded with the Base64 encoding scheme.Optional: Yes

security-certificate-generateDescription: Generates a self-signed web certificate for HTTPS support and a self-signed certificate forExtension. Creates Certificate Signing Requests (CSR) for HTTPS, FCAP, Commoncert, LDAP, RadiusSyslog, and Extension. NOTE: If you are generating a web certificate (certificate-type = https) and thereis an existing web certificate on the Fabric OS switch, an "400 Bad Request" response displays. You mustdelete the existing web certificate on the Fabric OS switch before generating a web certificate again.Flag: read-writeThis container has the following leafs:certificate-entity

Description: The certificate entity.Flag: read-writeType: brocade-security-type:gen-certificate-entity-type


Broadcom


Value: csr = The certificate-signing request entity. ca-client = The certificate authority (CA) cliententity. ca-server = The certificate authority (CA) server entity. switch = The switch certificateentity.Optional: No

certificate-typeDescription: The certificate type.Flag: read-writeType: brocade-security-type:certificate-application-typeValue: commoncert = The common certificate. https = The certificate for secure HTTP. radius= The certificate for Remote Authentication Dial-In User Service. ldap = The certificate forLightweight Directory Access Protocol. syslog = The certificate for syslog. fcap = The certificatefor Fibre Channel Authentication Protocol. extension = The certificate for Extension.Optional: Yes

algorithm-typeDescription: The algorithm type (rsa, dsa, or ecdsa). The ecdsa type is supported by https andextension only. The dsa type is not supported by fcap. For non-extension certificates, the defaultis rsa. For extension certificates, the default is ecdsa.Flag: read-writeType: brocade-security-type:sshutil-algorithm-typeValue: The algorithm type: rsa, dsa, or ecdsa. The default is rsa.Optional: Yes

key-sizeDescription: The size of the key in bytes. The greater the value, the more secure is theconnection; however, performance degrades with size. Specifying larger key sizes (4096+) mayrequire more switch processing time than some third-party REST applications have configured forrequest timeout, resulting in a 500 Internal Server Error result. Also, generating a larger key sizemay trigger CPU usage alerts in MAPS.Flag: read-writeType: brocade-security-type:keysize-typeValue: 1024, 2048, 4096, or 8192 bytes. For non-extension certificates, the default is 2048. Forextension certificates, the default is P384.Optional: Yes

hash-typeDescription: The hash type.Flag: read-writeType: brocade-security-type:seccertmgmt-hash-typeValue: sha1 = This Secure Hash Algorithm (SHA) generates a 160-bit (20-byte) hash value.sha256 = This SHA generates a unique, fixed size 256-bit (32-byte) hash. sha512 = ThisSHA uses 64 byte words. For non-extension certificates, the default is sha256. For extensioncertificates, the default is sha384.Optional: Yes

yearsDescription: The number of years for which the certificate is valid.Flag: read-writeType: uint16Value: 1 to 50 years. The default is 5 years.Optional: Yes

keypair-tagDescription: The keypair tag is a user-defined name used to uniquely identify a local certificate.This parameter is applicable only for Extension certificates (certificate-type = extension).


Broadcom


Flag: read-writeType: stringValues: The keypair tag is a user-defined name used to uniquely identify a local certificate.Optional: Yes

country-nameDescription: The country name. This parameter is available only when the certificate entity isconfigured as CSR (certificate-entity=CSR). Also note that if this parameter is present in a self-signed certificate, it is ignored.Flag: read-writeType: stringValue: The country name.Optional: Yes

state-nameDescription: The state name. This parameter is available only when the certificate entity isconfigured as CSR (certificate-entity=CSR). Also note that if this parameter is present in a self-signed certificate, it is ignored.Flag: read-writeType: stringValue: The state name.Optional: Yes

locality-nameDescription: The locality name. This parameter is available only when the certificate entity isconfigured as CSR (certificate-entity=CSR). Also note that if this parameter is present in a self-signed certificate, it is ignored.Flag: read-writeType: uint16Value: The .Optional: Yes

organization-nameDescription: The organization name. This parameter is available only when the certificate entityis configured as CSR (certificate-entity=CSR). Also note that if this parameter is present in a self-signed certificate, it is ignored.Flag: read-writeType: stringValue: The organization name.Optional: Yes

unit-nameDescription: The unit name. This parameter is available only when the certificate entity isconfigured as CSR (certificate-entity=CSR). Also note that if this parameter is present in a self-signed certificate, it is ignored.Flag: read-writeType: stringValue: The unit name.Optional: Yes

domain-nameDescription: The fully qualified domain name or IP address. This parameter is available onlywhen the certificate entity is configured as CSR (certificate-entity=CSR). Also note that if thisparameter is present in a self-signed certificate, it is ignored.Flag: read-writeType: string


Broadcom


Value: The fully qualified domain name or IP address.Optional: Yes

ip-address-in-subject-alternative-nameDescription: Whether the X509v3 Subject Alternative Name extension include the IP address.This parameter is available only when the certificate entity is configured as CSR (certificate-entity=CSR) and the certificate type is https, radius, ldap, or syslog (certificate-type=https|radius|ldap|syslog).Flag: read-writeType: booleanValue: true = Includes I address. false = Does not include IP address.Optional: Yes

security-certificate-actionDescription: The import, export, or delete action of third-party certificates on a switch, including PublicKey Infrastructure (PKI) based certificates, LDAP certificates, RADIUS certificates, syslog CA certificates,and Extension certificates.Flag: read-writeThis container has the following leafs:protocol

Description: The protocol type for import or export.Flag: read-writeType: brocade-security-type:seccertmgmt-protocol-typeValue: scp = The secure copy protocol. ftp = The file transfer protocol.Optional: Yes

certificate-entityDescription: The certificate entity.Flag: read-writeType: brocade-security-type:gen-certificate-entity-typeValue: csr = The certificate-signing request entity. switch = The switch certificate entity.Optional: Yes

certificate-typeDescription: The certificate type.Flag: read-writeType: brocade-security-type:certificate-application-typeValue: commoncert = The common certificate. https = The certificate for secure HTTP. radius= The certificate for Remote Authentication Dial-In User Service. ldap = The certificate forLightweight Directory Access Protocol. syslog = The certificate for syslog. fcap = The certificatefor FCAP. extension = The certificate for Exension. all = All certificates.Optional: Yes

certificate-nameDescription: The certificate name.Flag: read-writeType: stringValue: 5 to 128 alphanumeric characters plus hyphens, periods, and underscore characters.Optional: Yes

ca-certificateDescription: The preimported local CA certificate name. This parameter is only applicable forExtension certificates (certificate-type = extension).Flag: read-writeType: stringValues: The preimported local CA certificate name.


Broadcom


Optional: Yesoperation

Description: The security certificate operations (such as import or export).Flag: read-writeType: brocade-security-type:seccertmgmt-operation-typeValue: import = Import certificates from the server or to download a certificate issued by a CAafter sending the CSR to the CA. export = Export certificate to a host and a CSR to server to theCA that issues the certificate.Optional: Yes

keypair-tagDescription: The keypair tag is a user-defined name used to uniquely identify a local certificate.This parameter is only applicable for Extension certificates (certificate-type = extension).Flag: read-writeType: stringValues: The keypair tag is a user-defined name used to uniquely identify a local certificate.Optional: Yes

security-certificateDescription: A list of security certificates on a switch, including PKI-based certificates, LDAP certificates,RADIUS certificates, syslog CA certificates, and FCAP certificates. Note that this list does not includeextension related certificates, see the security-certificate-extension list.Flag: read-onlyKey: certificate-entity; certificate-typeThis list has the following leafs:certificate-entity

Description: The certificate entity.Flag: read-onlyType: brocade-security-type:gen-certificate-entity-typeValue: csr = The certificate-signing request entity. ca-client = The Certification Authority (CA)client entity. ca-server = The CA server entity. switch = The switch certificate entity.Optional: Yes

certificate-typeDescription: The certificate type.Flag: read-onlyType: brocade-security-type:certificate-application-typeValue: commoncert = The common certificate. https = The certificate for secure HTTP. radius= The certificate for Remote Authentication Dial-In User Service. ldap = The certificate forLightweight Directory Access Protocol. syslog = The certificate for syslog. fcap = The certificatefor FCAP. all = All certificates.Optional: Yes

certificateDescription: The CSR, CA-client, CA-server, or switch certificates installed on the switch.Flag: read-onlyType: stringValue: The CSR, CA-client, CA-server, or switch certificates installed on the switch.Optional: Yes

certificate-hexdumpDescription: The CSR, CA-client, CA-server, or switch certificates, in raw hex format, installed onthe switch.Flag: read-onlyType: string


Broadcom


Value: The CSR, CA-client, CA-server, or switch certificates, in raw hex format, installed on theswitch.Optional: Yes

security-certificate-extensionDescription: A list of Extension-related security certificates on a switch. The switch must be an Extensionswitch in Native mode.Flag: read-onlyOptional: NoThis list has the following leafs:certificate-entity

Description: The certificate entity (CSR, CA, or switch certificate).Flag: read-onlyType: brocade-security-type:certificate-entity-typeValues: csr = The certificate-signing request entity. ca = The certificate authority (CA) entity.switch = The switch certificate entity.Config: FalseOptional: Yes

local-certificateDescription: Whether the certificate is a local certificate. This is true when the certificate iscreated on the same switch. For example, when using self-signed certifcate or for a CA signedcertificate, when the CSR was generated locally for signing by the CA.Flag: read-onlyType: booleanValues: true = The certificate is local certificate. false = The certificate is a remote certificate.Config: FalseOptional: Yes

certificate-nameDescription: The CSR, CA, switch certificate name installed on the switch.Flag: read-onlyType: stringValues: The CSR, CA, switch certificate name installed on the switch.Config: FalseOptional: Yes

certificateDescription: The certificate details including issuer, signature, dates, and subject.Flag: read-onlyType: stringValues: The certificate details including issuer, signature, dates, and subject.Config: FalseOptional: Yes

keypair-tagDescription: A user-defined name used to uniquely identify a local certificate.Flag: read-onlyType: stringConfig: falseValues: A user-defined name used to uniquely identify a local certificate.Optional: Yes

certificate-hexdumpDescription: The CSR, CA or switch certificates, in raw hexadecimal format, installed on theswitch.


Broadcom


Flag: read-onlyType: stringConfig: falseValues: The CSR, CA or switch certificates, in raw hexadecimal format, installed on the switch.Optional: Yes

Supported Methods

Only the OPTIONS, HEAD, GET, PATCH, DELETE, and POST operations are supported in this module.

History



Fabric OS 9.0.0 This API call was modified to add the auth-token-present, https-tlsv13-cipher, keypair-tag, ip-address-in-subject-alternative-name, and ca-certificate parameters and the sshutil-known-host and security-certificate-extension lists.This API call was modified to make the traffic-type and passphrase leafs obsolete.

Fabric OS 9.0.1 This API called was modified to add the tls-mode parameter.


Broadcom


brocade-security ExamplesThis section provides examples for the brocade-security module.

It assumes a knowledge of System Security as performed in Fabric OS. For information on these topics, refer to theBrocade Fabric OS Administration Guide.

Viewing all IP Filter Policies

The following example uses the GET request to display all IP filter policies configured on the device. You can view aspecific rule in a specific IP filter policy configuration by specifying the IP filter policy and index number in the request (forexample, GET <base_URI>/running/brocade-security/ipfilter-policy/fwd_ipv4/index/1).

StructureGET <base_URI>/running/brocade-security/ipfilter-policyURI RequestGET https://10.10.10.10/rest/running/brocade-security/ipfilter-policy



<Response>

<ipfilter-policy>

<name>default_ipv4</name>

<ip-version>IPv4</ip-version>

<is-policy-active>true</is-policy-active>

<is-default-policy>true</is-default-policy>

</ipfilter-policy>

<ipfilter-policy>

<name>default_ipv6</name>


<is-policy-active>true</is-policy-active>

<is-default-policy>true</is-default-policy>

</ipfilter-policy>

<ipfilter-policy>

<name>fwd_ipv4</name>


<is-policy-active>false</is-policy-active>

<is-default-policy>false</is-default-policy>

</ipfilter-policy>

<ipfilter-policy>

<name>46RB7ATw0XsERUO2X5h</name>


<is-policy-active>false</is-policy-active>

<is-default-policy>false</is-default-policy>

</ipfilter-policy>

</Response>


Broadcom


Configuring an IP Filter Policy

The following example uses the POST request to configure a new IP filter policy on the device. You can use a PATCHrequest to edit an existing IP policy filter. Note that there is no transactional state for an IP filter policy request in RESTAPI like there is in CLI. Each request is saved before the REST API request is returned.

StructurePOST <base_URI>/running/brocade-security/ipfilter-policyURI RequestPOST https://10.10.10.10/rest/running/brocade-security/ipfilter-policy

Request Body

<ipfilter-policy>

<name>ipv4_new</name>


</ipfilter-policy>


Cloning an IP Filter Policy

The following example uses the PATCH request to clone IP filter policy test_policy with a new name destPolicy on thedevice. You can use a PATCH request to edit an existing IP policy filter. Note that there is no transactional state for an IPfilter policy request in REST API like there is in CLI. Each request is saved before the REST API request is returned.

StructurePATCH <base_URI>/running/brocade-security/ipfilter-policyURI RequestPATCH https://10.10.10.10/rest/running/brocade-security/ipfilter-policy

Request Body<ipfilter-policy>

<name>test_policy</name>

<action>clone</action>

<clone-destination-policy-name>destPolicy</clone-destination-policy-name>

</ipfilter-policy>


Activating an IP Filter Policy

The following example uses the PATCH request to activate the destPolicy IP filter policy on the device. Note that thereis no transactional state for an IP filter policy request in REST API like there is in CLI. Each request is saved before theREST API request is returned.

StructurePATCH <base_URI>/running/brocade-security/ipfilter-policy


Broadcom


URI RequestPATCH https://10.10.10.10/rest/running/brocade-security/ipfilter-policy

Request Body<ipfilter-policy>

<name>test_policy</name>

<action>activate</action>

</ipfilter-policy>


Deleting an IP Filter Policy

The following example uses the DELETE request to remove an IP filter policy from the device. You cannot delete a defaultIP filter policy. Note that there is no transactional state for an IP filter policy request in REST API like there is in CLI. Eachrequest is saved before the REST API request is returned.

StructureDELETE <base_URI>/running/brocade-security/ipfilter-policy/name/<policy_name>

URI RequestDELETE https://10.10.10.10/rest/running/brocade-security/ipfilter-policy/name/46RB7ATw0XsERUO2X5h


Viewing all IP Filter Rules

The following example uses the GET request to display all IP filter rules defined on the device. You can view a specificrule in an IP filter policy configuration by specifying the rule in the request (for example, GET <base_URI>/running/brocade-security/ipfilter-rule/policy-name/fwd_ipv4/index/1).

StructureGET <base_URI>/running/brocade-security/ipfilter-ruleURI RequestGET https://10.10.10.10/rest/running/brocade-security/ipfilter-rule

Request BodyNo request body is required.Response BodyWhen the operation is successful, the response has a message body similar to the following, and a “200 OK”status appears in the headers.<Response>

<ipfilter-rule>

<policy-name>default_ipv4</policy-name>

<index>1</index>


Broadcom


<source-ip>any</source-ip>

<destination-start-port>22</destination-start-port>

<destination-end-port>22</destination-end-port>

<protocol>tcp</protocol>

<permission>permit</permission>

<destination-ip>any</destination-ip>

</ipfilter-rule>

...

<ipfilter-rule>

<policy-name>46RB7ATw0XsERUO2X5h</policy-name>

<index>1</index>

<source-ip>177.171.183.217/30</source-ip>



<protocol>udp</protocol>


<destination-ip>243.112.59.242/0</destination-ip>

</ipfilter-rule>

</Response>

Configuring an IP Filter Rule

The following example uses the POST request to configure a new IP filter rule on the device. Note that there is notransactional state for an IP filter rule request in REST API like there is in CLI. Each request is saved before the REST APIrequest is returned.

StructurePOST <base_URI>/running/brocade-security/ipfilter-ruleURI RequestPOST https://10.10.10.10/rest/running/brocade-security/ipfilter-rule

Request Body<ipfilter-rule>

<policy-name>fwd_ipv4</policy-name>

<index>1</index>

<source-ip>any</source-ip>



<protocol>tcp</protocol>


<destination-ip>192.26.1.3</destination-ip>

</ipfilter-rule>



Broadcom


Deleting an IP Filter Rule

The following example uses the DELETE request to remove an IP filter rule from the device. You cannot delete a defaultIP filter rule. Note that there is no transactional state for an IP filter rule request in REST API like there is in CLI. Eachrequest is saved before the REST API request is returned.

StructureDELETE <base_URI>/running/brocade-security/ipfilter-rule/policy-name/policy_name/index/<index_number>URI RequestDELETE https://10.10.10.10/rest/running/brocade-security/ipfilter-rule/policy-name/fwd_ipv4/index/1


Viewing Password Configurations for All Users on a Device

The following example uses the GET request to display password configurations for all users on the device.

StructureGET <base_URI>/running/brocade-security/user-specific-password-cfgURI RequestGET https://10.10.10.10/rest/running/brocade-security/user-specific-password-cfg



<Response>

<user-specific-password-cfg>

<user-name>root</user-name>

<hash-type>SHA512</hash-type>

</user-specific-password-cfg>






<user-name>user</user-name>




<user-name>maintenance</user-name>



Broadcom




<user-name>robertREST</user-name>




<user-name>gumbo303</user-name>



</Response>

Configuring a Password Configuration for a New User

The following example uses the POST request to configure a new password configuration for a user. You can use aPATCH request to edit an existing password configuration for a user.

StructurePOST <base_URI>/running/brocade-security/user-specific-password-cfgURI RequestPOST https://10.10.10.10/rest/running/brocade-security/user-specific-password-cfg

Request Body


<user-name>newUser1</user-name>

<minimum-password-age>5</minimum-password-age>

<maximum-password-age>30</maximum-password-age>

<warn-on-expire>5</warn-on-expire>

<enforce-expire>false</enforce-expire>



Deleting a Password Configuration for a User on a Device

The following example uses the DELETE request to remove a user's password configuration from the device.

StructureDELETE <base_URI>/running/brocade-security/user-specific-password-cfg/user-name/<user_name>URI RequestDELETE https://10.10.10.10/rest/running/brocade-security/user-specific-password-cfg/user-name/

newUser1



Broadcom


Deleting All Password User Policies

The following example uses the PATCH request to remove the password policies for all users.

StructurePATCH <base_URI>/running/brocade-security/password-cfgURI RequestPATCH https://10.10.10.10/rest/running/brocade-security/password-cfg


<password-cfg>

<password-action>delete-all</password-action>

</password-cfg>


Viewing the Password Policy

The following example uses the GET request to display the password policy defined on a device.

StructureGET <base_URI>/running/brocade-security/password-cfgURI RequestGET https://10.10.10.10/rest/running/brocade-security/password-cfg



<Response>

<password-cfg>

<hash-type>sha512</hash-type>

<manual-hash-enabled>false</manual-hash-enabled>

<minimum-length>8</minimum-length>

<character-set>0</character-set>

<user-name-allowed>true</user-name-allowed>

<minimum-lower-case-character>0</minimum-lower-case-character>

<minimum-upper-case-character>0</minimum-upper-case-character>

<minimum-numeric-character>0</minimum-numeric-character>

<minimum-special-character>0</minimum-special-character>

<past-password-history>1</past-password-history>





Broadcom


<lock-out-threshold>0</lock-out-threshold>

<lock-out-duration>30</lock-out-duration>

<admin-lock-out-enabled>false</admin-lock-out-enabled>

<repeat-character-limit>1</repeat-character-limit>

<sequence-character-limit>1</sequence-character-limit>

<password-config-changed>false</password-config-changed>

<reverse-user-name-allowed>false</reverse-user-name-allowed>

<minimum-difference>0</minimum-difference>

</password-cfg>

</Response>

Viewing the Password Policy for a Specific User

The following example uses the GET request to display the password policy for a specified user.

StructureGET <base_URI>/running/brocade-security/user-specific-password-cfg/user-name/user_nameURI RequestGET https://10.10.10.10/rest/running/brocade-security/user-specific-password-cfg/user-name/Test1



<Response>


<user-name>Robert</user-name>






</Response>

Configuring the Password Policy

The following example uses the PATCH request to edit the current password configuration parameters. Note that while theexample below edits all editable parameters, you can be more specific in the parameters you want to edit. For example, toedit only the repeat and sequence character limits, use the following request body:

<password-cfg>

<repeat-character-limit>2</repeat-character-limit>

<sequence-character-limit>2</sequence-character-limit>

</password-cfg>

StructurePATCH <base_URI>/running/brocade-security/password-cfg


Broadcom


URI RequestPATCH https://10.10.10.10/rest/running/brocade-security/password-cfg

Request Body

<user-config>

<name>Test1</name>

<role>admin</role>

<account-description/>

<account-enabled>true</account-enabled>

<password-change-enforced>false</password-change-enforced>

<account-locked>false</account-locked>

<home-virtual-fabric>1</home-virtual-fabric>

<virtual-fabric-role-id-list>

<role-id>admin=1-128</role-id>

</virtual-fabric-role-id-list>

<chassis-access-role/>

<access-start-time/>

<access-end-time/>

</user-config>


Viewing User Configurations

The following example uses the GET request to display all user configurations on a device. You can view a specific user'sconfiguration by specifying the user name in the request (for example, GET <base_URI>/running/brocade-security/user-config/testuser).

StructureGET <base_URI>/running/brocade-security/user-configURI RequestGET https://10.10.10.10/rest/running/brocade-security/user-config



<Response>

<user-config>

<name>root</name>

<role>root</role>

<account-description>root</account-description>





Broadcom



<access-end-time/>

<auth-token-present>false</auth-token-present>

</user-config>

<user-config>

<name>admin</name>

<role>admin</role>

<account-description>Administrator</account-description>





<access-end-time/>


</user-config>

<user-config>

<name>user</name>

<role>user</role>

<account-description>User</account-description>





<access-end-time/>


</user-config>

<user-config>

<name>maintenance</name>

<role>maintenance</role>

<account-description>Maintenance</account-description>

<account-enabled>false</account-enabled>




<access-end-time/>


</user-config>

<user-config>

<name>gumbo303</name>

<role>admin</role>

<account-description/>





<access-end-time/>

<auth-token-present>true</auth-token-present>

</user-config>

</Response>


Broadcom


Configuring a New User/Editing an Existing User

The following example uses the POST request to create a new user on the device. You can use the PATCH request to editan existing user on the device.

StructurePOST <base_URI>/running/brocade-security/user-configURI RequestPOST https://10.10.10.10/rest/running/brocade-security/user-config

Request Body

<user-config>

<name>new_user</name>

<password>cGFzc3dvcmQ=</password>

<account-description>User</account-description>



<virtual-fabric-role-id-list>

<role-id>user=128</role-id>

</virtual-fabric-role-id-list>

<chassis-access-role>user</chassis-access-role>


<access-end-time/>

</user-config>


Viewing the Authentication Configuration

The following example uses the GET request to display the authentication mechanism for the device. For moreinformation about the possible authentication mechanisms, refer to authentication-mode in the Parameters section of thismodule.

StructureGET <base_URI>/running/brocade-security/auth-specURI RequestGET https://10.10.10.10/rest/running/brocade-security/auth-spec



<Response>

<auth-spec>

<authentication-mode>local</authentication-mode>


Broadcom


<primary-auth-log-messages>true</primary-auth-log-messages>

</auth-spec>

</Response>

Configuring the Authentication Configuration

The following example uses the PATCH request to make the following changes to authentication configuration:

• Change authentication-mode to 'radius;local'• Set the activate-no-log-out to 'true' (no effect on existing sessions regardless of the chosen authentication mode)• Set the primary-auth-log-messages to 'true' (log messages display for authentication failure)

StructurePATCH <base_URI>/running/brocade-security/auth-specURI RequestPATCH https://10.10.10.10/rest/running/brocade-security/auth-spec


<auth-spec>

<authentication-mode>radius;local</authentication-mode>

<activate-no-log-out>true</activate-no-log-out>

<primary-auth-log-messages>true</primary-auth-log-messages>

</auth-spec>


Viewing the RADIUS Server Configuration

The following example uses the GET request to display the current RADIUS server configuration.

StructureGET <base_URI>/running/brocade-security/radius-serverURI RequestGET https://10.10.10.10/rest/running/brocade-security/radius-server



<Response>

<radius-server>


<port>1812</port>

<timeout>3</timeout>


Broadcom


<authentication>chap</authentication>

<encryption-type>aes256</encryption-type>


</radius-server>

</Response>

Configuring a RADIUS Server

The following example uses the POST request to configure a RADIUS server. You can use the PATCH request to edit anexisting RADIUS server. This procedure assumes a knowledge of remote authentication as performed in Fabric OS. Forinformation on that topic, refer to the Brocade Fabric OS Administration Guide.

StructurePOST <base_URI>/running/brocade-security/radius-serverURI RequestPOST https://10.10.10.10/rest/running/brocade-security/radius-server

Request Body

<radius-server>


<port>1812</port>




</radius-server>


Deleting a RADIUS Server

The following example uses the DELETE request to remove a RADIUS server from the device.

StructureDELETE <base_URI>/running/brocade-security/radius-server/server/server_name

URI RequestDELETE https://10.10.10.10/rest/running/brocade-security/radius-server/server/1.2.3.4


Viewing the TACACS+ Server Configuration

The following example uses the GET request to display the current TACACS+ server configuration.


Broadcom


StructureGET <base_URI>/running/brocade-security/tacacs-serverURI RequestGET https://10.10.10.10/rest/running/brocade-security/tacacs-server



<Response>

<tacacs-server>


<port>49</port>





</tacacs-server>

<tacacs-server>


<port>49</port>





</tacacs-server>

<tacacs-server>


<port>49</port>





</tacacs-server>

<tacacs-server>


<port>49</port>





</tacacs-server>

</Response>


Broadcom


Configuring a TACACS+ Server

The following example uses the POST request to configure a TACACS+ server. You can use the PATCH request to edit anexisting TACACS+ server. This procedure assumes a knowledge of remote authentication as performed in Fabric OS. Forinformation on that topic, refer to the Brocade Fabric OS Administration Guide.

StructurePOST <base_URI>/running/brocade-security/tacacs-serverURI RequestPOST https://10.10.10.10/rest/running/brocade-security/tacacs-server

Request Body

<tacacs-server>


<port>49</port>




</tacacs-server>


Deleting a TACACS+ Server

The following example uses the DELETE request to remove a TACACS server from the device.

StructureDELETE <base_URI>/running/brocade-security/tacacs-server/server/server_name

URI RequestDELETE https://10.10.10.10/rest/running/brocade-security/tacacs-server/server/2.5.6.7


Viewing the LDAP Server Configuration

The following example uses the GET request to display the current LDAP server configuration.

StructureGET <base_URI>/running/brocade-security/ldap-serverURI RequestGET https://10.10.10.10/rest/running/brocade-security/ldap-server



Broadcom


Response BodyWhen the operation is successful, the response has a message body similar to the following, and a “200 OK”status appears in the headers.


<Response>

<ldap-server>


<port>38970</port>

<domain>brocadcom.com</domain>


<tls-mode>starttls</tls-mode>


</ldap-server>

</Response>

Configuring a LDAP Server

The following example uses the POST request to configure a LDAP server. You can use the PATCH request to edit anexisting LDAP server. This procedure assumes a knowledge of remote authentication as performed in Fabric OS. Forinformation on that topic, refer to the Brocade Fabric OS Administration Guide.

StructurePOST <base_URI>/running/brocade-security/ldap-serverURI RequestPOST https://10.10.10.10/rest/running/brocade-security/ldap-server

Request Body

<ldap-server>


<port>389</port>

<domain>local</domain>


<tls-mode>starttls</tls-mode>

</ldap-server>


Deleting a LDAP Server

The following example uses the DELETE request to remove a LDAP server from the device.

StructureDELETE <base_URI>/running/brocade-security/ldap-server/server_name

URI RequestDELETE https://10.10.10.10/rest/running/brocade-security/ldap-server/2.2.3.4



Broadcom



Viewing LDAP Role Mappings

The following example uses the GET request to display the current LDAP role mappings. This procedure assumes aknowledge of remote authentication as performed in Fabric OS. For information on that topic, refer to the Brocade FabricOS Administrator's Guide.

StructureGET <base_URI>/running/brocade-security/ldap-role-mapURI RequestGET https://10.10.10.10/rest/running/brocade-security/ldap-role-map



<Response>

<ldap-role-map>

<ldap-role>User1</ldap-role>

<switch-role>admin=1-128</switch-role>


<chassis-access-role/>

</ldap-role-map>

</Response>

Mapping LDAP Roles to Switch Roles

The following example uses the POST request to map the 'test_role4' LDAP role to 'admin' switch role. You can use aPATCH request to edit an existing LDAP mapping.

StructurePOST <base_URI>/running/brocade-security/ldap-role-mapURI RequestPOST https://10.10.10.10/rest/running/brocade-security/ldap-role-map

Request Body

<ldap-role-map>

<ldap-role>test_role4</ldap-role>

<switch-role>admin=1-110;user=111-115;operator=116;securityadmin=117-118</switch-role>


<chassis-access-role>admin</chassis-access-role>

</ldap-role-map>


Broadcom



Deleting a LDAP Role Mapping

The following example uses the DELETE request to remove the mapping between the 'test_role4' LDAP role from 'admin'switch role.

StructureDELETE <base_URI>/running/brocade-security/ldap-role-map/ldap-role/<ldap_role_name>

URI RequestDELETE https://10.10.10.10/rest/running/brocade-security/ldap-role-map/ldap-role/test_role4


Viewing the Security Crypto Configuration Templates

The following example uses the GET request to display SecCryptoCfg templates on the device. This procedure assumesa knowledge of SecCryptoCfg templates as used in Fabric OS. For information on that topic, refer to the Brocade FabricOS Administration Guide.

StructureGET <base_URI>/running/brocade-security/sec-crypto-cfg-templateURIGET https://10.10.10.10/rest/running/brocade-security/sec-crypto-cfg-template



<Response>

<sec-crypto-cfg-template>

<name>default_cc</name>

<template>[Ver] 0.2

[SSH]

Enc:aes128-cbc,aes256-cbc

Kex:diffie-hellman-group14-sha1,ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521

Mac:hmac-sha1,hmac-sha2-256,hmac-sha2-512

[AAA]

RAD_Ciphers:!ECDH:!DH:HIGH:-MD5:!CAMELLIA:!SRP:!PSK:!AESGCM:!3DES:!aNULL

LDAP_Ciphers:!ECDH:!DH:HIGH:-MD5:!CAMELLIA:!SRP:!PSK:!AESGCM:!3DES:!aNULL

RAD_Protocol:TLSv1.2


Broadcom


LDAP_Protocol:TLSv1.2

[LOG]

Syslog_Ciphers:!ECDH:!DH:HIGH:-MD5:!CAMELLIA:!SRP:!PSK:!AESGCM:!3DES:!aNULL

Syslog_Protocol:TLSv1.2

[HTTPS]

Ciphers:!ECDH:!DH:HIGH:-MD5:!CAMELLIA:!SRP:!PSK:!AESGCM:!3DES:!aNULL

Protocol:TLSv1.2

Ciphers_tlsv1.3:TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256

[X509v3]

Validation:Strict

</template>

</sec-crypto-cfg-template>


<name>default_strong</name>

<template>[Ver] 0.2

[SSH]

Enc:aes128-ctr,aes192-ctr,aes256-ctr

Kex:ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,diffie-hellman-group-exchange-

sha256,diffie-hellman-group14-sha256,diffie-hellman-group16-sha512,diffie-hellman-group18-

sha512,curve25519-sha256

Mac:hmac-sha2-256,hmac-sha2-512

[AAA]

RAD_Ciphers:ECDSA:ECDH:RSA:AES:3DES:!RSAPSK:!DHEPSK:!PSK:!DSS:!AESCCM8:!AESCCM:!ARIAGCM:!CAMELLIA:!

CHACHA20:!SEED:!RC4:!AEAD:!SHA1:!AESGCM

LDAP_Ciphers:ECDSA:ECDH:RSA:AES:3DES:!RSAPSK:!DHEPSK:!PSK:!DSS:!AESCCM8:!AESCCM:!ARIAGCM:!

CAMELLIA:!CHACHA20:!SEED:!RC4:!AEAD:!SHA1:!AESGCM



[LOG]

Syslog_Ciphers:ECDSA:ECDH:RSA:AES:3DES:!RSAPSK:!DHEPSK:!PSK:!DSS:!AESCCM8:!AESCCM:!ARIAGCM:!

CAMELLIA:!CHACHA20:!SEED:!RC4:!AEAD:!SHA1:!AESGCM


[HTTPS]

Ciphers:ECDSA:ECDH:RSA:AES:3DES:!RSAPSK:!DHEPSK:!PSK:!DSS:!AESCCM8:!AESCCM:!ARIAGCM:!CAMELLIA:!

CHACHA20:!SEED:!RC4:!AEAD:!SHA1:!AESGCM

Protocol:TLSv1.3


[X509v3]

Validation:Basic

</template>



<name>default_fips</name>

<template>[Ver] 0.2

[SSH]

Enc:aes128-ctr,aes192-ctr,aes256-ctr,aes128-cbc,3des-cbc,aes192-cbc,aes256-cbc

Kex:ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,diffie-hellman-group-exchange-sha256


[AAA]

RAD_Ciphers:!ECDH:!DH:HIGH:-MD5:!CAMELLIA:!SRP:!PSK:!AESGCM

LDAP_Ciphers:!ECDH:!DH:HIGH:-MD5:!CAMELLIA:!SRP:!PSK:!AESGCM




Broadcom


[LOG]

Syslog_Ciphers:!ECDH:!DH:HIGH:-MD5:!CAMELLIA:!SRP:!PSK:!AESGCM


[HTTPS]

Ciphers:!ECDH:!DH:HIGH:-MD5:!CAMELLIA:!SRP:!PSK:!AESGCM

Protocol:TLSv1.2


[FIPS]

SelfTests:yes

BootProm:yes

Zeroize:yes

Inside:yes

[X509v3]

Validation:Basic

</template>



<name>default_generic</name>

<template>[Ver] 0.2

[SSH]

Enc:aes128-ctr,aes192-ctr,aes256-ctr,aes128-cbc,3des-cbc,aes192-cbc,aes256-cbc

Kex:ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,diffie-hellman-group-exchange-

sha256,diffie-hellman-group-exchange-sha1,diffie-hellman-group14-sha1,diffie-hellman-group1-sha1


[AAA]

RAD_Ciphers:ECDSA:ECDH:RSA:AES:3DES:!RSAPSK:!DHEPSK:!PSK:!DSS:!AESCCM8:!AESCCM:!ARIAGCM:!CAMELLIA:!

CHACHA20:!SEED:!RC4

LDAP_Ciphers:ECDSA:ECDH:RSA:AES:3DES:!RSAPSK:!DHEPSK:!PSK:!DSS:!AESCCM8:!AESCCM:!ARIAGCM:!

CAMELLIA:!CHACHA20:!SEED:!RC4

RAD_Protocol:Any

LDAP_Protocol:Any

[LOG]

Syslog_Ciphers:ECDSA:ECDH:RSA:AES:3DES:!RSAPSK:!DHEPSK:!PSK:!DSS:!AESCCM8:!AESCCM:!ARIAGCM:!

CAMELLIA:!CHACHA20:!SEED:!RC4

Syslog_Protocol:Any

[HTTPS]

Ciphers:ECDSA:ECDH:RSA:AES:3DES:!RSAPSK:!DHEPSK:!PSK:!DSS:!AESCCM8:!AESCCM:!ARIAGCM:!CAMELLIA:!

CHACHA20:!SEED:!RC4

Protocol:Any


[X509v3]

Validation:Basic

</template>


</Response>

Viewing the Security Crypto Configuration

The following example uses the GET request to display the active security crypto configuration on the device.

StructureGET <base_URI>/running/brocade-security/sec-crypto-cfg


Broadcom


URIGET https://10.10.10.10/rest/running/brocade-security/sec-crypto-cfg

Request BodyNo request body is required.Response BodyWhen the operation is successful, the response has a message body similar to the following, and a “200 OK”status appears in the headers.<?xml version="1.0"?>

<Response>

<sec-crypto-cfg>

<ssh-cipher>aes128-ctr,aes192-ctr,aes256-ctr,aes128-cbc,3des-cbc,aes192-cbc,aes256-cbc</

ssh-cipher>

<ssh-kex>ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,diffie-hellman-group-

exchange-sha256,diffie-hellman-group-exchange-sha1,diffie-hellman-group14-sha1,diffie-hellman-

group1-sha1</ssh-kex>

<ssh-mac>hmac-md5,hmac-sha1,hmac-sha2-256,hmac-sha2-512</ssh-mac>

<https-cipher>!ECDH:!DH:HIGH:-MD5:!CAMELLIA:!SRP:!PSK:!AESGCM</https-cipher>

<https-tlsv13-

cipher>TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256</https-tlsv13-

cipher>

<radius-cipher>!ECDH:!DH:HIGH:-MD5:!CAMELLIA:!SRP:!PSK:!AESGCM</radius-cipher>

<ldap-cipher>!ECDH:!DH:HIGH:-MD5:!CAMELLIA:!SRP:!PSK:!AESGCM</ldap-cipher>

<syslog-cipher>!ECDH:!DH:HIGH:-MD5:!CAMELLIA:!SRP:!PSK:!AESGCM</syslog-cipher>

<https-tls-protocol>any</https-tls-protocol>

<radius-tls-protocol>any</radius-tls-protocol>

<ldap-tls-protocol>any</ldap-tls-protocol>

<syslog-tls-protocol>any</syslog-tls-protocol>

<x509v3-validation-mode>basic</x509v3-validation-mode>

</sec-crypto-cfg>

</Response>

Importing a SecCryptoCfg Template

The following example uses the PATCH request to import a template file from a specified external host. This procedureassumes a knowledge of SecCryptoCfg templates as used in Fabric OS. For information on that topic, refer to theBrocade Fabric OS Administration Guide.

Note that the password used in this example is Base64 encoded.

StructurePATCH <base_URI>/running/brocade-security/sec-crypto-cfg-template-actionURI RequestPATCH https://10.10.10.10/rest/running/brocade-security/sec-crypto-cfg-template-action

Request Body

<sec-crypto-cfg-template-action>

<template-name>Test1</template-name>

<action>import</action>

<file-transfer-protocol-type>scp</file-transfer-protocol-type>


Broadcom


<remote-user-name>rdpuser</remote-user-name>

<remote-host-ip>10.10.10.10</remote-host-ip>

<remote-user-password>U2lsYfraW4xMjM=</remote-user-password>

<remote-directory>/directory1/directory2/BSI_config_plusGCM.txt</remote-directory>

</sec-crypto-cfg-template-action>


Exporting a SecCryptoCfg Template

The following example uses the PATCH request to exports a template file to the specified external host. This procedureassumes a knowledge of SecCryptoCfg templates as used in Fabric OS. For information on that topic, refer to theBrocade Fabric OS Administration Guide.


StructurePATCH <base_URI>/running/brocade-security/sec-crypto-cfg-template-actionURIPATCH https://10.10.10.10/rest/running/brocade-security/sec-crypto-cfg-template-action

Request BodyThis request body shows an example using SCP.


<template-name>default_cc/template-name>

<action>export</action>

<remote-user-name>brocade</remote-user-name>

<remote-host-ip>10.70.12.10<remote-host-ip>


<remote-directory>/users/home40/brocade</remote-directory>

<file-transfer-protocol-type>scp</file-transfer-protocol-type>


This request body shows an example using FTP.


<template-name>default_cc</template-name>


<file-transfer-protocol-type>ftp</file-transfer-protocol-type>

<remote-user-name>ftpuser</remote-user-name>


<remote-user-password>cdd2FuZXJh</remote-user-password>

<remote-directory>dir1/dir2/my_template.txt</remote-directory>




Broadcom


Activating a SecCryptoCfg Template

You can activate a default or user-defined template files. The following example uses the PATCH request to activate thedefault 'default_cc' template file. This procedure assumes a knowledge of SecCryptoCfg templates as used in Fabric OS.For information on that topic, refer to the Brocade Fabric OS Administration Guide.


Request Body


<template-name>default_cc</template-name>

<action>apply</action>



Verifying a SecCryptoCfg Template

The following example uses the PATCH request to verify the running configuration against a required configurationspecified in the template file. This procedure assumes a knowledge of SecCryptoCfg templates as used in Fabric OS. Forinformation on that topic, refer to the Brocade Fabric OS Administrator's Guide.


Request Body


<template-name>default_strong</template-name>

<action>verify</action>


Response BodyWhen the operation is successful, the response has an empty message body and a “204 No Content” statusmessage. When the operation is not successful, the response has a “Verify failed” message body and a “400Bad Request” status message.

Viewing the Allowed User and Rekey Interval Configuration

The following example uses the GET request to display the allowed user and rekey interval configuration.

StructureGET <base_URI>/running/brocade-security/sshutil


Broadcom


URIGET https://10.10.10.10/rest/running/brocade-security/sshutil



<Response>

<sshutil>

<allow-user-name>admin</allow-user-name>

<rekey-interval>90</rekey-interval>

</sshutil>

</Response>

Configuring a User for Public Key and Rekey Interval Configuration

The following example uses a PATCH request to change the allowed user for sshutil operations and the rekey interval.

StructurePATCH <base_URI>/running/brocade-security/sshutilURIPATCH https://10.10.10.10/rest/running/brocade-security/sshutil

Request Body

<sshutil>

<allow-user-name>admin</allow-user-name>

<rekey-interval>0</rekey-interval>

</sshutil>


Viewing Host Keys

The following example uses the GET request to display the host keys on the device.

StructureGET <base_URI>/running/brocade-security/sshutil-keyURIGET https://10.10.10.10/rest/running/brocade-security/sshutil-key



Broadcom


Response BodyWhen the operation is successful, the response has a message body similar to the following, and a “200 OK”status appears in the headers.


<Response>

<sshutil-key>

<algorithm-type>rsa</algorithm-type>

<key-type>host-key</key-type>

<size>2048</size>

<fingerprint>SHA256:bicvymiohvGI3Xec8YEwwURKoL8kO6LNIc7fArHwzsU</fingerprint>

</sshutil-key>

<sshutil-key>

<algorithm-type>dsa</algorithm-type>


<size>1024</size>

<fingerprint>SHA256:ShHm7+RWvHo5aSm0igGkbcBbW8JJIeB6Jrm9FH8SuXw</fingerprint>

</sshutil-key>

<sshutil-key>

<algorithm-type>ecdsa</algorithm-type>


<size>256</size>

<fingerprint>SHA256:o7hCS9vaMJVzw/lDkSlGGwVDSyYXdMt3c0A+GtNfH8c</fingerprint>

</sshutil-key>

</Response>

Generating a Host Key

The following example uses the POST request to generate and install an 'ecdsa' Host key on the device.

StructurePOST <base_URI>/running/brocade-security/sshutil-keyURIPOST https://10.10.10.10/rest/running/brocade-security/sshutil-key

Request Body

<sshutil-key>

<algorithm-type>ecdsa</algorithm-type>


</sshutil-key>

Response BodyWhen the operation is successful, the response has an empty message body and a “201 Created” statusappears in the headers.

Deleting a Host Key

The following example uses the DELETE request to remove the 'rsa' Host key from the device.

StructureDELETE <base_URI>/running/brocade-security/sshutil-key/


Broadcom


URIDELETE https://10.10.10.10/rest/running/brocade-security/sshutil-key/

Request Body

{

"sshutil-key": {

"algorithm-type": "rsa",

"key-type": "host-key"

}

}


Generating a Private Key

The following example uses the POST request to generate and install an 'dsa' private key on the device.

Note that the passphrase used in this example is Base64 encoded.

StructurePOST <base_URI>/running/brocade-security/sshutil-keyURIPOST https://10.10.10.10/rest/running/brocade-security/sshutil-key

Request Body

<sshutil-key>


<key-type>public-private-key</key-type>

</sshutil-key>

Response BodyWhen the operation is successful, the response has an empty message body and a “201 Created” statusappears in the headers.

Deleting a Private Key

The following example uses the DELETE request to remove a private key 'dsa' from the device.

StructureDELETE <base_URI>/running/brocade-security/sshutil-key/URIDELETE https://10.10.10.10/rest/running/brocade-security/sshutil-key/

Request Body

{

"sshutil-key": {


Broadcom


"key-type": "public-private-key",

"algorithm-type": "dsa"

}

}


Viewing Public Keys

The following example uses the GET request to display public keys on a device.

StructureGET <base_URI>/running/brocade-security/sshutil-public-key/user-name/<user_name>URIGET https://10.10.10.10/rest/running/brocade-security/sshutil-public-key/user-name/admin


{

"Response": {

"sshutil-public-key": {

"user-name": "admin",

"public-key": "ecdsa-sha2-nistp384

AAAAE2VjZHNhLXNoYTItbmlzdHAzODQAAAAIbmlzdHAzODQAAABhBHvXyLFlHfdrs4a6RDPZeGfGQqM/0GyEbXijWsrViLf0EOTQmEztrU/

OuxUSFMgwxXo4rXHCJ4pqvweyQU5e2n2PiKF8LWmJaFUNv+EkGByNyfYJDxP2lED6ni+zBPGD0w==

[email protected]

.com\nssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA9YcFcZTo/WU20BbMe6lRuXeU7hpeE8LakVxkZenDUKINsxEgZLKf/

Kf7Y6Q2NW6HG

M8bWjG0JfJJd9AEj4fMyANntArI6D7ShjAbH7dp0dDMGyN+B7D5TTI2COSFD6W9RBLU70Gq+68vZxjh4Uq

+r7aidhDbrLTWb4evvSi1h/Nz

7Q11DrPPqQdUnYALTK3zIC/W3W8PkwbVYq8bIaowtuBanFUd1k3VG/eBN6Ua7tGBQOe6OHNMowjxWu46IfXJ

+M6qIdsNIwontxhiOfn5fRh

p86U5JYlI12FyF7z7ovs3QJHO3D9VGQxqnL+qO+ltqtXk/b1HAGsOollhGaSqpw== [email protected]

\n"

}

}

}

Deleting a Public Key for a User

The following example uses the DELETE request to remove all imported public keys for a single user 'testuser'.

StructureDELETE <base_URI>/running/brocade-security/sshutil-public-key/user-name/<user_name>


Broadcom


URIDELETE https://10.10.10.10/rest/running/brocade-security/sshutil-public-key/user-name/testuser


Importing a Public Key from a Remote Host

The following example uses the PATCH request to import a public key from a remote host using the following parameters:

• action = import• user-name = auserlocal• remote-user-name = auserremote• remote-host-ip = 11.11.11.11• remote-user-password = U2lsYfraW4xMjM=• remote-directory = ~auser/.ssh• public-key-name = out_going.pub


StructurePATCH <base_URI>/running/brocade-security/sshutil-public-key-actionURIPATCH https://10.10.10.10/rest/running/brocade-security/sshutil-public-key-action

Request Body

<sshutil-public-key-action>


<user-name>auserlocal</user-name>

<remote-user-name>auserremote</remote-user-name>



<remote-directory>~auser/.ssh</remote-directory>

<public-key-name>in_coming.pub</public-key-name>

</sshutil-public-key-action>


Adding a Remote Host Key to a Known Host File

The following example uses the POST request to add a remote host key to a known host file.

StructurePOST <base_URI>/running/brocade-security/sshutil-known-host


Broadcom


URIPOST https://10.10.10.10/rest/running/brocade-security/sshutil-known-host

Request Body

<sshutil-known-host>

<remote-host-name>10.155.54.69</remote-host-name>

<fingerprint-list>

<fingerprint>SHA256:cf+cnhsrbNfCSLPgqFCK5pet/TGXl9qCxNFWi0sAyik</fingerprint>

</fingerprintlist>

</sshutil-known-host>


Exporting a Public Key to a Remote Host

Before you export a public key you must generate the private/public key pair on the local switch. The following exampleuses the PATCH request to export a public key to a remote host using the following parameters:

• action = export• algorithm-type = rsa• user-name = auserlocal• remote-user-name = auserremote• remote-host-ip = 11.11.11.11• remote-user-password = U2lsYfraW4xMjM=• remote-directory = ~auser/.ssh


StructurePATCH <base_URI>/running/brocade-security/sshutil-public-key-actionURIPATCH https://10.10.10.10/rest/running/brocade-security/sshutil-public-key-action

Request Body












Broadcom


Configuring a User Password

The following example uses the PATCH request to change the password for a user.


StructurePATCH <base_URI>/running/brocade-security/passwordURIPATCH https://10.10.10.10/rest/running/brocade-security/password

Request Body

<password>

<user-name>testuser</user-name>

<old-password>cGFzc3dvcmQ=</old-password>

<new-password>c3VubnlzaWRlMTIz</new-password>

</password>


Generating a Third-Party Security Certificate Request on the Switch

The following example uses the POST request to generate a third-party certificate request on the switch.

NOTEIf you are generating a web certificate (certificate-type = https) and there is an existing web certificate on theFabric OS switch, an "400 Bad Request" response displays. You must delete the existing web certificate on theFabric OS switch before generating a web certificate again.

StructurePOST <base_URI>/running/brocade-security/security-certificate-generateURIPOST https://10.10.10.10/rest/running/brocade-security/security-certificate-generate

Request Body

<security-certificate-generate>


<certificate-entity>csr</certificate-entity>

<certificate-type>https</certificate-type>


<key-size>2048</key-size>

<years>10</years>

<country-name>US</country-name>

<state-name>Colorado</state-name>

<locality-name>Broomfield</locality-name>

<organization-name>Brocade</organization-name>

<unit-name>SQA</unit-name>

<domain-name>myswitch.brocade.com</domain-name>

<ip-address-in-subject-alternative-name>0</ip-address-in-subject-alternative-name>


Broadcom


</security-certificate-generate>


Generating a Self-Signed Security Certificate on the Switch

The following example uses the POST request to generate a third-party certificate on the switch.

NOTEIf you are generating a web certificate (certificate-type = https) and there is an existing web certificate on theFabric OS switch, an "400 Bad Request" response displays. You must delete the existing web certificate on theFabric OS switch before generating a web certificate again.

StructurePOST <base_URI>/running/brocade-security/security-certificate-generateURIPOST https://10.10.10.10/rest/running/brocade-security/security-certificate-generate

Request Body



<certificate-entity>cert</certificate-entity>






Importing a Security Certificate

The following example uses the PATCH request to import a certificate.


StructurePATCH <base_URI>/running/brocade-security/security-certificate-action/URI

PATCH https://10.10.10.10/rest/running/brocade-security/security-certificate-action/


<security-certificate-action>

<remote-user-name>TestUser</remote-user-name>


<remote-user-password>U2lsY67W4xMjM=</remote-user-password>


Broadcom


<remote-directory>/directory1/directory2</remote-directory>


<certificate-entity>ca-server</certificate-entity>


<certificate-name>Quad-Goodtertiary-Intermediate-root.pem</certificate-name>

<operation>import</operation>

</security-certificate-action>





<remote-user-password>U2lsY67W4xMjM=</remote-user-password>

<remote-directory>directory1/directory2/</remote-directory>




<certificate-name>Quad-Goodtertiary-Intermediate-root.pem</certificate-name>




Exporting a Security Certificate

The following example uses the PATCH request to export a certificate.


StructurePATCH <base_URI>/running/brocade-security/security-certificate-action/URI

PATCH https://10.10.10.10/rest/running/brocade-security/security-certificate-action/



<remote-user-name>Test2</remote-user-name>


<remote-user-password>U2lsYWRta56MjM=</remote-user-password>

<remote-directory>/directory1/directory2/</remote-directory>




<operation>export</operation>




Broadcom





<remote-user-password>c2FuZ34XJh</remote-user-password>

<remote-directory>directory1/directory2</remote-directory>


<certificate-entity>ca-client</certificate-entity>

<certificate-type>fcap</certificate-type>

<operation>export</operation>



Deleting a Security Certificate

The following example uses the DELETE request to delete security certificate from the device.

StructureDELETE <base_URI>/running/brocade-security/security-certificate-actionURIDELETE https://10.10.10.10/rest/running/brocade-security/security-certificate-action

Request Body



<certificate-type>ldap</certificate-type>



Viewing all Security Certificates on a Device

The following example uses the GET request to view all certificates on a switch '10.10.10.10'.

StructureGET <base_URI>/running/brocade-security/security-certificateURIGET https://10.10.10.10/rest/running/brocade-security/security-certificate




Broadcom


<Response>

<security-certificate>


<certificate-type>commoncert</certificate-type>

<certificate/>

<certificate-hexdump/>

</security-certificate>



<certificate-type>radius</certificate-type>

<certificate/>






<certificate/>





<certificate-type>syslog</certificate-type>

<certificate/>






<certificate/>






<certificate/>






<certificate/>






<certificate/>






<certificate/>


Broadcom







<certificate/>






<certificate/>






<certificate/>






<certificate/>






<certificate/>






<certificate/>






<certificate/>






<certificate>Issued To

countryName = US

stateOrProvinceName = California

localityName = San Jose

organizationName = Brocade

organizationalUnitName = Eng


Broadcom


commonName = 10.38.66.243

Issued By

countryName = US

stateOrProvinceName = California

localityName = San Jose

organizationName = Brocade

organizationalUnitName = Eng

commonName = 10.38.66.243

Period Of Validity

Begins On Mar 2 18:28:08 2020 GMT

Expires On Mar 1 18:28:08 2025 GMT

Fingerprints

SHA1 Fingerprint 98:13:36:DE:A7:8F:7E:1F:05:69:95:92:02:F4:3C:59:F9:3B:2D:D4

SHA256 Fingerprint

A6:9F:A4:0E:99:2A:1E:A5:2C:F0:F7:77:85:B2:61:2D:EC:B2:56:A0:43:48:5F:A2:05:3D:6D:04:22:36:ED:BB

Crypto Algorithm

Signature Algorithm sha256WithRSAEncryption

Public Key Algorithm rsaEncryption

Public-Key 2048 bit

</certificate>

<certificate-hexdump>-----BEGIN CERTIFICATE-----

MIIEejCCA2KgAwIBAgIUbXQr0pOicEo6R0PoGBUaGHIhDn8wDQYJKoZIhvcNAQEL

BQAwbDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCkNhbGlmb3JuaWExETAPBgNVBAcT

CFNhbiBKb3NlMRAwDgYDVQQKEwdCcm9jYWRlMQwwCgYDVQQLEwNFbmcxFTATBgNV

BAMTDDEwLjM4LjY2LjI0MzAeFw0yMDAzMDIxODI4MDhaFw0yNTAzMDExODI4MDha

MGwxCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlhMREwDwYDVQQHEwhT

YW4gSm9zZTEQMA4GA1UEChMHQnJvY2FkZTEMMAoGA1UECxMDRW5nMRUwEwYDVQQD

EwwxMC4zOC42Ni4yNDMwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCt

WICnqujYuqx/0P2CIC7UPUlIcA5dSjwKRxhP+ZCzyj3cnwID0BH0OIY1uP/gbO+H

pYezmakXZ1jdPS7vRy/2tW2Y9Kt1sR2yVUEpYLH4p7xWXVImGjnQ3vTiGu5memn4

FacTioXze+SSQ2DdbcJICSuBt2pkNHs4Kyhl5kof5VbxGqT4MlzHf8ILsYmx2wDL

XiCp1td8amAESsGW6TgHn/R+SB77Q1gAtA85lMazbJSWwC4FIZk2P5getjPhOjXA

+unGFFonNLZTj0n94+qek2mjzFnMrAe9t7atu68Uef0q82bgIK8M+R6vZZ+g56tf

PGf4K44bXEQmn6C9Q1plAgMBAAGjggESMIIBDjAJBgNVHRMEAjAAMBEGCWCGSAGG

+EIBAQQEAwIGQDAdBgNVHQ4EFgQUkN/rw0+JLaiE5/rtuazaPUeCVVswgakGA1Ud

IwSBoTCBnoAUkN/rw0+JLaiE5/rtuazaPUeCVVuhcKRuMGwxCzAJBgNVBAYTAlVT

MRMwEQYDVQQIEwpDYWxpZm9ybmlhMREwDwYDVQQHEwhTYW4gSm9zZTEQMA4GA1UE

ChMHQnJvY2FkZTEMMAoGA1UECxMDRW5nMRUwEwYDVQQDEwwxMC4zOC42Ni4yNDOC

FG10K9KTonBKOkdD6BgVGhhyIQ5/MA4GA1UdDwEB/wQEAwICpDATBgNVHSUEDDAK

BggrBgEFBQcDATANBgkqhkiG9w0BAQsFAAOCAQEAR0FCAHIHbV6QTfZbJd6OilPw

NJnVqc9cSXL3G4q3wVHKIw3Yyd1Z9tIvMzIequZt4Fj8RnpbhgaxBnbPS80s6urv

6vl58lovIidmiEMfkQ39n/TFlLvwrKaZvZnA1Hx73pAMvC4TeZZFH9cEMBIrCEpU

FIbXlEAtDEeMJVU92WaBm6s0j+bu7RxFGqshHEk8Zga+DVdvcZb2XUXIE0kPIOgm

XcFShGKGiVbZWyS54HlbnP5buIsSTdb7wnJUOwWO2SVvyvnJ5VeiqCQw6lJIqAcO

h04YuY13lYhan7IWcb9W9GMr1wEcjpmd5S8zBU5HJNQXnxeV51xwgbP/KVY/2Q==

-----END CERTIFICATE-----

</certificate-hexdump>





<certificate/>



Broadcom






<certificate/>






<certificate/>






<certificate/>



</Response>

Viewing the Extension Certificates

This example uses a GET request to view the Extension certificates on a switch.

Structure

GET <base_URI>/running/brocade-security/security-certificate-extension

URI

GET https://10.10.10.10/rest/running/brocade-security/security-certificate-extension

Request Body


Response Body



<Response>

<security-certificate-extension>


<certificate-name>MyPKIcert.csr</certificate-name>

<certificate> Issued To:

countryName = US

stateOrProvinceName = Colorado

localityName = Broomfield

organizationName = Broadcom

organizationalUnitName = BSN

commonName = MyPKIcert

Public Key Algorithm: id-ecPublicKey

Public-Key: (384 bit)

X509v3 Subject Key Identifier:


Broadcom


A3:E5:5D:BC:43:D7:B6:D6:40:8E:F1:01:92:0E:80:97:TT:B4:4D:24

X509v3 Key Usage: critical

Digital Signature, Non Repudiation

</certificate>

<certificate-hexdump>-----BEGIN CERTIFICATE REQUEST-----

MIIBojCCASkCAQAwajELMAkGA1UEBhMCVVMxETAPBgNVBAgMCENvbG9yYWRvMRMw

EQYDVQQHDApCcm9vbWZpZWxkMREwDwYDVQQKDAhCcm9hZGNvbTEMMAoGA1UECwwD

QlNOMRIwEAYDVQQDDAlNeVBLSWNlcnQwdjAQBgcqhkjOPQIBBgUrgQQAIgNiAARL

QDA+BgkqhkiG9w0BCQ4xMTAvMB0GA1UdDgQWBBTD5V28Q6e21kCN8QGSDoCX+rRN

JDAOBgNVHQ8BAf8EBAMCBsAwCgYIKoZIzj0EAwMDZwAwZAIwEa9an+99L3e2byXW

X8NlGTqRZrT6GPgihlU0T7jFxYUywDM++OyHcTdrm3DO5tQ2AjAIWvhVUIP8pMC8

ejQQomgmbY5H81sD8vxRV06eGYY0kiETBwITUCUP7F52ONQ+Lo8=

-----END CERTIFICATE REQUEST-----


</security-certificate-extension>

<security-certificate-extension>


<keypair-tag>MyPKIcert

</keypair-tag>

<certificate-name>MyPKIcert.pem</certificate-name>

<local-certificate>true</local-certificate>

<certificate>Issued To

countryName = US






Issued By

countryName = US






Period Of Validity

Begins On Apr 6 16:26:34 2020 GMT

Expires On Apr 5 16:26:34 2025 GMT

Fingerprints

SHA1 Fingerprint 45:6Z:14:E2:X1:21:5F:80:68:E8:Y5:25:DC:CB:50:3F:77:78:BB:A0

SHA256 Fingerprint

A1:20:B8:54:4E:CD:28:84:26:52:4E:FG:39:4H:0F:20:D3:3F:8A:42:4A:89:F0:C2:29:C3:34:55:E9:D0:79:37

Crypto Algorithm

Signature Algorithm ecdsa-with-SHA384

Public Key Algorithm id-ecPublicKey

Public-Key 384 bit

File-Hash 864fbc49f230a2538d11fab5c36345a16af4e395

</certificate>

<certificate-hexdump>-----BEGIN CERTIFICATE-----

MIICVTCCAdugAwIBAgIURWT9rXL1irPg2iy1uqS9PK+Ir54wCgYIKoZIzj0EAwMw

ajELMAkGA1UEBhMCVVMxETAPBgNVBAgMCENvbG9yYWRvMRMwEQYDVQQHDApCcm9v

bWZpZWxkMREwDwYDVQQKDAhCcm9hZGNvbTEMMAoGA1UECwwDQlNOMRIwEAYDVQQD

DAlNeVBLSWNlcnQwHhcNMjAwNDA2MTYyNjM0WhcNMjUwNDA1MTYyNjM0WjBqMQsw


Broadcom


CQYDVQQGEwJVUzERMA8GA1UECAwIQ29sb3JhZG8xEzARBgNVBAcMCkJyb29tZmll

bGQxETAPBgNVBAoMCEJyb2FkY29tMQwwCgYDVQQLDANCU04xEjAQBgNVBAMMCU15

UEtJY2VydDB2MBAGByqGSM49AgEGBSuBBAAiA2IABEuFhidlCzGtkiiPoB4wbWMS

XbxDp7bWQI3xAZIOgJf6tE0kMB8GA1UdIwQYMBaAFMPlXbxDp7bWQI3xAZIOgJf6

tE0kMAoGCCqGSM49BAMDA2gAMGUCMD4CcrGSIrRHbflAfqF/R+qY23S/05nMymPl

B0LuC3pXwP1+XbRx+45ijV0hmtT8+AIxALZ6EbjNPpaco+V4j1JRnIV5gtDCzBj6

IVhGtyqGS1lbIz+9XHSRH30q/JFm12iVkw==

-----END CERTIFICATE-----


</security-certificate-extension>

</Response>


Broadcom


brocade-snmpThis module provides a detailed view of the SNMP configurations used to monitor the switch through SNMP queries andtrap notifications. FOS REST API version 8.2.1b and later support SNMPv1 and SNMPv3 queries and traps.

Module Tree

This is the tree view of the module from the brocade-snmp.yang-tree.txt file. See YANG Module Overview forYANG node field definitions and possible values, and see SNMP Module Data Types for data type descriptions.module: brocade-snmp

+--rw brocade-snmp

+--rw system

| +--rw description? string

| +--rw location? string

| +--rw contact? string

| +--rw informs-enabled? boolean

| +--rw encryption-enabled? boolean

| +--rw audit-interval? uint16

| +--rw default-config

| | +--rw default-control* snmp-types:default-control-type

| x--rw security-get-level? snmp-types:security-level

| x--rw security-set-level? snmp-types:security-level

| +--rw security-get-level-string? snmp-types:security-level-string-type

| +--rw security-set-level-string? snmp-types:security-level-string-type

| +--rw snmpv1-enabled? boolean

+--rw mib-capability* [mib-name]

| +--rw mib-name snmp-types:mibs-name

| +--rw is-mib-enabled-state? boolean

+--rw trap-capability* [trap-name]

| +--rw trap-name snmp-types:traps-name

| +--rw is-trap-enabled-state? boolean

| +--rw severity? snmp-types:severity-level

+--rw v1-account* [index]


| +--rw community-name? string

| +--rw community-group? snmp-types:group-name

+--rw v1-trap* [index]


| +--rw host? inet:host

| +--rw trap-severity-level? snmp-types:severity-level

| +--rw port-number? inet:port-number

+--rw v3-account* [index]


| +--rw user-name? string

| +--rw user-group? snmp-types:group-name

| +--rw authentication-protocol? snmp-types:authentication-protocol-type

| +--rw privacy-protocol? snmp-types:privacy-protocol-type

| +--rw authentication-password? string

| +--rw privacy-password? string

| +--rw manager-engine-id? string

+--rw v3-trap* [trap-index]

| +--rw trap-index uint16

| +--rw usm-index? uint16


Broadcom


| +--rw host? inet:host

| +--rw trap-severity-level? snmp-types:severity-level

| +--rw port-number? inet:port-number

| +--rw informs-enabled? boolean

+--rw access-control* [index]

+--rw index uint16

+--rw host? inet:ip-address

+--rw access-level? snmp-types:access-permission

URI Format


• <base_URI>/running/brocade-snmp/system/ followed by the leafs as listed in the module tree.

• <base_URI>/running/brocade-snmp/mib-capability/ followed by the leafs as listed in the module tree.

• <base_URI>/running/brocade-snmp/trap-capability/ followed by the leafs as listed in the module tree.

• <base_URI>/running/brocade-snmp/v1-account/ followed by the leafs as listed in the module tree.

• <base_URI>/running/brocade-snmp/v1-trap/ followed by the leafs as listed in the module tree.

• <base_URI>/running/brocade-snmp/v3-account/ followed by the leafs as listed in the module tree.

• <base_URI>/running/brocade-snmp/v3-trap/ followed by the leafs as listed in the module tree.

• <base_URI>/running/brocade-snmp/access-control/ followed by the leafs as listed in the module tree.

Parametersbrocade-snmp

Description: The container for SNMP query and trap notification configuration.Flag: read-writeThis container has the following leafs:system

Description: The system-wide SNMP configurations.Flag: read-writeKey: <key>This container has the following leafs:description

Description: A printable ASCII string that provides a description of the entity.Flag: read-writeType: stringValue: 4 to 255 printable ASCII characters that provide a description of the entity. This parametershould include the full name and version identification of the system's hardware type, softwareoperating system, and networking software. Refer to RFC 1213.Optional: Yes

locationDescription: The physical location of this node.Flag: read-writeType: stringValue:The physical location of this node. Refer to RFC 1213.


Broadcom


Optional: Yescontact

Description: The contact person for this managed node, together with how to contact thisperson.Flag: read-writeType: stringValue:The contact person for this managed node, together with how to contact this person. Referto RFC 1213.Optional: Yes

informs-enabledDescription: Indicates whether informs is enabled or disabled in the switch. There must be atleast one user in the snmpv3-account list in order to configure informs.Flag: read-writeType: booleanValue: true = Informs is enabled in the switch. false = Informs is disabled in the switch.Optional: Yes

encryption-enabledDescription: Indicates whether password encryption is enabled or disabled. If passwordencryption is enabled, the authentication and privacy passwords are stored as encrypted. Ifpassword encryption is disabled, authentication and privacy passwords are stored as plaintext. There must be at least one user in the snmpv3-account list in order to configure informs.Flag: read-writeType: booleanValue: true = Password encryption is enabled in the switch. false = Password encryption isdisabled in the switch.Optional: Yes

audit-intervalDescription: The SNMP audit interval in minutes.Flag: read-writeType: uint16Value: 1 to 1440.Optional: Yes

default-configDescription: List of SNMP configurations.Flag: read-writeThis container has the following leaf:default-control

Description: The SNMP configuration (such as snmpv1, snmpv3, access control, systemgroup, mib capability, and audit interval).Flag: read-writeType: snmp-types:def-controlValue: The SNMP configuration (such as snmpv1, snmpv3, access control, systemgroup, mib capability, and audit interval).Optional: Yes

security-get-levelDescription: This parameter is deprecated. Use the security-get-level-string parameter instead.The SNMP security access level for the GET operation.Flag: read-writeType: snmp-types:security-levelValue: 0 = No Security. 1 = Authentication only. 2 = Authentication and privacy. 3 = No access.


Broadcom


Optional: Yessecurity-set-level

Description: This parameter is deprecated. Use the security-set-level-string parameter instead.The SNMP security access level for the SET operation.Flag: read-writeType: snmp-types:security-levelValue: 0 = No Security. 1 = Authentication only. 2 = Authentication and privacy. 3 = No access.Optional: Yes

security-get-level-stringDescription: The SNMP security access level for the GET operation.Flag: read-writeType: snmp-types:security-levelValue: 0 = No Security. 1 = Authentication only. 2 = Authentication and privacy. 3 = No access.Optional: Yes

security-set-level-stringDescription: The SNMP security access level for the SET operation.Flag: read-writeType: snmp-types:security-levelValue: 0 = No Security. 1 = Authentication only. 2 = Authentication and privacy. 3 = No access.Optional: Yes

snmpv1-enabledDescription: Indicates whether SNMPv1 is enabled or disabled in the switch.Flag: read-writeType: booleanValue: true = SNMPv1 is enabled in the switch. false = SNMPv1 is disabled in the switch.Optional: Yes

mib-capabilityDescription: A list of MIBs.Key: mib-nameFlag: read-writeThis list has the following leafs:mib-name

Description: The MIB name.Flag: read-writeType: snmp-types:mibs-nameValue: The MIB name.Optional: Yes

is-mib-enabled-stateDescription: Indicates whether the MIB is enabled or disabled.Flag: read-writeType: booleanValue: true = The MIB is enabled. false = The MIB is disabled.Optional: Yes

trap-capabilityDescription: A list of traps to enable or disable in the MIB capability. The trapst11ZsRequestRejectNotify, t11ZsMergeFailureNotify, t11ZsMergeSuccessNotify,t11ZsDefZoneChangeNotify, and t11ZsActivateNotify are read-only and write operation for MIBcapability is not supported.Key: trap-name


Broadcom


Flag: read-writeThis container has the following leafs:trap-name

Description: The trap name.Flag: read-writeType: snmp-types:traps-nameValue: The trap name.Optional: Yes

is-trap-enabled-stateDescription: Indicates whether the trap is enabled or disabled.Flag: read-writeType: booleanValue: true = The trap is enabled. false = The trap is disabled.Optional: Yes

severityDescription: The trap recipient severity level. This parameter is only available whenthe trap name is swEventTrap (trap-name=swEventTrap). When an event occurs andits severity level is at or below the set value (none, critical, error, warning, informational,and debug). The Event Trap traps (swEventTrap and connUnitEventTrap), are sent toconfigured trap recipients.Flag: read-writeType: snmp-types:severity-levelValue: The trap recipient severity level (none, critical, error, warning, informational, anddebug).Optional: Yes

v1-accountDescription: The SNMPv1 user account to access the system resource via SNMP. It alsocontains the snmpv1 host recipients to receive the SNMPv1 traps. Refer to RFC 1157.Key: indexFlag: read-writeThis list has the following leafs:index

Description: The label for this object.Flag: read-writeType: uint16Value: 1 thorugh 6.Optional: Yes

community-nameDescription: The community string.Flag: read-writeType: stringValue: The community string.Optional: Yes

community-groupDescription: Indicates whether the SNMPv1 community belongs to a read-only or read-write group. Note that community-group is a mandatory parameter in POST operations tocreate an SNMPv1 account.Flag: read-writeType: snmp-types:group-nameValue: read-only = The group is read-only. read-write = The group is read-write.


Broadcom



Optional: Yesv1-trap

Description: The SNMPv1 trap notification. Refer to RFC 3413.Key: indexFlag: read-writeThis list has the following leafs:index


hostDescription: The IP address of the trap recipient system.Flag: read-writeType: inet:hostValue: A valid IP address.Optional: Yes

trap-severity-levelDescription: The trap recipient severity level. When an event occurs and its severitylevel is at or below the set value (none, critical, error, warning, informational, and debug),the Event Trap traps (swEventTrap and connUnitEventTrap) are sent to configured traprecipients.Flag: read-writeType: snmp-types:severity-levelValue: The trap recipient severity level (none, critical, error, warning, informational, anddebug).Optional: Yes

port-numberDescription: The UDP port where SNMP traps are received.Flag: read-writeType: inet:port-numberValue: A valid UDP port where SNMP traps are received.Optional: Yes

v3-accountDescription: The SNMPv3 user account. This parameter is used to access system via SNMPv3in a secure manner by means of authentication and privacy. This parameter is also used toreceive the traps and informs notifications for the configured host recipient. Refer to RFC 3414.Key: indexFlag: read-writeThis list has the following leafs:index

Description: The label for this object.Flag: read-onlyType: uint16Value: 1 through 12.Optional: Yes

user-nameDescription: The name of the user that connects to the agent.


Broadcom




Flag: read-writeType: stringValue: 2 through 32 character name of the user that connects to the agent.Optional: Yes

user-groupDescription: Indicates whether the SNMPv3 user belongs to a read-only or read-writegroup. Note that user-group is a mandatory parameter in POST operations to create anSNMPv3 account.Flag: read-writeType: snmp-types:group-nameValue: read-only = The group is read-only. read-write = The group is read-write.Optional: Yes

authentication-protocolDescription: The authorization protocol (MD5 or SHA) for the SNMPv3 user. Refer toRFC 3414.Flag: read-writeType: snmp-types:authentication-protocol-typeValue: MD5 or SHA.Optional: Yes

privacy-protocolDescription: The privacy protocol (DES or AES-128) for the SNMPv3 user. Refer to RFC3414.Flag: read-writeType: snmp-types:privacy-protocol-typeValue: DES or AES-128Optional: Yes

authentication-passwordDescription: The authentication password for the SNMPv3 user to access the systemresources. This is a write only leaf. The password should be base64 encoded. Refer toRFC 3414.Flag: read-writeType: stringValue: 8 to 32 characters. The password must be encoded with the Base64 encodingscheme.Optional: Yes

privacy-passwordDescription: The privacy password for the SNMPv3 user to access the systemresources. This is a write only leaf. The password should be base64 encoded. Refer toRFC 3414.Flag: read-writeType: stringValue: 8 to 32 characters. The password must be encoded with the Base64 encodingscheme.Optional: Yes

manager-engine-idDescription: The user-defined engine ID for the SNMP manager which is used to receivethe SNMPv3 informs notifications. This parameter is only applicable when the informs isenabled (system/informs-enabled).Flag: read-writeType: string


Broadcom







Value: 5 to 32 character user-defined engine ID for the SNMP manager.Optional: Yes

v3-trapDescription: The SNMPv3 trap notification. Refer to RFC 3413.Key: trap-indexFlag: read-writeThis container has the following leafs:trap-index


usm-indexDescription: The index of the user account associated with the trap index.Flag: read-writeType: uint16Value: 1 through 12.Optional: Yes

hostDescription: The IP address of trap recipient system.Flag: read-writeType: inet:hostValue: A valid IP address.Optional: Yes

trap-severity-levelDescription: The trap recipient severity level. When an event occurs and its severitylevel is at or below the set value (none, critical, error, warning, informational, and debug),the Event Trap traps (swEventTrap and connUnitEventTrap) are sent to configured traprecipients.Flag: read-writeType: snmp-types:severity-levelValue: The trap recipient severity level (none, critical, error, warning, informational, anddebug).Optional: Yes

port-numberDescription: The UDP port where SNMP traps are received.Flag: read-writeType: inet:port-numberValue: A valid UDP port where SNMP traps are received.Optional: Yes

informs-enabledDescription: Indicates whether the informs is enabled or disabled.Flag: read-writeType: uint8Value:Value: true = Informs is enabled. false = Informs is disabled.Optional: Yes


Broadcom



access-controlDescription: This parameter is deprecated. Use the ipfilter-policy list instead. The SNMP accesscontrol list to restrict SNMP GET, SET, and trap operations to the hosts under an host subnetarea.Key: indexFlag: read-writeThis container has the following leafs:index


hostDescription: The subnet area of the access host. The IP address, for which SNMPoperations works only for the hosts configured in the ACL list. The IP address supportsboth IPv4 and IPv6 addresses.Flag: read-writeType: inet:ip-addressValue: A valid IP address.Optional: Yes

access-levelDescription: The access level of the SNMP access control entry. The access level canbe either read-only or read-write.Flag: read-writeType: snmp-types:access-permissionValue: ro = The access level is read-only. rw = The access level is read-write.Optional: Yes

Supported Methods

Only the OPTIONS, GET, POST, PATCH, DELETE and HEAD, operations are supported in this module.

ExamplesViewing SNMP System SettingsThe following example uses the GET request to view the SNMP system settings.StructureGET <base_URI>/running/brocade-snmp/system/URIGET https://10.10.10.10/rest/running/brocade-snmp/system/




Broadcom


<Response>

<system>

<description>Fibre Channel Switch.</description>

<location>End User Premise.</location>

<contact>Field Support.</contact>

<informs-enabled>false</informs-enabled>

<security-get-level>0</security-get-level>

<security-set-level>3</security-set-level>

<security-get-level-string>no-security</security-get-level-string>

<security-set-level-string>no-access</security-set-level-string>

<audit-interval>60</audit-interval>

<encryption-enabled>false</encryption-enabled>

<snmpv1-enabled>true</snmpv1-enabled>

</system>

</Response>

Configuring SNMP System SettingsThe following example uses the PATCH request to set the following SNMP system settings:

• Informs = enabled• Security SET level = 2• audit interval = 90 minutes

StructurePATCH <base_URI>/running/brocade-snmp/system/URIPATCH https://10.10.10.10/rest/running/brocade-snmp/system/

Request Body

<system>

<informs-enabled>true</informs-enabled>

<security-get-level-string>2</security-get-level-string>

<audit-interval>90</audit-interval>

</system>

Response BodyWhen the operation is successful, the response contains an empty message body and a “204 No Content”status appears in the header.Viewing MIB ConfigurationsThe following example uses the GET request to view the configuration for all MIBs.StructureGET <base_URI>/running/brocade-snmp/mib-capability/URIGET https://10.10.10.10/rest/running/brocade-snmp/mib-capability/



Broadcom


Response BodyWhen the operation is successful, the response has a message body similar to the following, and a “200 OK”status in the headers.


<Response>

<mib-capability>

<mib-name>FE-MIB</mib-name>

<is-mib-enabled-state>true</is-mib-enabled-state>

</mib-capability>

<mib-capability>

<mib-name>SW-MIB</mib-name>


</mib-capability>

<mib-capability>

<mib-name>FA-MIB</mib-name>


</mib-capability>

<mib-capability>

<mib-name>FICON-MIB</mib-name>


</mib-capability>

<mib-capability>

<mib-name>HA-MIB</mib-name>


</mib-capability>

<mib-capability>

<mib-name>FCIP-MIB</mib-name>


</mib-capability>

<mib-capability>

<mib-name>IF-MIB</mib-name>


</mib-capability>

<mib-capability>

<mib-name>BROCADE-MAPS-MIB</mib-name>


</mib-capability>

<mib-capability>

<mib-name>T11-FC-ZONE-SERVER-MIB</mib-name>

<is-mib-enabled-state>false</is-mib-enabled-state>

</mib-capability>

</Response>

Enabling an MIBThe following example uses the PATCH request to disable the FCIP-MIB.StructurePATCH <base_URI>/running/brocade-snmp/mib-capability/<mib-name>/is-mib-enabled-state/<true|false>URIPATCH https://10.10.10.10/rest/running/brocade-snmp/mib-capability/fcip-mib/is-mib-enabled-state/

true


Broadcom


Request BodyNo request body is required.Response BodyWhen the operation is successful, the response has an empty message body and a “204 No Content” statusmessage.Disabling an MIBThe following example uses the PATCH request to disable the FE-MIB.StructurePATCH <base_URI>/running/brocade-snmp/mib-capability/<mib-name>/is-mib-enabled-state/<true|false>URIPATCH https://10.10.10.10/rest/running/brocade-snmp/mib-capability

Request Body

<mib-capability>

<mib-name>FE-MIB</mib-name>

<is-mib-enabled-state>false</is-mib-enabled-state>

</mib-capability>

Response BodyWhen the operation is successful, the response has an empty message body and a “204 No Content” statusmessage.Viewing the Configuration for TrapsThe following example uses the GET request to view the configuration for all traps.StructureGET <base_URI>/running/brocade-snmp/trap-capability/URIGET https://10.10.10.10/rest/running/brocade-snmp/trap-capability/



<Response>

<trap-capability>

<trap-name>swFCPortScn</trap-name>

<is-trap-enabled-state>true</is-trap-enabled-state>

<severity>none</severity>

</trap-capability>

<trap-capability>

<trap-name>swEventTrap</trap-name>




Broadcom


</trap-capability>

<trap-capability>

<trap-name>swIPv6ChangeTrap</trap-name>



</trap-capability>

<trap-capability>

<trap-name>swPmgrEventTrap</trap-name>



</trap-capability>

<trap-capability>

<trap-name>swFabricReconfigTrap</trap-name>



</trap-capability>

<trap-capability>

<trap-name>swFabricSegmentTrap</trap-name>



</trap-capability>

<trap-capability>

<trap-name>swExtTrap</trap-name>

<is-trap-enabled-state>false</is-trap-enabled-state>


</trap-capability>

<trap-capability>

<trap-name>swStateChangeTrap</trap-name>



</trap-capability>

<trap-capability>

<trap-name>swPortMoveTrap</trap-name>



</trap-capability>

<trap-capability>

<trap-name>swBrcdGenericTrap</trap-name>



</trap-capability>

<trap-capability>

<trap-name>swDeviceStatusTrap</trap-name>



</trap-capability>

<trap-capability>

<trap-name>swZoneConfigChangeTrap</trap-name>



</trap-capability>

<trap-capability>

<trap-name>connUnitStatusChange</trap-name>


Broadcom




</trap-capability>

<trap-capability>

<trap-name>connUnitEventTrap</trap-name>



</trap-capability>

<trap-capability>

<trap-name>connUnitPortStatusChange</trap-name>



</trap-capability>

<trap-capability>

<trap-name>linkRNIDDeviceRegistration</trap-name>



</trap-capability>

<trap-capability>

<trap-name>linkRNIDDeviceDeRegistration</trap-name>



</trap-capability>

<trap-capability>

<trap-name>linkLIRRListenerAdded</trap-name>



</trap-capability>

<trap-capability>

<trap-name>linkLIRRListenerRemoved</trap-name>



</trap-capability>

<trap-capability>

<trap-name>linkRLIRFailureIncident</trap-name>



</trap-capability>

<trap-capability>

<trap-name>fruStatusChanged</trap-name>



</trap-capability>

<trap-capability>

<trap-name>cpStatusChanged</trap-name>



</trap-capability>

<trap-capability>

<trap-name>fruHistoryTrap</trap-name>



</trap-capability>


Broadcom


<trap-capability>

<trap-name>linkDown</trap-name>



</trap-capability>

<trap-capability>

<trap-name>linkUp</trap-name>



</trap-capability>

<trap-capability>

<trap-name>mapsTrapAM</trap-name>



</trap-capability>

<trap-capability>

<trap-name>mapsQuietTimeExpirationTrap</trap-name>



</trap-capability>

<trap-capability>

<trap-name>t11ZsRequestRejectNotify</trap-name>



</trap-capability>

<trap-capability>

<trap-name>t11ZsMergeFailureNotify</trap-name>



</trap-capability>

<trap-capability>

<trap-name>t11ZsMergeSuccessNotify</trap-name>



</trap-capability>

<trap-capability>

<trap-name>t11ZsDefZoneChangeNotify</trap-name>



</trap-capability>

<trap-capability>

<trap-name>t11ZsActivateNotify</trap-name>



</trap-capability>

</Response>

Configuring a TrapThe following example uses the PATCH request to change the severity for swEventTrap to "warning".StructurePATCH <base_URI>/running/brocade-snmp/trap-capability/swEventTrap/severity/warning


Broadcom


URIPATCH https://10.10.10.10/rest/running/brocade-snmp/trap-capability


<trap-capability>

<trap-name>swEventTrap</trap-name>

<severity>warning</severity>

</trap-capability>

Response BodyWhen the operation is successful, the response has an empty message body and a “204 No Content” statusmessage.Viewing the SNMPv1 Account SettingsThe following example uses the GET request to view the SNMPv1 account settings.StructureGET <base_URI>/running/brocade-snmp/v1-account/URIGET https://10.10.10.10/rest/running/brocade-snmp/v1-account/



<Response>

<v1-account>

<index>1</index>

<community-group>read-write</community-group>

<community-name>Secret C0de</community-name>

</v1-account>

<v1-account>

<index>2</index>


<community-name>OrigEquipMfr</community-name>

</v1-account>

<v1-account>

<index>3</index>


<community-name>private</community-name>

</v1-account>

<v1-account>

<index>4</index>

<community-group>read-only</community-group>

<community-name>public</community-name>

</v1-account>


Broadcom


<v1-account>

<index>5</index>


<community-name>common</community-name>

</v1-account>

<v1-account>

<index>6</index>


<community-name>FibreChannel</community-name>

</v1-account>

</Response>

Configuring a SNMPv1 AccountThe following example uses the PATCH request to change the community name to 'common' for the SNMPv1account '3'.StructurePATCH <base_URI>/running/brocade-snmp/v1-account/URIPATCH https://10.10.10.10/rest/running/brocade-snmp/v1-account/

Request Body

<v1-account>

<index>3</index>

<community-name>common</community-name>

</v1-account>

Response BodyWhen the operation is successful, the response has an empty message body and a “204 No Content” statusmessage.Viewing SNMPv1 Trap SettingsThe following example uses the GET request to view the SNMPv1 trap settings.StructureGET <base_URI>/running/brocade-snmp/v1-trap/URIGET https://10.10.10.10/rest/running/brocade-snmp/v1-trap/



<Response>

<v1-trap>

<index>1</index>

<host>0.0.0.0</host>


Broadcom


<trap-severity-level>none</trap-severity-level>

<port-number>162</port-number>

</v1-trap>

<v1-trap>

<index>2</index>




</v1-trap>

<v1-trap>

<index>3</index>




</v1-trap>

<v1-trap>

<index>4</index>




</v1-trap>

<v1-trap>

<index>5</index>




</v1-trap>

<v1-trap>

<index>6</index>




</v1-trap>

</Response>

Configuring a SNMPv1 TrapThe following example uses the PATCH request to change the severity level for index 1 to 'warning' and thehost IP address for index 5 to '10.10.10.10'.StructurePATCH <base_URI>/running/brocade-snmp/v1-trap/URIPATCH https://10.10.10.10/rest/running/brocade-snmp/v1-trap/

Request Body

<v1-trap>

<index>2</index>

<trap-severity-level>warning</trap-severity-level>

</v1-trap>

<v1-trap>

<index>5</index>


Broadcom


<host>10.10.10.10</host>

</v1-trap>

Response BodyWhen the operation is successful, the response has an empty message body and a “204 No Content” statusmessage.Viewing the SNMPv3 Account SettingsThe following example uses the GET request to view the SNMPv3 account settings.StructureGET <base_URI>/running/brocade-snmp/v3-account/URIGET https://10.10.10.10/rest/running/brocade-snmp/v3-account/



<Response>

<v3-account>

<index>1</index>

<user-name>snmpadmin1</user-name>

<user-group>read-write</user-group>

<authentication-protocol>noauth</authentication-protocol>

<privacy-protocol>nopriv</privacy-protocol>

<authentication-password/>

<privacy-password/>

<manager-engine-id>00:00:00:00:00:00:00:00:00</manager-engine-id>

</v3-account>

<v3-account>

<index>2</index>






<privacy-password/>


</v3-account>

<v3-account>

<index>3</index>






<privacy-password/>


Broadcom



</v3-account>

<v3-account>

<index>4</index>

<user-name>snmpuser1</user-name>

<user-group>read-only</user-group>




<privacy-password/>


</v3-account>

<v3-account>

<index>5</index>

<user-name>snmpuser2</user-name>





<privacy-password/>


</v3-account>

<v3-account>

<index>6</index>






<privacy-password/>


</v3-account>

</Response>

Configuring a SNMPv3 AccountThe following example uses the PATCH request to change the manager engine for index 1 to'10:10:10:00:00:00:00:00:00'.StructurePATCH <base_URI>/running/brocade-snmp/v3-account/URIPATCH https://10.10.10.10/rest/running/brocade-snmp/v3-account/

Request Body

<v3-account>

<index>1</index>



</v3-account>


Broadcom


Response BodyWhen the operation is successful, the response has an empty message body and a “204 No Content” statusmessage.Viewing SNMPv3 Trap SettingsThe following example uses the GET request to view the SNMPv3 trap settings.StructureGET <base_URI>/running/brocade-snmp/v3-trap/URIGET https://10.10.10.10/rest/running/brocade-snmp/v3-trap/



<Response>

<v3-trap>

<trap-index>1</trap-index>

<usm-index>6</usm-index>

<host>10.10.10.11</host>


<trap-severity-level>informational</trap-severity-level>


</v3-trap>

<v3-trap>







</v3-trap>

<v3-trap>







</v3-trap>

<v3-trap>








Broadcom


</v3-trap>

<v3-trap>







</v3-trap>

<v3-trap>



<host>10.10.10.12</host>


<trap-severity-level>informational</trap-severity-level>


</v3-trap>

</Response>

Configuring a SNMPv3 TrapThe following example uses the PATCH request to configure the USM index to '5' and the host to '10.10.10.10'for trap index 6.StructurePATCH <base_URI>/running/brocade-snmp/v3-trap/URIPATCH https://10.10.10.10/rest/running/brocade-snmp/v3-trap/

Request Body

<v3-trap>



<host>10.10.10.10</host>

</v3-trap>

Response BodyWhen the operation is successful, the response has an empty message body and a “204 No Content” statusmessage.Viewing SNMP Access Control SettingsThe following example uses the GET request to view the SNMP access control settings.StructureGET <base_URI>/running/brocade-snmp/access-control/URIGET https://10.10.10.10/rest/running/brocade-snmp/access-control/



Broadcom


Response BodyWhen the operation is successful, the response has a message body similar to the following, and a “200 OK”status in the headers.


<Response>

<access-control>

<index>0</index>


<access-level>rw</access-level>

</access-control>

<access-control>

<index>1</index>



</access-control>

<access-control>

<index>2</index>



</access-control>

<access-control>

<index>3</index>



</access-control>

<access-control>

<index>4</index>



</access-control>

<access-control>

<index>5</index>



</access-control>

</Response>

Configuring SNMP Access Control SettingsThe following example uses the PATCH request to configure the host IP address to '0.0.0.11' for index 2.StructurePATCH <base_URI>/running/brocade-snmp/access-control/URIPATCH https://10.10.10.10/rest/running/brocade-snmp/access-control/

Request Body

<access-control>

<index>2</index>

<host>0.0.0.11</host>

</access-control>


Broadcom



History


Fabric OS 8.2.1b This API call was introduced.

Fabric OS 9.0.0 This API call was modified to add the security-get-level-string and security-set-level-stringparameters to the system container. Deprecated commands:• security-get-level - Use the security-get-level-string parameter instead.• security-set-level - Use the security-set-level-string parameter instead.

Fabric OS 9.0.1 This API call was modified to edit the community-group and user-group parameters.


Broadcom


brocade-supportlinkThis module enables you to display the existing Support Link configuration and history, enable Support Link, andconfigure Support Link.

Module Tree

This is the tree view of the module from the brocade-supportlink.yang-tree.txt file. See YANG ModuleOverview for YANG node field definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-supportlink

+--rw brocade-supportlink

+--rw supportlink-profile

| +--rw supportlink-enabled? boolean

| +--rw server? inet:host


| +--rw user-name? union

| +--rw start-date? union

| +--rw period? uint32

| +--rw start-time? uint32

| +--rw end-time-period? uint32

| +--ro random-start-time? string

| +--rw retry-time? uint32

| +--rw collection-time? string

| +--rw proxy-user? string

| +--rw proxy-password? brocade-security-type:base64-string-type

| +--rw proxy-server? union

| +--rw proxy-port? inet:port-number

| +--rw proxy-protocol? enumeration

| +--rw group-tag? string

| +--ro next-collection-time? union

| +--ro next-service-start-time? union

| +--ro next-service-retry-time? yang:date-and-time

| +--ro last-collection-time? yang:date-and-time

| +--ro last-upload-time? yang:date-and-time

+--ro supportlink-history* []

+--ro index? uint16

+--ro time-stamp? yang:date-and-time

+--ro server? inet:host

+--ro port? inet:port-number

+--ro error-code? int32

+--ro error-message? string

URI Format


• <base_URI>/running/brocade-supportlink/supportlink-profile/supportlink-enabled to enableSupport Link.

• <base_URI>/running/brocade-supportlink/supportlink-profile/ to configuring the destination server,the collection period, the proxy server, and group tag, as well as display the Support Link configuration on the switch.

• <base_URI>/running/brocade-supportlink/supportlink-history/ to display the Support Link history forthe switch.


Broadcom


Parametersbrocade-supportlink

Description: The top-level container used to configure Support Link to collect and upload critical deviceinformation to a server module over a secure channel.Flag: read-writeOptional: NoThis container has the following leafs:supportlink-profile

Description: Specifies the configuration to be collected and uploaded to the destination server.Flag: read-writeOptional: NoThis container has the following leafs:supportlink-enabled

Description: Enables or disables Support Link.Flag: read-writeType: booleanValue: true = Enables Support Link. Support Link allows the automatic transfer of support data toBroadcom. Note that by enabling Support Link, you agree that support data, which may includepersonal data, is automatically transferred to Broadcom. false = Disables Support Link.Optional: Yes

serverDescription: The destination server address or domain name.Flag: read-writeType: inet:hostValue: A valid destination server address or domain name.Optional: Yes

portDescription: The HTTPS port number of the destination server.Flag: read-writeType: inet:port-numberValue: The HTTPS port number of the destination server.Optional: Yes

user-nameDescription: The user name or email address configured on the server.Flag: read-writeType: union {string; string}Value: The user name or email address configured on the server.Optional: Yes

start-dateDescription: The start date in weekday format [Mon, Tue, Wed, Thu, Fri, Sat, Sun] or exact dateformat [MM/DD/YYYY].Flag: read-writeType: union {enumeration; string}Value: The start date in weekday format [Mon, Tue, Wed, Thu, Fri, Sat, Sun] or exact date format[MM/DD/YYYY].Optional: Yes

periodDescription: The frequency at which you want to trigger the service. For example, if youconfigure Sunday as the start date, to run the Support Link weekly, set the period to 7 days. If


Broadcom


you configure an exact date (07/30/2020), set the period to any value as per the maximum andminimum timer configuration.Flag: read-writeType: uint32Value: 1 to 30.Optional: Yes

start-timeDescription: The start time of the support data upload in 24 hour format. For example, 1 means01:00 AM.Flag: read-writeType: uint32Value: The start time of the support data upload in 24 hour format. For example, 1 means 01:00AM.Optional: Yes

end-time-periodDescription: The maximum time period from the start time of the upload service. The actualupload time is a random time computed by the device at every reboot, between start time andend time.Flag: read-writeType: uint32Value: 1 to 12.Optional: Yes

random-start-timeDescription: The random upload time that is calculated from the start and end times.Flag: read-onlyType: stringValue: The random upload time that is calculated from the start and end times.Optional: Yes

retry-timeDescription: The amount of time before the upload service starts again after failure, when youset a non-zero.Flag: read-writeType: uint32Value: The amount of time before the upload service starts again after failure, when you set anon-zero.Optional: Yes

collection-timeDescription: The collection time of the support data in HH:MM in 24 hour format.Flag: read-writeType: stringValue: The collection time of the support data in HH:MM in 24 hour format.Optional: Yes

proxy-userDescription: The username for the proxy server. This parameter is required only in a proxyserver environment.Flag: read-writeType: stringValue: The username for the proxy server.Optional: Yes


Broadcom


proxy-passwordDescription: The base64 encoded user password for the proxy server. Refer to RFC 3414. Thisparameter is required only in a proxy server environment.Flag: read-writeType: brocade-security-type:base64-string-typeValue: The base64 encoded user password for the proxy server.Optional: Yes

proxy-server?Description: The proxy server address or domain name. This parameter is required only in aproxy server environment. If the proxy server is not configured, the response does not include theproxy-server attribute.Flag: read-writeType: union {inet:host; string}Value: The proxy server address or domain name.Optional: Yes

proxy-portDescription: The proxy server port number. This parameter is required only in a proxy serverenvironment. If the proxy port is not configured, the response does not include the proxy-portattribute.Flag: read-writeType: inet:port-numberValue: The proxy server port number.Optional: Yes

proxy-protocolDescription: The protocol used to communicate with the proxy server. This parameter is requiredonly in a proxy server environment. If the proxy protocol is not configured, the response does notinclude the proxy-protocol attribute.Flag: read-writeType: enumerationValue:http = Hyper Text Transfer Protocol. https = Hypertext Transfer Protocol Secure. socks4= Socket Secure is an Internet protocol developed to route packets through client-serverapplications. socks4a = Socket Secure version 4a allows domain names. socks5 = SocketSecure version 5 allows strong authentication schemes. socks5h = Socket Secure version 5hallows strong authentication schemes and domain names.Optional: Yes

group-tagDescription: The name of an organizational group of switches.Flag: read-writeType: stringValue: The name of an organizational group of switches.Optional: Yes

next-collection-timeDescription: The next support data collection time in the switch.Flag: read-onlyType: union {yang:date-and-time; string}Config: falseValue: The next support data collection time in the switch.Optional: Yes


Broadcom


next-service-start-timeDescription: The next support data upload time to the server.Flag: read-onlyType: on {yang:date-and-time; string}Config: falseValue: The next support data upload time to the server.Optional: Yes

next-service-retry-timeDescription: The next support data upload retry time to the server.Flag: read-onlyType: yang:date-and-timeConfig: falseValue: The next support data upload retry time to the server.Optional: Yes

last-collection-timeDescription: The last successful support data collection time on the switch.Flag: read-onlyType: yang:date-and-timeConfig: falseValue: The last successful support data collection time on the switch.Optional: Yes

last-upload-timeDescription: The last successful support data upload time to the server.Flag: read-onlyType: yang:date-and-timeConfig: falseValue: The last successful support data upload time to the server.Optional: Yes

supportlink-historyDescription: The Support Link history retrieves the failures that occur during inventory upload operations.Flag: read-onlyConfig: falseOptional: NoThis container has the following leafs:index

Description: The index of the specific upload failure entry. The index is used as a label for thisobject.Flag: read-onlyType: uint16Value: 1 through 20.Optional: Yes

time-stampDescription: The date and time when the Support Link upload operation failed.Flag: read-onlyType: yang:date-and-timeValue: The date and time when the Support Link upload operation failed.Optional: Yes

serverDescription: The server address or domain name for the Support Link server.Flag: read-only


Broadcom


Type: inet:hostValue: The server address or domain name for the Support Link server.Optional: Yes

portDescription: The HTTPS port number of the Support Link server.Flag: read-onlyType: inet:port-numberValue: The HTTPS port number of the Support Link server.Optional: Yes

error-codeDescription: The error code for the exact failure that occurred during the Support Link uploadoperation.Flag: read-onlyType: int32Value: The error code for the exact failure that occurred during the Support Link uploadoperation.Optional: Yes

error-messageDescription: The reason for the Support Link upload operation failures.Flag: read-onlyType: stringValue: The reason for the Support Link upload operation failures.Optional: Yes

Supported Methods

The GET, PATCH, OPTIONS, and HEAD operations are supported in this module.

Examples

This section provides basic examples for using the brocade-operation-supportlink module.

Enabling Support Link

This example uses a PATCH request to enable Support Link on the specified switch.

Structure

PATCH base_URI/running/brocade-supportlink/supportlink-profile/supportlink-enabled/true

URI

PATCH https://10.10.10.10/rest/running/brocade-supportlink/supportlink-profile/supportlink-enabled/true

Request Body


Response Body


Configuring the Support Link

This example uses a PATCH request to configure Support Link on the specified switch.


Broadcom


Structure

PATCH base_URI/running/brocade-supportlink/supportlink-profile/

URI

PATCH https://10.10.10.10/rest/running/brocade-supportlink/supportlink-profile/

Request Body

{

"supportlink-profile": {

"server": "bsnconnect.broadcom.com",

"port": 443,

"user-name": "bsl_sl_default_user",

"period": 1,

"start-time": 1,

"start-date": "06/01/2019",

"collection-time": "0:00",

"retry-time": 0,

"end-time-period": 12,

"proxy-server": "mine",

"proxy-port": 2,

"proxy-user": "notmineuser",

"group-tag": ""

}

}

Response Body


Displaying the Support Link Configuration

This example uses a GET request to display the Support Link configuration on the specified switch.

Structure

GET base_URI/running/brocade-supportlink/supportlink-profile/

URI

GET https://10.10.10.10/rest/running/brocade-supportlink/supportlink-profile/

Request Body


Response Body

When the operation is successful, the response has a message body similar to the following and a “200 OK” status in theheaders.

{

"Response": {

"supportlink-profile": {

"supportlink-enabled": true,

"server": "bsnconnect.broadcom.com",

"port": 443,

"user-name": "bsl_sl_default_user",


Broadcom


"period": 1,

"start-time": 1,

"start-date": "06/01/2019",

"collection-time": "0:00",

"retry-time": 0,

"end-time-period": 12,

"random-start-time": "06/01/2019 3:35",

"next-collection-time": "2020-02-16T00:00:00+00:00",

"next-service-start-time": "2020-02-16T03:35:00+00:00",

"proxy-server": "mine",

"proxy-port": 2,

"proxy-user": "notmineuser",

"group-tag": ""

}

}

}

Displaying the Support Link History

This example uses a GET request to display the Support Link history on the specified switch.

Structure

GET base_URI/running/brocade-supportlink/supportlink-history/

URI

GET https://10.10.10.10/rest/running/brocade-supportlink/supportlink-history/

Request Body


Response Body



<Response>

<supportlink-history>

<index>1</index>


<server>asc1.brm.bsnlab.broadcom.net</server>

<port>8030</port>

<error-code>-7</error-code>

<error-message>Inventory file open error</error-message>

</supportlink-history>

...

<supportlink-history>

<index>5</index>


<server>asc-gateway.brm.bsnlab.broadcom.net</server>

<port>8030</port>


<error-message>Inventory file open error</error-message>

</supportlink-history>


Broadcom


</Response>

History



Fabric OS 9.0.1 This API call was modified to add the supportlink-history list.


Broadcom


brocade-timeThis module provides enables you to view and configure the time zone and clock server.

Module Tree

This is the tree view of the module from the brocade-time.yang-tree.txt file. See YANG Module Overview forYANG node field definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-time

+--rw brocade-time

+--rw time-zone

| +--rw name? brocade-time-type:ts-timezone-type

| +--rw gmt-offset-hours? int16

| +--rw gmt-offset-minutes? int16

+--rw clock-server

+--rw ntp-server-address

| +--rw server-address* brocade-time-type:ts-ntp-type

+--ro active-server? brocade-time-type:ts-ntp-type

URI Format


• <base_URI>/running/brocade-time/time-zone followed by the leafs as listed in the module tree to view orconfigure the time zone parameters.

• <base_URI>/running/brocade-time/clock-server followed by the leafs as listed in the module tree to view orconfigure the clock server parameters.

Parametersbrocade-time

Description: The base container for this module.Flag: read-writeThis container has the following leafs:time-zone

Description: The container to configure system time zone name or offset (hours,min or hours format).Note that the System Time Zone change takes effect at next reboot. On a chassis, both CPs rebootsimultaneously.Flag: read-writeThis container has the following leafs:name

Description: The time zone name from the time zone database (for example, Europe/Andorra).This parameter is available onlywhen offset is not configured.Flag: read-writeType: brocade-time-type:ts-timezone-typeValue: The time zone name from the time zone database (for example, Europe/Andorra). Notethat the time zone is case sensitive.Optional: Yes

gmt-offset-hoursDescription: The number of hours relative to GMT. This parameter is available onlywhen name isnot configured.


Broadcom


Flag: read-writeType: int16Value: -12 to 12 hours.Optional: Yes

gmt-offset-minutesDescription: The number of minutes relative to the hour offset. This parameter is availableonlywhen name is not configured and offset hours (gmt-offset-hours) is configured.Flag: read-writeType: int16Value: -30, 30, or 0 minutes.Optional: Yes

clock-serverDescription: The Network Time Protocol (NTP) IP address(es) or LOCL (local).Flag: read-writeThis container has the following leafs:ntp-server-address

Description: The NTP server IP address(es) or LOCL (for the local server).Flag: read-writeThis container has the following leaf:server-address

Description: A list of the NTP server IP addresses or LOCL (for the local server).Configure an NTP server IP address to set the clock server IP address and enable fabric-wide clock synchronization with the specified clock server. You can configure up to 8 NTPservers.Flag: read-writeType: brocade-time-type:ts-ntp-typeValue: A list of the NTP server IP addresses or LOCL (for the local server).Optional: Yes

active-serverDescription: The IP address of the active server or LOCL (for the local server).Flag: read-onlyType: brocade-time-type:ts-ntp-typeValue: The IP address of the active server or LOCL (for the local server).Optional: Yes

Supported Methods

Only the OPTIONS, HEAD, GET, and PATCH operations are supported in this module.

History




Broadcom


brocade-time ExamplesThis section provides examples for the brocade-time module.

Viewing the Time Zone

The following example uses the GET request to display the current time zone configuration for your device.

StructureGET <base_URI>/running/brocade-time/time-zoneURIGET https://10.10.10.10/rest/running/brocade-time/time-zone



<Response>

<time-zone>

<name>America/Toronto</name>

</time-zone>

</Response>

Configuring the Time Zone Name

The following example uses the PATCH request to modify the time zone name for your device.

StructurePATCH <base_URI>/running/brocade-time/time-zoneURIPATCH https://10.10.10.10/rest/running/brocade-time/time-zone

Request Body

<time-zone>

<name>America/Denver</name>

</time-zone>


Configuring the Time Zone Offset

The following example uses the PATCH request to modify the time zone offset relative to GMT for your device.

StructurePATCH <base_URI>/running/brocade-time/time-zone


Broadcom


URIPATCH https://10.10.10.10/rest/running/brocade-time/time-zone

Request Body

<time-zone>

<gmt-offset-hours>11</gmt-offset-hours>

<gmt-offset-minutes>30</gmt-offset-minutes>

</time-zone>


Viewing the Clock Server Configuration

The following example uses the GET request to display the clock server configuration.

StructureGET <base_URI>/running/brocade-time/clock-serverURIGET https://10.10.10.10/rest/running/brocade-time/clock-server



<Response>

<clock-server>

<ntp-server-address>

<server-address>10.10.10.10</server-address>

</ntp-server-address>

<active-server>10.10.10.10</active-server>

</clock-server>

</Response>

Configuring the Clock Server

The following example uses the PATCH request to configure a new NTP clock server 11.11.11.11.

StructurePATCH <base_URI>/running/brocade-time/clock-serverURIPATCH https://10.10.10.10/rest/running/brocade-time/clock-server

Request Body


Broadcom


<clock-server>

<ntp-server-address>

<server-address>11.11.11.11</server-address>

</ntp-server-address>

</clock-server>



Broadcom


brocade-zoneThis module is used for managing Fibre Channel zoning.

It assumes a knowledge of fabric zoning as performed in Fabric OS. For information on that topic, refer to AdministeringAdvanced Zoning in the Brocade Fabric OS Administration Guide.

ModuleTree

This is the tree view of the module from the brocade-zone.yang-tree.txt file. See YANG Module Overview forYANG node field definitions and possible values, and see Supported Data Types for data type descriptions.module: brocade-zone

+--rw brocade-zone

+--rw defined-configuration {fibrechannel:fibrechannel_switch_platform}?

| +--rw cfg* [cfg-name]

| | +--rw cfg-name zoning-name-type

| | +--rw member-zone

| | +--rw zone-name* zoning-name-type

| +--rw zone* [zone-name]

| | +--rw zone-name zoning-name-type

| | x--rw zone-type? zone-type-type

| | +--rw zone-type-string? zone-type-string-type

| | +--rw member-entry

| | +--rw entry-name* zone-member-type

| | +--rw principal-entry-name* zone-member-type

| +--rw alias* [alias-name]

| +--rw alias-name zoning-name-type

| +--rw member-entry

| +--rw alias-entry-name* union

+--rw effective-configuration {fibrechannel:fibrechannel_switch_platform}?

| +--rw cfg-name? zoning-name-type

| +--rw checksum? string

| +--rw cfg-action? uint8

| +--rw default-zone-access? uint8

| +--ro db-max? uint32

| +--ro db-avail? uint32

| +--ro db-committed? uint32

| +--ro db-transaction? uint32

| +--ro transaction-token? uint32

| +--ro db-chassis-wide-committed? uint32

| +--ro enabled-zone* [zone-name]

| +--ro zone-name zoning-name-type

| x--ro zone-type? zone-type-type

| +--ro zone-type-string? zone-type-string-type

| +--ro member-entry

| +--ro entry-name* union

| +--ro principal-entry-name* union

+--ro fabric-lock {fibrechannel:fibrechannel_switch_platform}?

+--ro lock-principal-domain-id? fibrechannel:domain-id-type

+--ro lock-principal-transaction-token? uint32

+--ro timeout? uint16

+--ro remaining-time? uint16

+--ro client-role? brocade-security-type:user-config-role-type


Broadcom


+--ro client-user-name? union

+--ro client-ip-address? union

+--ro client-interface? fibrechannel:interface-type

+--ro client-application-name? string

URI Format


• <base_URI>/running/brocade-zone/defined-configuration followed by the leafs as listed in the moduletree.

• <base_URI>/running/brocade-zone/effective-configuration followed by the leafs as listed in the moduletree.

• <base_URI>/running/brocade-zone/fabric-lock followed by the leafs as listed in the module tree.

URI Parameter Definitions

• cfg-name—The zone configuration name• alias-name—The zone alias name• zone-name—The zone name

NOTEIf all the switches in the fabric and both the CPs in a chassis system are running Fabric OS 8.1.0 or later, all ofthese names can start with a number or a letter, and may contain a hyphen (-), underscore (_), dollar sign ($), ora caret (^), except as the first character. If you merge a domain running Fabric OS 8.0.1 or lower with a domainhaving zone object names (configuration, alias, or zone name) starting with numbers, or containing "$", "-", or"^", the fabric will segment.

NOTEIn certain circumstances, zone, zone configuration, and zone alias names that use the dollar sign character ($)may be problematic in a REST request. The solution is to replace the dollar sign with its encoded version (%24).

Parameters

NOTEThe top-level container name changed from "zoning" to "brocade-zone". The previous top-level container name"zoning" is still supported in this release. However, new features (Fabric OS 9.0.0 or later) are not supported inthe previous top-level container name "zoning".

brocade-zoneDescription: This is the primary container for this module. The switch must be an FC switch in Native mode.Flag: read-writeThis container has the following containers:defined-configuration

Description: The defined zoning configuration.NOTEIf you perform a GET request on the defined-configuration container and there is an open zonetransaction whose user is logged out of the REST session, the open zone transaction is aborted.Flag: read-writeKey: cfg-nameThis container has the following leafs:cfg

Description: The name of the zone configuration.Flag: read-write


Broadcom


Type: stringValues: A list of configuration names.Optional: NoThis list has the following leafs:cfg-name

Description: The name of the zone configuration.Flag: read-writeType: zoning-name-typeValues: 1 to 64 alphanumeric characters, as well as the $, ^, - (hyphen), and_ (underscore) characters. This is case-sensitive, and must not contain special (high-ASCII) characters. See notes about names above.Optional: No

member-zoneDescription: List of configuration member zones.Flag: read-writeOptional: NoThis list has the following leafs:zone-name

Description: The zone name.Flag: read-writeType: zoning-name-typeValues: 1 to 64 alphanumeric characters, as well as the $, ^, - (hyphen), and_ (underscore) characters. This is case-sensitive, and must not contain special(high-ASCII) characters. See notes about names above.Optional:No

zoneDescription: The list of zones. The members can only be identified as a WWN, domain,index, orzone alias.Flag: read-writeKey: zone-nameThis list has the following leafs:zone-name

Description: The zone name.Flag: read-writeType: zoning-name-typeValues: 1 to 64 alphanumeric characters, as well as the $, ^, - (hyphen), and_ (underscore) characters. This is case-sensitive, and must not contain special (high-ASCII) characters. See notes about names above.Optional: No

zone-typeDescription: This parameter is deprecated. For write operations, use the 'zone-type-string' parameter instead. For read operations, this parameter is returned in responseswith valid data comparable to the 'zone-type-string' parameter. The zone type. Note thattarget-created peer zone (TDZ) types cannot be created or modified (only deleted). Alsonote that this parameter must be supplied for any user-created peer zone operation.Flag: read-writeType: zone-type-typeOptional: YesValues: 0 = default. (The non-peer zone type that is already set on the switch.) 1 = User-created peer zone. 2 = Target-created peer zone. Default: 0


Broadcom


Optional: Yeszone-type-string

Description: The zone type. Note that target-created peer zone (TDZ) types cannot becreated or modified (only deleted). Also note that this field must be configured for anyuser-created peer zone operation. For a write operation containing both the deprecated'zone-type' leaf as well as the 'zone-type-string' leaf, both leafs must use the same type. Ifthey do not use the same type, the write operation results in an error.Flag: read-writeType: zone-type-string-typeValues: zone = A zone that is not a peer zone. user-created-peer-zone = A peer zonethat was created by a non-target device. target-created-peer-zone = A peer zone thatwas created by a target device.Optional: Yes

member-entryDescription: The zone member.Flag: read-writeThis list has the following leafs:entry-name

Description: A list of the members in the zone. The members can only beidentified as a WWN, domain,index, or zone alias.Flag: read-writeType: zone-member-typeValues: A valid zone alias, a WWN, or a port identifier in the format“domain,index”.Optional: No

principal-entry-nameDescription: A list of the principal members in the peer zone. The members canonly be identified as a WWN, domain,index, or zone alias.Flag: read-writeType: zone-member-typeValues: A valid zone alias, a WWN, or a port identifier in the format“domain,index”.Optional: This field is optional if the zone-type field is not specified or is set to0. It is required if the “zone-type” field is set to 1 (user peer) and a write is beingperformed.

aliasDescription: The list of zone aliases.Flag: read-writeKey: alias-nameThis list has the following leafs:alias-name

Description: The zone alias name.Flag: read-writeType: zoning-name-typeValues: 1 to 64 alphanumeric characters, as well as the $, ^, - (hyphen), and_ (underscore) characters. This is case-sensitive, and must not contain special (high-ASCII) characters. See notes about names above.Optional: No

member-entryDescription: The alias member.


Broadcom


Flag: read-writeOptional: NoThis list has the following leaf:alias-entry-name

Description: The zone alias.Flag: read-writeType: union { fibrechannel:wwn-type; domain-index-type }Values: A valid WWN or a port identifier in the format “domain,index”.Optional: No

fabric-lockDescription: The zone fabric lock metadata fields. The fabric lock fields provide informationabout the owner of a zone fabric lock, the transaction token, timeout, remaining time, and clientinformation. The client is the user who has initiated the zone fabric lock and is typically anexternal entity such as an external management interface or an administrator using the commandline interface. The switch must be an FC switch in Native mode.Flag: read-onlyConfig: falseOptional: NoThis container has the following leafs:lock-principal-domain-id

Description: The domain ID that currently owns the zone fabric lock. If there is no lock-principal-domain-id, this field is zero.Flag: read-onlyType: fibrechannel:domain-id-typeConfig: falseValues: 1 to 239.Optional: Yes

lock-principal-transaction-tokenDescription: The token of the open zone transaction on the current fabric lock principaldomain ID. Note that this field can be different than the transaction-token parameter inthe effective-configuration container when there is an expired zone fabric lock timer, butthere is an open zone transaction on the local switch. This parameter is only applicablewhen the fabric lock principal domain ID is not zero (lock-principal-domain-id != 0).Flag: read-onlyType: uint32Config: falseValues: 0 to 4294967280.Optional: Yes

timeoutDescription: The current zone fabric lock timeout value of the currently open fabric lockprincipal transaction token. Note that on non lock principal switches, there is an added 30second buffer. This parameter is only applicable when the fabric lock principal domain IDis not zero (lock-principal-domain-id != 0).Flag: read-onlyType: uint16Config: falseValues: 300 to 1830 seconds.Optional: Yes


Broadcom


remaining-timeDescription: The remaining time of the open zone transaction owned by the fabric lockprincipal domain ID. This parameter is only applicable when the fabric lock principaldomain ID is not zero (lock-principal-domain-id != 0).Flag: read-onlyType: uint16Config: falseValues: 1 to 1830 seconds.Optional: Yes

client-roleDescription: The role name of the client account. This parameter is only applicable whenthe fabric lock principal domain ID is not zero (lock-principal-domain-id != 0).Flag: read-onlyType: brocade-security-type:user-config-role-typeConfig: falseValues: 4 to 16 alphanumeric characters that specify the client account's role.Optional: Yes

client-user-nameDescription: The username of the client account. Returns an empty tag if no user nameis provided. This parameter is only applicable when the fabric lock principal domain ID isnot zero (lock-principal-domain-id != 0).Flag: read-onlyType: union { brocade-security-type:user-config-user-name-type; string }Config: falseValues: The username of the client account.Optional: Yes

client-ip-addressDescription: The IP address the client is logged on to the switch from or none. Thisparameter is only applicable when the fabric lock principal domain ID is not zero (lock-principal-domain-id != 0).Flag: read-onlyType: union { inet:ip-address; string }Config: falseValues: A valid IP address or none.Optional: Yes

client-interfaceDescription: The interface used by the client to login to the switch. This parameteris only applicable when the fabric lock principal domain ID is not zero (lock-principal-domain-id != 0).Flag: read-onlyType: fibrechannel:interface-typeConfig: falseValues: none = The user interface is either undefined or unknown. console = Theuser interface is console. modem = The user interface is modem. telnet = The userinterface is telnet. ssh = The user interface is SSH. rpc = The user interface is RPC. http= The user interface is HTTP. https = The user interface is HTTPS. snmp = The userinterface is SNMP. fms = The user interface is FMS. zoneserver = The user interface isZONESERVER.Optional: Yes


Broadcom


client-application-nameDescription: The client provided name of the manageability application used by theclient. This parameter is only applicable when the fabric lock principal domain ID is notzero (lock-principal-domain-id != 0).Flag: read-onlyType: stringConfig: falseValues: The client provided name of the manageability application used by the client.Optional: Yes

effective-configurationDescription: The effective zoning configuration. The switch must be an FC switch in Native mode.NOTE If you perform a GET request on the effective-configuration container and there is an open zonetransaction whose user is logged out of the REST session, the open zone transaction is aborted.Flag: read-writeOptional: NoKey: cfg-nameThis container has the following leafs:cfg-name

Description: The name of the effective configuration to be enabled or a configuration that iscurrently enabled.This must be the name of a configuration that is already defined.Flag: read-writeType: zoning-name-typeValues: 1 to 64 alphanumeric characters, as well as the $, ^, - (hyphen), and _ (underscore)characters. This is case-sensitive, and must not contain special (high-ASCII) characters. Seenotes about names above.Optional: Yes

checksumDescription: The checksum of the configuration database.The checksum is an MD5 (Message-Digest algorithm 5) calculation (128-bit cryptographic hash)used to verify data integrity. This resource is used by the client to verify that the zone databasehas not changed since the configuration was read. It should be read as part of the initial querybefore modifications are made. It must be written when the changes are saved. The changes willbe accepted if the checksum agrees and rejected if it does not.The checksum field is required for cfgenable operations and also for cfg-action values of 1 or2 (See cfg-action entry below.)Flag: read-writeType: stringValues: 32 hexadecimal charactersOptional: Yes

cfg-actionDescription: The action to be done to the pending zoning configuration changes.

NOTEThis is a write-only parameter and does not display in a GET request.

Flag: read-writeType: unit8Values: 0 = Read is not applicable. 1 = Save the pending changes. (Similar to cfgSavecommand.) 2 = Disable the effective configuration. (Similar to cfgDisable command.) 3 = Clearthe entire zone database. (Similar to cfgClear command.) 4 = Clear any pending changes.(Similar to cfgTransAbort command.) Default: 0


Broadcom


Optional: Yesdefault-zone-access

Description: Enable or disable zone access.The default zoning mode controls device access if zoning is not implemented or if there is noenabled zone configuration.Flag: read-writeType: unit8Values: 0 = Devices in the fabric cannot access any other device in the fabric (No Access). 1= All devices within the fabric can communicate with all other devices in the fabric (All Access).Default: 1Optional: Yes

db-maxDescription: The maximum size of the zone database in bytes. The maximum size for thezone database is the upper limit for the zone-defined configuration determined by the amountof nonvolatile memory available for storing the defined configuration. The maximum size for thezone database is further reduced due to a message header that is propagated with the zoneconfiguration to all switches in the fabric.

NOTEIf you perform a GET request on the db-max parameter and there is an open zonetransaction whose user is logged out of the REST session, the open zone transaction isaborted.

Flag: read-onlyType: uint32Config: falseUnits: bytesValues: 0 to the maximum zone database size supported by the platforms in the fabric. Themaximum supported zone database size is 4 MB (4194304 bytes).Optional: Yes

db-availDescription: The size in bytes of free space available in the zone database.

NOTEIf you perform a GET request on the db-avail parameter and there is an open zonetransaction whose user is logged out of the REST session, the open zone transaction isaborted.

Flag: read-onlyType: uint32Config: falseUnits: bytesValues: 0 to 4193060 bytes. Default: 0Optional: Yes

db-committedDescription: The size in bytes of the defined configuration currently stored in nonvolatilememory. If the context is for a virtual fabric, then this resource is the size of the definedconfiguration for the logical switch.

NOTEIf you perform a GET request on the db-committed parameter and there is an openzone transaction whose user is logged out of the REST session, the open zonetransaction is aborted.


Broadcom


Flag: read-onlyType: unit32Config: falseUnits: bytesValues: 0 to 4194304 bytes.Optional: Yes

db-transactionDescription: The size in bytes of memory bytes required to commit the current transaction.The database transaction size will not be 0 if the defined configuration is being modified by REST,Telnet, API, or other applications; otherwise it is 0.

NOTEIf you perform a GET request on the db-transaction parameter and there is an openzone transaction whose user is logged out of the REST session, the open zonetransaction is aborted.

Flag: read-onlyType: unit32Config: falseUnits: bytesValues: 0 to 4194304 bytes. Default: 0Optional: Yes

transaction-tokenDescription: The token for the current zoning transaction on the local switch. If there isno outstanding local zoning transaction, this resource is 0. This parameter does not returntransaction information for remote switches.Flag: read-onlyType: unit32Config: falseValues: 0 through 4294967280. If a transaction is open, the value is a 32-bit transaction token. Ifno transaction is open, the value is 0. Default: 0 (no outstanding zoning transaction)Optional: Yes

db-chassis-wide-committedDescription: The size in bytes for the zone database across all the logical switches in thechassis if virtual fabrics are in use. If virtual fabrics are not in use, this is the size of the zonedatabase for the switch. The db-committed value is smaller than this resource due to storageoverhead.Flag: read-onlyType: unit32Config: falseUnits: bytesValues: 0 to 16777216 bytes. Default: 0Optional: Yes

enabled-zoneDescription: The enabled zones.Flag: read-onlyOptional: NoKey: zone-nameThis list has the following leafs:zone-name

Description: The name of the zone.Flag: read-only


Broadcom


Type: zoning-name-typeValues: 1 to 64 alphanumeric characters, as well as the $, ^, - (hyphen), and_ (underscore) characters. This is case-sensitive, and must not contain special (high-ASCII) characters. See notes about names above.Config: falseOptional: No

zone-typeDescription: This parameter is deprecated. For write operations, use the 'zone-type-string' parameter instead. For read operations, this parameter is returned in responseswith valid data comparable to the 'zone-type-string' parameter. The zone type.Flag: read-onlyType: zone-type-typeValues: 0 = default (The zone type that is already set on the switch.) 1 = User peer zone.2 = Target peer zone. Default: 0Optional: No. On reads, this will always be populated.

zone-type-stringDescription: The zone type. Note that target-created peer zone (TDZ) types cannot becreated or modified (only deleted). Also note that this field must be configured for anyuser-created peer zone operation. For a write operation containing both the deprecated'zone-type' leaf as well as the 'zone-type-string' leaf, both leafs must use the same type. Ifthey do not use the same type, the write operation results in an error.Flag: read-writeType: zone-type-string-typeValues: zone = A zone that is not a peer zone. user-created-peer-zone = A peer zonethat was created by a non-target device. target-created-peer-zone = A peer zone thatwas created by a target device.Optional: Yes

member-entryDescription: The zone members.Flag: read-onlyThis list has the following leafs:entry-name

Description: List of the members in the zone.Zone aliases are expanded when the configuration is enabled and are notincluded in the effective configuration.Flag: read-onlyType: union { zoning-name-type: fibrechannel:wwn-type }Values: A valid WWN or a port identifier in the format “domain,index”.Optional: No

principal-entry-nameDescription: If the zone is a peer zone, this property contains the list ofprincipals in the zone.The members can be identified using either a WWN or a domain,index ID. Zonealiases are expanded when the configuration is enabled and consequently arenot included in the effective configuration.Flag: read-onlyType: union { fibrechannel:wwn-type; domain-index-type }Values: A valid WWN or a port identifier in the format “domain,index”.Optional: No. This leaf will only be returned if the zone is a peer zone. It will notbe returned for other zone types.


Broadcom


Supported Methods


ExamplesRetrieving the List of Zone ConfigurationsThis example uses a GET request to retrieve the list of all the zone configurations.StructureGET <base_URI>/running/brocade-zone/defined-configuration/cfgURIGET http://10.10.10.10/rest/running/brocade-zone/defined-configuration/cfg

Request bodyNo request body is required.Response BodyWhen the operation is successful, the response has a message body similar to the following, and a “200 OK”status in the headers.<?xml version="1.0"?>

<Response>

<cfg>

<cfg-name>cfg_push</cfg-name>

<member-zone>

<zone-name>qosh_112</zone-name>

<zone-name>qosl_113</zone-name>

<zone-name>qosm_114</zone-name>




<zone-name>qosh_ed</zone-name>

</member-zone>

</cfg>

<cfg>

<cfg-name>cfg_push_165</cfg-name>

<member-zone>







</member-zone>

</cfg>

<cfg>

<cfg-name>ck</cfg-name>

<member-zone>

<zone-name>zk</zone-name>

<zone-name>tdg</zone-name>

<zone-name>fcoe</zone-name>

</member-zone>

</cfg>


Broadcom


<cfg>

<cfg-name>test_cfg</cfg-name>

<member-zone>

<zone-name>testzone</zone-name>

</member-zone>

</cfg>

</Response>

Retrieving the List of Member ZonesThis example uses a GET request to retrieve the list of member zones contained in the zone configuration“cfg_push”.StructureGET <base_URI>/running/brocade-zone/defined-configuration/cfg/cfg-name/cfg-name/member-zone/URIGET http://10.10.10.10/rest/running/brocade-zone/defined-configuration/cfg/cfg-name/cfg_push/

member-zone/


<Response>

<cfg>

<cfg-name>cfg_push</cfg-name>

<member-zone>







<zone-name>qosh_ed</zone-name>

</member-zone>

</cfg>

</Response>

Retrieving a List of the Zone Members in a Specific ZoneThis example uses a GET request to retrieve the list of zone members for the “qos” zone.StructureGET <base_URI>/running/brocade-zone/defined-configuration/zone/zone-name/<zone_name>URIGET http://10.10.10.10/rest/running/brocade-zone/defined-configuration/zone/zone-name/qos



Broadcom


Response BodyWhen the operation is successful, the response has a message body similar to the following, and a “200 OK”status in the headers. There are four member entries in this zone.<?xml version="1.0"?>

<Response>

<zone>

<zone-name>qos</zone-name>


<zone-type-string>zone</zone-type-string>

<member-entry>

<principal-entry-name>10:10:10:27:f8:8f:44:cd</principal-entry-name>

<entry-name>10:10:10:27:f8:f0:2a:e8</entry-name>



</member-entry>

</zone>

</Response>

Adding a Zone to the Defined ConfigurationThis example uses a POST request to create a user peer zone named “qos” to the defined configuration. Thiszone has four members.StructurePOST <base_URI>/running/brocade-zone/defined-configuration/zone/zone-name/<zone_name>URIPOST http://10.10.10.10/rest/running/brocade-zone/defined-configuration/zone/zone-name/qos

Request Body

<zone-type-string>user-created-peer-zone</zone-type-string>

<member-entry>

<principal-entry-name>10:10:10:27:f8:8f:44:cd</principal-entry-name>

<entry-name>10:10:10:27:f8:f0:2a:e8</entry-name>



</member-entry>

Response BodyWhen the operation is successful, the response contains an empty message body and a “201 Created” statusin the header.Deleting a Zone From the Defined ConfigurationThis example uses a DELETE request to delete the zone “zone_host_10” from the “cfg_auto” configuration.StructureDELETE <base_URI>/running/brocade-zone/defined-configuration/cfg/cfg-name/configuration_nameURIDELETE http://10.10.10.10/rest/running/brocade-zone/defined-configuration/cfg/cfg-name/cfg_auto

Request Body<member-zone>


Broadcom


<zone-name>zone_host_10</zone-name>

</member-zone>

Response BodyWhen the operation is successful, the response contains an empty message body and a “200 OK” status inthe header.Creating an AliasThis example uses a POST request to create the alias “ali_1”.StructurePOST <base_URI>/running/brocade-zone/defined-configuration/aliasURIPOST http://10.10.10.10/rest/running/brocade-zone/defined-configuration/alias

Request Body

<alias>

<alias-name>ali_1</alias-name>

<member-entry>

<alias-entry-name>1,3</alias-entry-name>

<alias-entry-name>10:10:10:38:85:9a:13:15</alias-entry-name>

</member-entry>

</alias>

Response BodyWhen the operation is successful, the response contains an empty message body and a “201 Created” statusin the header.

Viewing the Fabric Lock Data

This example uses a GET request to view the fabric lock data.

Structure

GET base_URI/running/brocade-zone/fabric-lock

URI

GET https://10.10.10.10/rest/running/brocade-zone/fabric-lock

Request Body


Response Body


<Response>

<fabric-lock>

<lock-principal-domain-id>0</lock-principal-domain-id>

</fabric-lock>

</Response>


Broadcom


History



Fabric OS 8.2.0a This API call was updated to include information about running a GET request on theeffective-configuration container for the db-max, db-avail, db-committed, or db-transactionparameters.

Fabric OS 8.2.1b The top-level container name changed from "zoning" to "brocade-zone". The previous top-level container name "zoning" is still supported in this release.

Fabric OS 9.0.0 This API call was modified to add the zone-type-string parameter and the fabric-lockcontainer.

Fabric OS 9.0.1 This API call was modified to edit the transaction-token parameter.


Broadcom


FOS REST API Modules for Extension FeaturesThis section details the REST API support for Extension modules. This section also provides examples for using theExtension modules.

brocade-extensionThis modules enables you to view information about Brocade extension objects as well as configure traffic control lists.

Module Tree

This is the tree view of the module from the brocade-extension.yang-tree.txt file. See YANG Module Overview for YANGnode field definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-extension

+--rw brocade-extension

+--ro dp-hcl-status* [slot dp-id] {fibrechannel:fibrechannel_extension_platform}?

| +--ro slot uint16

| +--ro dp-id extension:dp-id-type

| +--ro state? extension:dp-state-type

| +--ro status? extension:dp-actstate-type

| +--ro fc-hcl-stage? extension:dp-hcl-stage-type

| +--ro ip-hcl-stage? extension:dp-hcl-stage-type

| +--ro svi-swapped? boolean

| +--ro dp-communication-status? extension:dp-dp-communication-type


+--rw traffic-control-list* [traffic-control-list-name] {fibrechannel:fibrechannel_extension_platform}?

| +--rw traffic-control-list-name extension:extension-name-type

| +--rw traffic-control-list-name extension:extension-name-type

| +--rw admin-state-enabled? boolean

| +--ro cp-dp-synchronized? boolean

| +--rw action? extension:tcl-action-type

| +--rw target-ve-port? extension:ve-interface-type

| +--rw target-qos? extension:ip-qos-type

| +--rw target-slot? uint16

| +--rw target-dp-id? extension:dp-id-type

| +--rw source-address? union

| +--rw source-address-prefix-length? brocade-interface-types:ip-prefix-length

| +--rw destination-address? union

| +--rw destination-address-prefix-length? brocade-interface-types:ip-prefix-length

| +--rw port? string

| +--rw application? extension:extension-name-type

| +--rw dscp? string

| +--rw vlan? string

| +--rw l2cos? string

| +--rw l4-protocol? extension:l4-protocol-type

| +--rw reset-propagation-enabled? boolean

| +--rw segment-preservation-enabled? boolean

| +--rw non-terminated-enabled? boolean

| +--ro hit-count? yang:zero-based-counter64

+--ro lan-flow-statistics* [flow-index slot dp-id] {fibrechannel:fibrechannel_extension_platform}?


Broadcom


| +--ro flow-index uint32

| +--ro slot uint16

| +--ro dp-id extension:dp-id-type

| +--ro protocol? extension:l4-protocol-type

| +--ro source-port? inet:port-number

| +--ro destination-port? inet:port-number

| +--ro source-ip-address? inet:ip-address

| +--ro destination-ip-address? inet:ip-address

| +--ro traffic-control-list-name? extension:extension-name-type

| +--ro lan-interface? extension:extension-lan-interface-type

| +--ro mapped-tunnel

| | +--ro ve-port? extension:ve-interface-type

| | +--ro qos? extension:ip-qos-type

| +--ro vlan-id? uint32

| +--ro vlan-priority? uint32

| +--ro dscp? uint32

| +--ro hcl-flow? boolean

| +--ro active-flow? boolean

| +--ro start-time? yang:date-and-time

| +--ro end-time? yang:date-and-time

| +--ro rtt? yang:gauge32

| +--ro in-tcp-bytes? yang:zero-based-counter64

| +--ro in-tcp-packets? yang:zero-based-counter64

| +--ro out-tcp-bytes? yang:zero-based-counter64

| +--ro out-tcp-packets? yang:zero-based-counter64

| +--ro tcp-out-of-order-packets? yang:zero-based-counter64

| +--ro tcp-retransmits? yang:zero-based-counter64

| +--ro fast-retransmits? yang:zero-based-counter64

| +--ro slow-retransmits? yang:zero-based-counter64

| +--ro duplicate-acknowledgement? yang:zero-based-counter64

| +--ro zero-window-count? yang:zero-based-counter64

| +--ro zero-window-maximum-duration? yang:zero-based-counter64

| +--ro out-bytes-average? yang:gauge64

| +--ro in-bytes-average? yang:gauge64

| +--ro in-drops-lan-session-manager? yang:zero-based-counter64

| +--ro out-drops-lan-session-manager? yang:zero-based-counter64


| +--ro in-bytes-lan-session-manager? yang:zero-based-counter64

| +--ro in-packets-lan-session-manager? yang:zero-based-counter64

| +--ro out-bytes-lan-session-manager? yang:zero-based-counter64

| +--ro out-packets-lan-session-manager? yang:zero-based-counter64

| +--ro in-bytes-lan-compression? yang:zero-based-counter64

| +--ro in-bytes-wan-compression? yang:zero-based-counter64

| +--ro out-bytes-lan-compression? yang:zero-based-counter64

| +--ro out-bytes-wan-compression? yang:zero-based-counter64

| +--ro local-host-mss? yang:zero-based-counter32

| +--ro remote-host-mss? yang:zero-based-counter32

+--ro global-lan-statistics* [slot dp-id] {fibrechannel:fibrechannel_extension_platform}?

+--ro slot uint16

+--ro dp-id extension:dp-id-type

+--ro active-tcp-connections? yang:gauge32

+--ro active-tcp-connections-on-local-backup? yang:gauge32

+--ro active-tcp-connections-on-remote-backup? yang:gauge32


Broadcom


+--ro established-tcp-connections? yang:gauge32

+--ro closed-tcp-connections? yang:gauge32

+--ro out-tcp-bytes? yang:zero-based-counter64

+--ro in-tcp-bytes? yang:zero-based-counter64

+--ro tcp-tcl-deny-connections? yang:zero-based-counter64

+--ro tcp-tcl-lookup-fail? yang:zero-based-counter64

+--ro syn-received? yang:zero-based-counter64

+--ro syn-fail? yang:zero-based-counter64

+--ro drop-bytes? yang:zero-based-counter64

+--ro drop-packets? yang:zero-based-counter64

+--ro stale-reset-from-host? yang:zero-based-counter64

+--ro maximum-tcp-connection-exceeded-as-client? yang:zero-based-counter64

+--ro maximum-tcp-connection-exceeded-as-server? yang:zero-based-counter64

+--ro maximum-tcp-connection-per-second-exceeded-as-client? yang:zero-based-counter64

+--ro maximum-tcp-connection-per-second-exceeded-as-server? yang:zero-based-counter64

+--ro maximum-udp-connection-exceeded? yang:zero-based-counter64

+--ro maximum-udp-connection-exceeded-on-egress? yang:zero-based-counter64

+--ro udp-packets-sent-as-is? yang:zero-based-counter64

+--ro out-pdu-preserve-on? yang:zero-based-counter64

+--ro in-pdu-preserve-on? yang:zero-based-counter64

+--ro total-ipv6-packets? yang:zero-based-counter64

+--ro flow-control-on? yang:zero-based-counter64

+--ro flow-control-off? yang:zero-based-counter64

+--ro active-udp-connections? yang:zero-based-counter64

+--ro established-udp-connections? yang:zero-based-counter64

+--ro closed-udp-connections? yang:zero-based-counter64

+--ro udp-route-lookup-fail? yang:zero-based-counter64

+--ro udp-pdu-drops-due-to-pko-flow-control? yang:zero-based-counter64

+--ro out-udp-pdus? yang:zero-based-counter64

+--ro out-udp-pdu-drops? yang:zero-based-counter64

+--ro in-udp-pdus? yang:zero-based-counter64

+--ro in-udp-tcl-lookup-fail-pdus? yang:zero-based-counter64

+--ro in-udp-tcl-deny-pdus? yang:zero-based-counter64

+--ro in-total-udp-pdu-drops? yang:zero-based-counter64

+--ro in-udp-pdu-drops-due-to-stream-flow-control? yang:zero-based-counter64

+--ro out-icmp-pdus? yang:zero-based-counter64

+--ro out-icmp-pdu-drops? yang:zero-based-counter64

+--ro in-icmp-pdus? yang:zero-based-counter64

+--ro in-icmp-tcl-lookup-fail-pdus? yang:zero-based-counter64

+--ro in-icmp-tcl-deny-pdus? yang:zero-based-counter64

+--ro in-total-icmp-pdu-drops? yang:zero-based-counter64

+--ro in-icmp-pdu-drops-due-to-stream-flow-control? yang:zero-based-counter64

+--ro out-as-is-ip-pdus? yang:zero-based-counter64

+--ro out-as-is-ip-pdu-drops? yang:zero-based-counter64

+--ro in-as-is-ip-pdus? yang:zero-based-counter64

+--ro in-as-is-ip-tcl-lookup-fail-pdus? yang:zero-based-counter64

+--ro in-as-is-ip-tcl-deny-pdus? yang:zero-based-counter64

+--ro in-total-as-is-ip-pdu-drops? yang:zero-based-counter64

+--ro in-as-is-ip-pdu-drops-due-to-stream-flow-control? yang:zero-based-counter64

+--ro in-error-ip-checksum? yang:zero-based-counter64

+--ro in-error-tcp-checksum? yang:zero-based-counter64

+--ro in-error-mac? yang:zero-based-counter64

+--ro in-error-crc? yang:zero-based-counter64


Broadcom


+--ro in-error-parity? yang:zero-based-counter64

+--ro in-error-length? yang:zero-based-counter64

+--ro out-udp-packets-64-bytes? yang:zero-based-counter64










+--ro in-udp-packets-64-bytes? yang:zero-based-counter64










URI Format


• <base_URI>running/brocade-extension/dp-hcl-status/slot/slot_number/dp-id/dp_id to view theHCL status for the Extension switch or blade.

• <base_URI>running/brocade-extension/traffic-control-list/traffic-control-list-name/TCL_name to configure a traffic control list on the Extension switch or blade.

• <base_URI>running/brocade-extension/lan-flow-statistics/flow-index/flow_index_number/slot/slot_number/dp-id/dp_id to view the LAN flow statistics for the Extension switch or blade.

• <base_URI>running/brocade-extension/global-lan-statistics/slot/slot_number/dp-id/dp_id to view the global LAN statistics for the Extension switch or blade.

Parametersbrocade-extension

Description: The top-level container for this module.Flag: read-writeOptional: NoThis list has the following leafs:dp-hcl-status

Description: The HCL status on the extension data path processor. The switch must be an Extensionswitch.Key: slot; dp-idFlag: read-onlyOptional: NoThis list has the following leafs:slot

Description: The slot number of the data path processor.Flag: read-only


Broadcom


Type: uint16Value: The slot number of the data path processor.Optional: No

dp-idDescription: The The extension data path processor ID. Depending on the platform,it is eithera single DP or dual DP. If it is a single DP,only DP0 is supported. If it is a dual DP, both DP0 andDP1 are supported.Flag: read-onlyType: extension:dp-id-typeValue: 0 : DP01 : DP1Optional: No

stateDescription: The current DP HCL state.Flag: readConfig: falseType: extension:dp-state-typeValue: uninitialized = The DP state is uninitialized. This is an initial state that may be seenduring the bootup sequence of a DP. initializing = The DP state is initializing. This is an initialstate that may be seen during the bootup sequence of a DP. pre-connecting = The pre-connecting stage of CP-DP communication. connecting = The connection handshake of CP-DP communication in in progress. established = The DP state is in the established state.The connection handshake stage of CP-DP communication is completed. ready = The DPstate is ready. offline = The CP-DP connection is down. deferred-online = The DP state isdeferred-online. online = The DP state is online. The configuration replay synchronizing of theconfiguration from the CP is complete. connection-close = The CP-DP connection is goingdown. sync-failure = The DP state is CP-DP configuration sync-failure. sync-in-progress =The DP state is configuration sync-in-progress from the CP. sync-complete = The DP state isconfiguration sync-complete. reset = The DP is starting a reboot sequence. discovery = The DPstate is discovery from the CP. disconnecting = The DP state is disconnecting. faulty = The DPstate is faulty. invalid = The DP state is invalid.Optional: No

statusDescription: The current DP status.Flag: readConfig: falseType: extension:dp-actstate-typeValue: unavailable = The DP active state is unavailable. This is an initial state seen during thebootup sequence of a DP. inactive = The DP state is inactive. This state indicates no activeoperations on the DP in progress. active = The DP state is active. all-complete = The DP stateis all-complete. faulty = The DP state is faulty. invalid = The DP state is invalid.Optional: No

fc-hcl-stageDescription: The current DP HCL stage for FC protocol.Flag: readType: extension:dp-hcl-stage-typeValue: idle = The DP HA stage is idle. initializing = The DP HA stage is initializing. preparing= The DP HCL stage is preparing. FC-failover = The DP HCL stage is FC failover. IP-failover= The DP HCL stage is IP failover. reset = The DP HCL stage is DP reset. wait = The DP HCLstage is wait. FC-failback = The DP HCL stage is FC failback. IP-failback = The DP HCL stageis IP failback. DP-complete = The DP HCL stage is DP complete. slot-complete = The DP HCL


Broadcom


stage is HCL complete. DP-done = The DP HCL stage is DP done. VE-recovery = The DP HCLstage is VE recovery. The VE recovery is done for VE which have encountered issues duringHCL. simulator = The DP HCL stage is simulator. This is an internal state for DP. invalid = TheDP HCL stage is invalid that may be seen in error scenarios.Optional: No

ip-hcl-stageDescription: The current DP HCL stage for IP protocol.Flag: readType: extension:dp-hcl-stage-typeValue: idle = The DP HA stage is idle. initializing = The DP HA stage is initializing. preparing= The DP HCL stage is preparing. FC-failover = The DP HCL stage is FC failover. IP-failover= The DP HCL stage is IP failover. reset = The DP HCL stage is DP reset. wait = The DP HCLstage is wait. FC-failback = The DP HCL stage is FC failback. IP-failback = The DP HCL stageis IP failback. DP-complete = The DP HCL stage is DP complete. slot-complete = The DP HCLstage is HCL complete. DP-done = The DP HCL stage is DP done. VE-recovery = The DP HCLstage is VE recovery. The VE recovery is done for VE which have encountered issues duringHCL. simulator = The DP HCL stage is simulator. This is an internal state for DP. invalid = TheDP HCL stage is invalid that may be seen in error scenarios.Optional: No

svi-swappedDescription: Whether the SVI is swapped for HCL processing.Flag: read-onlyType: booleanValue: true = SVI is swapped for HCL processing. false = SVI is not swapped for HCLprocessing.Optional: No

dp-communication-statusDescription: The current state of the DP-DP communication.Flag: read-onlyType: extension:dp-dp-communication-typeValue: unknown = The DP-DP communication status is not known at this moment. This canbe seen in an initial boot up scenario when the CP-DP connection is not established or up. not-configured = The DP-DP communication status is not programmed or configured. This can beseen in an initial switch boot up scenario, a slot power off or power on sequence, HCL when theCP-DP connection is established but the programming of DP from CP is pending, or in an errorscenarios. For the Brocade 7810 switch, there is only one DP and it is not configured. up = TheDP-DP communication status is established. down = The DP-DP communication status is notestablished. not-applicable = The DP-DP communication status is not applicable.Optional: No

firmware-versionDescription: A human-readable string identifying the firmware version running on the data pathprocessor of the switch or blade.Flag: read-onlyType: stringValue: The firmware version running on the data path processor of the switch or blade.Optional: No

traffic-control-listDescription: A list of traffic control lists (TCLs) used to manage IP Extension LAN flows. The switch mustbe an Extension switch.Flag: read-writeKey: traffic-control-list-name


Broadcom


Optional: NoThis list has the following leafs:traffic-control-list-name

Description: The name of the TCL.Flag: read-writeType: extension:extension-name-typeValue: The name of the TCL.Optional: No

priorityDescription: The TCL priority provides an order of precedence to the TCL rule within the overallTCL list.Flag: read-writeType: uint32Value: A valid user-configured TCL priority value from 1 to 65534. 65535 = This priority is for thedefault TCL rule only and no other user-configured TCL can use this value. 0 = Indicates that thepriority is not set.Optional: No

admin-state-enabledDescription: Enables or disables the TCL admin status. The default is disabled.Flag: read-writeType: booleanValue: false = Disables the TCL admin status. true = Enables the TCL admin status.Optional: No

cp-dp-synchronizedDescription: Whether an admin status enabled TCL is synchronized between the CP-DP. Whenin error, the default value is failed (false). This parameter is available only when the TCL adminstate is enabled (admin-state-enabled = true).Flag: read-onlyType: booleanConfig: falseValue: false = The CP-DP synchronizing failed. true = The CP-DP is synchronized.Optional: No

actionDescription: Configures the TCL to allow or deny LAN traffic.Flag: read-writeType: extension:tcl-action-typeValue: Valid actions are as follows:allow = Allows LAN traffic based on the traffic-control-list input filters and should not be droppedand sent over the extension tunnel using a specific priority qos as per target details.deny = Denies the LAN traffic based on the traffic-control-list input filters and drops them at theingress.deny-dp = Denies the LAN ingress traffic only when sent to a specific DP.Optional: No

target-ve-portDescription: The extension tunnel VE_Port used to allow LAN ingress traffic to be sent over theWAN. This parameter is available only when configuring the TCL to allow LAN traffic (action =allow).Flag: readType: extension:ve-interface-typeValue: The slot and port number of the extension tunnel VE_Port in the format slot/port.


Broadcom


Optional: Notarget-qos

Description: The QoS priority associated with the extension tunnel used to allow LAN ingresstraffic over WAN. This parameter is available only when configuring the TCL to allow LAN traffic(action = allow).Flag: read-writeType: extension:ip-qos-typeValue: IP-priority-high = The logical or virtual segregation of an extension tunnel to providehighest priority QoS for IP LAN data traffic. This WAN optimized TCP traffic class is via perpriority TCP QoS. This is present only when the tunnel is a hybrid tunnel. IP-priority-medium= The logical and or physical segregation of an extension tunnel to provide medium priorityQoS for IP LAN data traffic. This WAN optimized TCP traffic class is via per priority TCP QoS.This is present only when the tunnel is a hybrid tunnel. IP-priority-low = The logical or virtualsegregation of an extension tunnel to provide low priority QoS for IP LAN data traffic. This WANoptimized TCP traffic class is via per priority TCP QoS. This is present only when the tunnel is ahybrid tunnel.Optional: No

target-slotDescription: The slot number of the Extension switch or blade. This parameter is available onlywhen configuring the TCL to deny LAN traffic sent to a specific DP (action = deny-dp).Flag: read-writeType: uint16Value: A valid slot number for the Extension switch or blade.For non-chassis platforms, the slot number is 0. For chassis platforms, the chassis slot number inwhich the extension blade is located. For chassis platforms, the slot number is non-zero value.Optional: No

target-dp-idDescription: The extension data path processor ID. Depending on the platform, it is either asingle DP or dual DP. If it is a single DP, only DP0 is supported. If it is a dual DP, both DP0 andDP1 are supported. This parameter is available only when configuring the TCL to deny LAN trafficsent to a specific DP (action = deny-dp).Flag: read-writeType: extension:dp-id-typeValue: 0 = DP0. 1 = DP1.Optional: No

source-addressDescription: The source IP address input filter for the TCL.Flag: read-writeType: union (inet:ip-address; string)Value: inet:ip-address = A valid source IP address input filter for the TCL. string = The value 'any'is the default value and is used to match any source IP address value.Optional: No

source-address-prefix-lengthDescription: The prefix length operator for the source IP address input filter. This parameter isavailable only when the source-address parameter is any (source-address != any).Flag: read-writeType: brocade-interface-types:ip-prefix-lengthValue: The prefix length operator.Optional: No


Broadcom


destination-addressDescription: The destination IP address input filter for the TCL.Flag: read-writeType: union (inet:ip-address; string)Value: inet:ip-address = A valid destination IP address input filter for the TCL. string = The value'any' is the default value and is used to match any destination IP address value.Optional: No

destination-address-prefix-lengthDescription: The prefix length operator for the destination IP address input filter. This parameteris available only when the destination-address parameter is any (source-address != any).Flag: read-writeType: brocade-interface-types:ip-prefix-lengthValue: The prefix length operator.Optional: No

portDescription: The protocol port input filter for the TCL. You can specify a single port, multipleports in a comma-separated list, a range of ports, or a combination of these. For example: 22 or300,302,305 or 600-603 or 300-302,305.Flag: read-writeType: stringValue: A valid protocol port input filter for the TCL.Optional: No

applicationDescription: The application input filter for the TCL. This includes a list of known applicationsalready present or a user-defined application name. The 'any' application type name is a specialvalue to identify any application.Flag: read-writeType: extension:extension-name-typeValue: Valid system-defined known applications include the following examples: CIFS, Data-Domain, FCIP, FTP, HTTP, and HTTPS.Optional: No

dscpDescription: The DSCP input filter for the TCL.Flag: read-writeType: stringValue: Valid values include 'any' and 0 to 63. Use the default value 'any' to match any specifiedDSCP value.Optional: No

vlanDescription: The VLAN input filter for the TCL.Flag: read-writeType: stringValue: Valid values include 'any' and 1 to 4095. Use the default value 'any' to match any specifiedVLAN ID value.Optional: No

l2cosDescription: The L2CoS input filter for the TCL.Flag: read-writeType: string


Broadcom


Value: Valid values include 'any' and 0 to 7. Use the default value 'any' to match any value ofL2CoS.Optional: No

l4-protocolDescription: The Layer 4 protocol input filter for the TCL.Flag: read-writeType: extension:l4-protocol-typeValue: Valid values include a known protocol string value, 'any', or a L4 protocol number. Thevalid range for an L4 protocol is 0 to 255. Use the default value 'any' to match any L4 protocolvalue. Valid known protocol string values from the system are as follows: ICMP, ICMP6, TCP,UDP, and VRRP.Optional: No

reset-propagation-enabledDescription: Enables or disables end-to-end reset propagation for the specified TCL. The defaultis false.Flag: read-writeType: booleanValue: false = Disables end-to-end reset propagation for the specified TCL. true = Enables end-to-end reset propagation for the specified TCL.Optional: No

segment-preservation-enabledDescription: Enables or disables segment preservation for the TCL. The default is disabled.Flag: read-writeType: booleanValue: false = Disables segment preservation for the TCL. true = Enables segment preservationfor the TCL.Optional: No

non-terminated-enabledDescription: Enables or disables non-terminated traffic for the specified TCL.Flag: read-writeType: booleanValue: false - Disables non-terminated traffic for the specified TCL. true - Enables non-terminatedtraffic for the specified TCL. The default is disabled.Optional: No

hit-countDescription: The total number of hits on the TCL rule.Flag: read-onlyType: yang:zero-based-counter64Config: falseValue: The total number of hits on the TCL rule.Optional: No

lan-flow-statisticsDescription: The LAN per-flow statistics. The switch must be an Extension switch in hybrid APP mode.Flag: read-onlyKey: flow-index; slot dp-idConfig: falseOptional: NoThis list has the following leafs:


Broadcom


flow-indexDescription: The flow index associated with the LAN flow. This is a dynamic index associatedwith the LAN flow. Depending on the LAN flow behavior, the index may change and be reusedafter some time. However, the index is always unique.Flag: read-onlyType: uint32Value: The flow index associated with the LAN flow.Optional: No

slotDescription: The slot number. For non-chassis platforms, the slot number is always 0. Forchassis platforms, the slot is the slot number (non-zero) of the chassis where the extension bladeis located.Flag: read-onlyType: uint16Value: The slot number.Optional: No

dp-idDescription: The extension data path processor ID associated with the flow. Depending on theplatform, it is either a single DP or dual DP. If it is a single DP, only DP0 is supported. If it is a dualDP, both DP0 and DP1 are supported.Flag: read-onlyType: extension:dp-id-typeValue: 0 = DP0. 1 = DP1.Optional: No

protocolDescription: The Layer 4 protocol of the flow.Flag: read-onlyType: extension:l4-protocol-typeValue: The Layer 4 protocol of the flow.Optional: No

source-portDescription: The source port number of the LAN flow.Flag: read-onlyType: inet:port-numberValue: The source port number of the LAN flow.Optional: No

destination-portDescription: The remote destination port number of the LAN flow.Flag: read-onlyType: inet:port-numberValue: The remote destination port number of the LAN flow.Optional: No

source-ip-addressDescription: The source IP address corresponding to the LAN flow.Flag: read-onlyType: inet:ip-addressValue: The source IP address corresponding to the LAN flow.Optional: No

destination-ip-addressDescription: The destination IP address corresponding to the LAN flow.


Broadcom


Flag: read-onlyType: inet:ip-addressValue: The destination IP address corresponding to the LAN flow.Optional: No

traffic-control-list-nameDescription: The TCL name matching the flow filter to allow the traffic.Flag: read-onlyType: extension:extension-name-typeValue: The TCL name matching the flow filter to allow the traffic.Optional: No

lan-interfaceDescription: The LAN interface corresponding to the traffic.Flag: read-onlyType: extension:extension-lan-interface-typeValue: Valid values include the GE_Port or LAG name associated with the LAN flow.Optional: No

mapped-tunnelDescription: The interface used for the extension tunnel.Flag: read-onlyOptional: NoThis container has the following leafs:ve-port

Description: The VE_Port of the extension tunnel interface.Flag: read-onlyType: extension:ve-interface-typeValue: The VE_Port of the extension tunnel interface. The slot and port number of theVE_Port in format slot/port.Optional: No

qosDescription: The IP priority QOS associated with the flow.Flag: read-onlyType: extension:ip-qos-typeValue: IP-priority-high = The logical or virtual segregation of an extension tunnel toprovide highest priority QoS for IP LAN data traffic. This WAN optimized TCP traffic classis via per priority TCP QoS. This is present only when the tunnel is a hybrid tunnel. IP-priority-medium = The logical and or physical segregation of an extension tunnel toprovide medium priority QoS for IP LAN data traffic. This WAN optimized TCP trafficclass is via per priority TCP QoS. This is present only when the tunnel is a hybrid tunnel.IP-priority-low = The logical or virtual segregation of an extension tunnel to providelow priority QoS for IP LAN data traffic. This WAN optimized TCP traffic class is via perpriority TCP QoS. This is present only when the tunnel is a hybrid tunnel.Optional: No

vlan-idDescription: The VLAN ID associated with the flow. When not set, this value displays as 0.Flag: read-onlyType: uint32Value: The VLAN ID associated with the flow.Optional: No

vlan-priorityDescription: The VLAN priority associated with the flow.


Broadcom


Flag: read-onlyType: uint32Value: The VLAN priority associated with the flow.Optional: No

dscpDescription: The DSCP value for the LAN flow.Flag: read-onlyType: uint32Value: The DSCP value for the LAN flow.Optional: No

hcl-flowDescription: Whether the LAN flow is in HCL.Flag: read-onlyType: booleanValue: true = The flow is in HCL. false = The flow is not in HCL.Optional: No

active-flowDescription: Whether the LAN flow is currently active.Flag: read-onlyType: booleanValue: true = The flow is active. false = The flow is not active.Optional: No

start-timeDescription: The LAN flow start time.Flag: read-onlyType: yang:date-and-timeValue: The LAN flow start time.Optional: No

end-timeDescription: The LAN flow end time. This parameter is available only when the flow is active(active-flow = false).Flag: read-onlyType: yang:date-and-timeValue: The LAN flow end time.Optional: No

rttDescription: The LAN flow round-trip-time.Flag: read-onlyType: yang:gauge32Value: The LAN flow round-trip-time.Optional: No

in-tcp-bytesDescription: The total bytes received.Flag: read-onlyType: yang:zero-based-counter64Value: The total bytes received.Optional: No

in-tcp-packetsDescription: The total TCP packets received.


Broadcom


Flag: read-onlyType: yang:zero-based-counter64Value: The total TCP packets received.Optional: No

out-tcp-bytesDescription: The total bytes sent.Flag: read-onlyType: yang:zero-based-counter64Value: The total bytes sent.Optional: No

out-tcp-packetsDescription: The total TCP packets sent.Flag: read-onlyType: yang:zero-based-counter64Value: The total TCP packets sent.Optional: No

tcp-out-of-order-packetsDescription: The total TCP out of order packets.Flag: read-onlyType: yang:zero-based-counter64Value: The total TCP out of order packets.Optional: No

tcp-retransmitsDescription: The TCP retransmits/lost packets.Flag: read-onlyType: yang:zero-based-counter64Value: The TCP retransmits/lost packets.Optional: No

fast-retransmitsDescription: The TCP fast retransmits count.Flag: read-onlyType: yang:zero-based-counter64Value: The TCP fast retransmits count.Optional: No

slow-retransmitsDescription: The TCP slow retransmits count.Flag: read-onlyType: yang:zero-based-counter64Value: The TCP slow retransmits count.Optional: No

duplicate-acknowledgementDescription: The TCP duplicate acknowledgements received.Flag: read-onlyType: yang:zero-based-counter64Value: The TCP duplicate acknowledgements received.Optional: No

zero-window-countDescription: The TCP zero window count.Flag: read-only


Broadcom


Type: yang:zero-based-counter64Value: The TCP zero window count.Optional: No

zero-window-maximum-durationDescription: The maximum number of zero window duration encountered.Flag: read-onlyType: yang:zero-based-counter64Value: The maximum number of zero window duration encountered.Optional: No

out-bytes-averageDescription: The throughput in bytes per second (Bps) for packets sent over the extensiontunnel on a WAN per 30s average.Flag: read-onlyType: yang:gauge64Value: The throughput in bytes per second (Bps) for packets sent over the extension tunnel on aWAN per 30s average.Optional: No

in-bytes-averageDescription: The throughput in Bps for packets received via an extension tunnel over a WAN per30s average.Flag: read-onlyType: yang:gauge64Value: The throughput in Bps for packets received via an extension tunnel over a WAN per 30saverage.Optional: No

in-drops-lan-session-managerDescription: The number of drops at the ingress port from the LAN session manager.Flag: read-onlyType: yang:zero-based-counter64Value: The number of drops at the ingress port from the LAN session manager.Optional: No

out-drops-lan-session-managerDescription: The number of drops at the egress port from LAN session manager.Flag: read-onlyType: yang:zero-based-counter64Value: The number of drops at the egress port from LAN session manager.Optional: No

crc-errorsDescription: The number of CRC errors.Flag: read-onlyType: yang:zero-based-counter64Value: The number of CRC errors.Optional: No

in-bytes-lan-session-managerDescription: The total bytes received by the LAN session manager.Flag: read-onlyType: yang:zero-based-counter64Value: The total bytes received by the LAN session manager.Optional: No


Broadcom


in-packets-lan-session-managerDescription: The total packets received by the LAN session manager.Flag: read-onlyType: yang:zero-based-counter64Value: The total packets received by the LAN session manager.Optional: No

out-bytes-lan-session-managerDescription: The total bytes sent by the LAN session manager.Flag: read-onlyType: yang:zero-based-counter64Value: The total bytes sent by the LAN session manager.Optional: No

out-packets-lan-session-managerDescription: The total packets sent by the LAN session manager.Flag: read-onlyType: yang:zero-based-counter64Value: The total packets sent by the LAN session manager.Optional: No

in-bytes-lan-compressionDescription: The total bytes received by the compression engine from the LAN.Flag: read-onlyType: yang:zero-based-counter64Value: The total bytes received by the compression engine from the LAN.Optional: No

in-bytes-wan-compressionDescription: The total bytes received by the compression engine from the WAN.Flag: read-onlyType: yang:zero-based-counter64Value: The total bytes received by the compression engine from the WAN.Optional: No

out-bytes-lan-compressionDescription: The total bytes sent by the compression engine on the LAN.Flag: read-onlyType: yang:zero-based-counter64Value: The total bytes sent by the compression engine on the LAN.Optional: No

| +--ro out-bytes-wan-compressionDescription: The total bytes sent the compression engine on the WAN.Flag: read-onlyType: yang:zero-based-counter64Value: The total bytes sent the compression engine on the WAN.Optional: No

local-host-mssDescription: The maximum segment size (MSS) of the TCP connection at the LAN ingress sideconnected host.Flag: read-onlyType: yang:zero-based-counter32Value: The maximum segment size (MSS) of the TCP connection at the LAN ingress sideconnected host.Optional: No


Broadcom


remote-host-mssDescription: The MSS of the TCP connection at the peer extension tunnel endpoint connectedhost to its the LAN ingress side.Flag: read-onlyType: yang:zero-based-counter32Value: The MSS of the TCP connection at the peer extension tunnel endpoint connected host toits the LAN ingress side.Optional: No

global-lan-statisticsDescription: The global LAN DP statistics for an Extension blade or switch. The switch must be anExtension switch in hybrid APP mode.Flag: read-onlyKey: slot; dp-idOptional: NoThis list has the following leafs:slot

Description: The slot number for the Extension platform. For non-chassis platforms, the slotnumber is always 0. For chassis platforms, the slot is the slot number (non-zero) of the chassiswhere the Extension blade is located.Flag: read-onlyType: uint16Value: The slot number for the Extension platform.Optional: No

dp-idDescription: The extension data path processor ID. Depending on the platform, it is either asingle DP or dual DP. If it is a single DP, only DP0 is supported. If it is a dual DP, both DP0 andDP1 are supported.Flag: read-onlyType: extension:dp-id-typeValue: 0 = DP0. 1 = DP1.Optional: No

active-tcp-connectionsDescription: The active TCP connection count.Flag: read-onlyType: yang:gauge32Value: The active TCP connection count.Optional: No

+--ro active-tcp-connections-on-local-backup? yang:gauge32Description: The active clone HCL TCP connection count on the local backup tunnel.Flag: read-onlyType: yang:gauge32Value: The active clone HCL TCP connection count on the local backup tunnel.Optional: No

active-tcp-connections-on-remote-backupDescription: The active clone HCL TCP connection count on the remote backup tunnel.Flag: read-onlyType: yang:gauge32Value: The active clone HCL TCP connection count on the remote backup tunnel.Optional: No


Broadcom


established-tcp-connectionsDescription: The total number of LAN TCP connections established.Flag: read-onlyType: yang:gauge32Value: The total number of LAN TCP connections established.Optional: No

closed-tcp-connectionsDescription: The total number of LAN TCP connections closed.Flag: read-onlyType: yang:gauge32Value: The total number of LAN TCP connections closed.Optional: No

out-tcp-bytesDescription: The total number of TCP bytes transmitted.Flag: read-onlyType: yang:zero-based-counter64Value: The total number of TCP bytes transmitted.Optional: No

in-tcp-bytesDescription: The total number of TCP bytes received.Flag: read-onlyType: yang:zero-based-counter64Value: The total number of TCP bytes received.Optional: No

tcp-tcl-deny-connectionsDescription: The number of TCP connections denied based on the TCL deny rule.Flag: read-onlyType: yang:zero-based-counter64Value: The number of TCP connections denied based on the TCL deny rule.Optional: No

tcp-tcl-lookup-failDescription: The number of TCP connections denied based on TCL lookup failure.Flag: read-onlyType: yang:zero-based-counter64Value: The number of TCP connections denied based on TCL lookup failure.Optional: No

syn-receivedDescription: The number of synchronize (SYN) packets received.Flag: read-onlyType: yang:zero-based-counter64Value: The number of SYN packets received.Optional: No

syn-failDescription: The number of SYN packets dropped due to error.Flag: read-onlyType: yang:zero-based-counter64Value: The number of SYN packets dropped due to error.Optional: No


Broadcom


drop-bytesDescription: The number of LSM transmit TCP dropped bytes.Flag: read-onlyType: yang:zero-based-counter64Value: The number of LSM transmit TCP dropped bytes.Optional: No

drop-packetsDescription: The number of LSM packets dropped in egress.Flag: read-onlyType: yang:zero-based-counter64Value: The number of LSM packets dropped in egress.Optional: No

stale-reset-from-hostDescription: The number of stale resets from the host.Flag: read-onlyType: yang:zero-based-counter64Value: The number of stale resets from the host.Optional: No

maximum-tcp-connection-exceeded-as-clientDescription: The number of times the maximum TCP connection was exceeded on listenconnection allocation.Flag: read-onlyType: yang:zero-based-counter64Value: The number of times the maximum TCP connection was exceeded on listen connectionallocation.Optional: No

maximum-tcp-connection-exceeded-as-serverDescription: The number of times the maximum connection was exceeded during activeconnection allocation.Flag: read-onlyType: yang:zero-based-counter64Value: The number of times the maximum connection was exceeded during active connectionallocation.Optional: No

maximum-tcp-connection-per-second-exceeded-as-clientDescription: The number of times the maximum connection per second was exceeded on listenconnection allocation.Flag: read-onlyType: yang:zero-based-counter64Value: The number of times the maximum connection per second was exceeded on listenconnection allocation.Optional: No

maximum-tcp-connection-per-second-exceeded-as-serverDescription: The number of times the maximum connection per second was exceeded on listenconnection allocation.Flag: read-onlyType: yang:zero-based-counter64Value: The number of times the maximum connection per second was exceeded on listenconnection allocation.Optional: No


Broadcom


maximum-udp-connection-exceededDescription: The total number of UDP flows failed due to exceeding the maximum on ingressand egress.Flag: read-onlyType: yang:zero-based-counter64Value: The total number of UDP flows failed due to exceeding the maximum on ingress andegress.Optional: No

maximum-udp-connection-exceeded-on-egressDescription: The total number of UDP flows failed due to exceeding the maximum on egress.Flag: read-onlyType: yang:zero-based-counter64Value: The total number of UDP flows failed due to exceeding the maximum on egress.Optional: No

udp-packets-sent-as-isDescription: The total number of UDP packets sent as-is.Flag: read-onlyType: yang:zero-based-counter64Value: The total number of UDP packets sent as-is.Optional: No

out-pdu-preserve-onDescription: The number of packets transmits with PDU preserve on.Flag: read-onlyType: yang:zero-based-counter64Value: The number of packets transmits with PDU preserve on.Optional: No

in-pdu-preserve-onDescription: The number of packets received with PDU preserve on.Flag: read-onlyType: yang:zero-based-counter64Value: The number of packets received with PDU preserve on.Optional: No

total-ipv6-packetsDescription: The total number of IPv6 packets received - IPv6 WQEs received by the IP APIlayer.Flag: read-onlyType: yang:zero-based-counter64Value: The total number of IPv6 packets received - IPv6 WQEs received by the IP API layer.Optional: No

flow-control-onDescription: The number of times flow control is on from FTNL.Flag: read-onlyType: yang:zero-based-counter64Value: The number of times flow control is on from FTNL.Optional: No

flow-control-offDescription: The number of times flow control is off from FTNL.Flag: read-onlyType: yang:zero-based-counter64Value: The number of times flow control is off from FTNL.


Broadcom


Optional: Noactive-udp-connections

Description: The number of active NT UDP flows.Flag: read-onlyType: yang:zero-based-counter64Value: The number of active NT UDP flows.Optional: No

established-udp-connectionsDescription: The number of UDP connections opened since bootup.Flag: read-onlyType: yang:zero-based-counter64Value: The number of UDP connections opened since bootup.Optional: No

closed-udp-connectionsDescription: The number of UDP connections closed since bootup.Flag: read-onlyType: yang:zero-based-counter64Value: The number of UDP connections closed since bootup.Optional: No

udp-route-lookup-failDescription: The number of NT PDUs dropped on egress due to route lookup failure.Flag: read-onlyType: yang:zero-based-counter64Value: The number of NT PDUs dropped on egress due to route lookup failure.Optional: No

udp-pdu-drops-due-to-pko-flow-controlDescription: The number of NT PDUs dropped on egress due to PKO flow control.Flag: read-onlyType: yang:zero-based-counter64Value: The number of NT PDUs dropped on egress due to PKO flow control.Optional: No

out-udp-pdusDescription: The number of transmit UDP PDUs.Flag: read-onlyType: yang:zero-based-counter64Value: The number of transmit UDP PDUs.Optional: No

out-udp-pdu-dropsDescription: The number of transmit UDP PDUs dropped.Flag: read-onlyType: yang:zero-based-counter64Value: The number of transmit UDP PDUs dropped.Optional: No

in-udp-pdusDescription: The number of UDP PDUs received from host.Flag: read-onlyType: yang:zero-based-counter64Value: The number of UDP PDUs received from host.Optional: No


Broadcom


in-udp-tcl-lookup-fail-pdusDescription: The number of UDP PDUs dropped due to TCL lookup.Flag: read-onlyType: yang:zero-based-counter64Value: The number of UDP PDUs dropped due to TCL lookup.Optional: No

in-udp-tcl-deny-pdusDescription: The number of UDP PDUs dropped due to TCL deny.Flag: read-onlyType: yang:zero-based-counter64Value: The number of UDP PDUs dropped due to TCL deny.Optional: No

in-total-udp-pdu-dropsDescription: The total number of UDP PDUs dropped.Flag: read-onlyType: yang:zero-based-counter64Value: The total number of UDP PDUs dropped.Optional: No

in-udp-pdu-drops-due-to-stream-flow-controlDescription: number of UDP PDUs dropped due to stream flow control.Flag: read-onlyType: yang:zero-based-counter64Value: number of UDP PDUs dropped due to stream flow control.Optional: No

out-icmp-pdusDescription: The number of transmit ICMP PDUs.Flag: read-onlyType: yang:zero-based-counter64Value: The number of transmit ICMP PDUs.Optional: No

out-icmp-pdu-dropsDescription: The number of transmit ICMP PDUs dropped.Flag: read-onlyType: yang:zero-based-counter64Value: The number of transmit ICMP PDUs dropped.Optional: No

in-icmp-pdusDescription: The number of ICMP PDUs received.Flag: read-onlyType: yang:zero-based-counter64Value: The number of ICMP PDUs received.Optional: No

in-icmp-tcl-lookup-fail-pdusDescription: The number of ICMP PDUs dropped due to TCL lookup failure.Flag: read-onlyType: yang:zero-based-counter64Value: The number of ICMP PDUs dropped due to TCL lookup failure.Optional: No


Broadcom


in-icmp-tcl-deny-pdusDescription: The number of ICMP PDUs dropped due to TCL returning deny status.Flag: read-onlyType: yang:zero-based-counter64Value: The number of ICMP PDUs dropped due to TCL returning deny status.Optional: No

in-total-icmp-pdu-dropsDescription: The total number of ICMP PDU drops.Flag: read-onlyType: yang:zero-based-counter64Value: The total number of ICMP PDU drops.Optional: No

in-icmp-pdu-drops-due-to-stream-flow-controlDescription: The number of ICMP PDU drops due to stream flow control.Flag: read-onlyType: yang:zero-based-counter64Value: The number of ICMP PDU drops due to stream flow control.Optional: No

out-as-is-ip-pdusDescription: The number of as-is transmit IP PDUs.Flag: read-onlyType: yang:zero-based-counter64Value: The number of as-is transmit IP PDUs.Optional: No

out-as-is-ip-pdu-dropsDescription: The number of as-is transmit IP PDUs dropped.Flag: read-onlyType: yang:zero-based-counter64Value: The number of as-is transmit IP PDUs dropped.Optional: No

in-as-is-ip-pdusDescription: The number of non-terminated TCP, non-batched UDP, and non-ICMP PDUsreceived.Flag: read-onlyType: yang:zero-based-counter64Value: The number of non-terminated TCP, non-batched UDP, and non-ICMP PDUs received.Optional: No

in-as-is-ip-tcl-lookup-fail-pdusDescription: The number of non-terminated TCP, non-batched UDP, and non-ICMP PDUsdropped due to TCL lookup failure.Flag: read-onlyType: yang:zero-based-counter64Value: The number of non-terminated TCP, non-batched UDP, and non-ICMP PDUs dropped dueto TCL lookup failure.Optional: No

in-as-is-ip-tcl-deny-pdusDescription: The number of non-terminated TCP, non-batched UDP, and non-ICMP PDUsdropped due to TCL deny status.Flag: read-onlyType: yang:zero-based-counter64


Broadcom


Value: The number of non-terminated TCP, non-batched UDP, and non-ICMP PDUs dropped dueto TCL deny status.Optional: No

in-total-as-is-ip-pdu-dropsDescription: The total non-terminated TCP, non-batched UDP, and non-ICMP PDUs dropped iningress.Flag: read-onlyType: yang:zero-based-counter64Value: The total non-terminated TCP, non-batched UDP, and non-ICMP PDUs dropped iningress.Optional: No

in-as-is-ip-pdu-drops-due-to-stream-flow-controlDescription: The number of non-terminated TCP, non-batched UDP, and non-ICMP PDUsdropped due to stream flow control.Flag: read-onlyType: yang:zero-based-counter64Value: The number of non-terminated TCP, non-batched UDP, and non-ICMP PDUs dropped dueto stream flow control.Optional: No

in-error-ip-checksumDescription: The number of IP checksum errors detected on receive packets.Flag: read-onlyType: yang:zero-based-counter64Value: The number of IP checksum errors detected on receive packets.Optional: No

in-error-tcp-checksumDescription: The number of TCP checksum errors detected on receive packets.Flag: read-onlyType: yang:zero-based-counter64Value: The number of TCP checksum errors detected on receive packets.Optional: No

in-error-macDescription: The number of MAC errors detected on receive packets.Flag: read-onlyType: yang:zero-based-counter64Value: The number of MAC errors detected on receive packets.Optional: No

in-error-crcDescription: The number of CRC errors detected on receive packets.Flag: read-onlyType: yang:zero-based-counter64Value: The number of CRC errors detected on receive packets.Optional: No

in-error-parityDescription: The number of parity errors detected on receive packets.Flag: read-onlyType: yang:zero-based-counter64Value: The number of parity errors detected on receive packets.Optional: No


Broadcom


in-error-lengthDescription: The number of length errors detected on receive packets.Flag: read-onlyType: yang:zero-based-counter64Value: The number of length errors detected on receive packets.Optional: No

out-udp-packets-64-bytesDescription: The number of UDP packets transmitted that are less than 64 bytes.Flag: read-onlyType: yang:zero-based-counter64Value: The number of UDP packets transmitted that are less than 64 bytes.Optional: No

out-udp-packets-128-bytesDescription: The number of UDP packets transmitted equal to or greater than 64 bytes but lessthan 128 bytes.Flag: read-onlyType: yang:zero-based-counter64Value: The number of UDP packets transmitted equal to or greater than 64 bytes but less than128 bytes.Optional: No




out-udp-packets-1500-bytesDescription: The number of UDP packets transmitted equal to or greater than 1024 bytes butless than 1500 bytes.Flag: read-onlyType: yang:zero-based-counter64


Broadcom


Value: The number of UDP packets transmitted equal to or greater than 1024 bytes but less than1500 bytes.Optional: No

out-udp-packets-3000-bytesDescription: The number of UDP packets transmitted equal to or greater than 1500 bytes butless than 3000 bytes.Flag: read-onlyType: yang:zero-based-counter64Value: The number of UDP packets transmitted equal to or greater than 1500 bytes but less than3000 bytes.Optional: No




in-udp-packets-64-bytesDescription: The number of UDP packets received less than 64 bytes.Flag: read-onlyType: yang:zero-based-counter64Value: The number of UDP packets received less than 64 bytes.Optional: No

in-udp-packets-128-bytesDescription: The number of UDP packets received equal to or greater than 64 bytes but lessthan 128 bytes.Flag: read-onlyType: yang:zero-based-counter64Value: The number of UDP packets received equal to or greater than 64 bytes but less than 128bytes.Optional: No


Broadcom




in-udp-packets-1024-bytesDescription: The number of UDP packets received equal to or greater than 512 bytes but lessthan 1024 bytes.Flag: read-onlyType: yang:zero-based-counter64Value: The number of UDP packets received equal to or greater than 512 bytes but less than1024 bytes.Optional: No





Broadcom




Supported Methods

The GET, POST, PATCH, OPTIONS, and HEAD operations are supported in this module.

Examples

This section provides basic examples for using the brocade-extension module.

Viewing the Extension HCL Status

This example uses a GET request to view the HCL status for the Extension switch or blade.

Structure

GET <base_URI>/running/brocade-extension/dp-hcl-status/slot/slot_number/dp-id/dp_id

URI

GET https://10.10.10.10/rest/running/brocade-extension/dp-hcl-status/slot/8/dp-id/0

Request Body


Response Body



<Response>

<dp-hcl-status>

<slot>8</slot>

<dp-id>0</dp-id>

<status>inactive</status>

<state>online</state>


<fc-hcl-stage>idle</fc-hcl-stage>

<ip-hcl-stage>idle</ip-hcl-stage>


Broadcom


<svi-swapped>false</svi-swapped>

<dp-communication-status>up</dp-communication-status>

</dp-hcl-status>

</Response>

Viewing the Traffic Control Lists

This example uses a GET request to view all traffic control lists configured on the Extension switch or blade.

Structure

GET <base_URI>/running/brocade-extension/traffic-control-list/

URI

GET https://10.10.10.10/rest/running/brocade-extension/traffic-control-list/

Request Body


Response Body



<Response>

<traffic-control-list>

<traffic-control-list-name>Test2</traffic-control-list-name>

<priority>2</priority>

<admin-state-enabled>true</admin-state-enabled>

<cp-dp-synchronized>true</cp-dp-synchronized>

<target-ve-port>8/17</target-ve-port>

<target-qos>IP-priority-medium</target-qos>

<vlan>any</vlan>

<l2cos>any</l2cos>

<dscp>any</dscp>

<source-address>any</source-address>

<destination-address>any</destination-address>

<l4-protocol>any</l4-protocol>

<port>any</port>

<application>any</application>

<action>allow</action>

<reset-propagation-enabled>false</reset-propagation-enabled>

<segment-preservation-enabled>false</segment-preservation-enabled>

<non-terminated-enabled>false</non-terminated-enabled>

<hit-count>13297</hit-count>

</traffic-control-list>


<traffic-control-list-name>default</traffic-control-list-name>



<cp-dp-synchronized>true</cp-dp-synchronized>


Broadcom


<vlan>any</vlan>

<l2cos>any</l2cos>

<dscp>any</dscp>




<port>any</port>


<action>deny</action>




<hit-count>23383</hit-count>


</Response>

Configuring a Traffic Control List

This example uses a POST request to configure a traffic control list on the Extension switch or blade.

Structure

POST <base_URI>/running/brocade-extension/traffic-control-list

URI

POST https://10.10.10.10/rest/running/brocade-extension/traffic-control-list

Request Body


<traffic-control-list-name>Test2</traffic-control-list-name>



<target-ve-port>8/17</target-ve-port>

<target-qos>IP-priority-medium</target-qos>

<vlan>any</vlan>

<l2cos>any</l2cos>

<dscp>any</dscp>




<port>any</port>


<action>allow</action>





Response Body

When the resource is successfully created, the response contains an empty message body and a “201 Created” status inthe headers.


Broadcom


Enabling the Admin Status of a Traffic Control List

This example uses a PATCH request to enable the admin status of the Test3 traffic control list.

Structure

PATCH <base_URI>/running/brocade-extension/traffic-control-list/<traffic-control-list-name>/rule0/admin-state-enabled/true

URI

PATCH https://10.10.10.10/rest/running/brocade-extension/traffic-control-list/traffic-control-list-name/rule0/

admin-state-enabled/true

Request Body


Response Body


Deleting a Traffic Control List

This example uses a DELETE request to delete the Test3 traffic control list..

Structure

DELETE <base_URI>/running/brocade-extension/traffic-control-list/<traffic_control_list_name>

URI

DELETE https://10.10.10.10/rest/running/brocade-extension/traffic-control-list/traffic-control-list-name/Test3

Request Body


Response Body


Viewing the LAN Flow Statistics

This example uses a GET request to view the LAN flow statistics for the Extension switch or blade.

Structure

GET <base_URI>/running/running/brocade-extension/lan-flow-statistics/flow-index/flow_index/slot/slot_number/dp-id/dp_id

URI

GET https://10.10.10.10/rest/running/brocade-extension/lan-flow-statistics/flow-index/7/slot/0/dp-id/0

Request Body


Response Body


<Response>

<lan-flow-statistics>


Broadcom


<flow-index>7</flow-index>

<slot>0</slot>

<dp-id>0</dp-id>

<protocol>TCP</protocol>



<source-ip-address>174.10.6.5</source-ip-address>

<destination-ip-address>165.105.21.5</destination-ip-address>

<lan-interface>0/6</lan-interface>

<mapped-tunnel>

<ve-port>0/12</ve-port>

<qos>IP-priority-high</qos>

</mapped-tunnel>

<vlan-id>0</vlan-id>

<vlan-priority>0</vlan-priority>

<dscp>0</dscp>

<hcl-flow>false</hcl-flow>

<active-flow>true</active-flow>

<start-time>2020-01-29T17:56:09-08:00</start-time>

<rtt>0</rtt>

<in-tcp-bytes>189636844</in-tcp-bytes>

<in-tcp-packets>126487</in-tcp-packets>

<out-tcp-bytes>1176216</out-tcp-bytes>

<out-tcp-packets>29405</out-tcp-packets>

<tcp-out-of-order-packets>0</tcp-out-of-order-packets>

<tcp-retransmits>0</tcp-retransmits>

<fast-retransmits>0</fast-retransmits>

<slow-retransmits>0</slow-retransmits>

<duplicate-acknowledgement>0</duplicate-acknowledgement>

<zero-window-count>5355</zero-window-count>

<zero-window-maximum-duration>17</zero-window-maximum-duration>

<in-bytes-average>0</in-bytes-average>

<out-bytes-average>0</out-bytes-average>

<in-drops-lan-session-manager>0</in-drops-lan-session-manager>

<out-drops-lan-session-manager>0</out-drops-lan-session-manager>

<in-bytes-lan-session-manager>184577352</in-bytes-lan-session-manager>

<out-bytes-lan-session-manager>4</out-bytes-lan-session-manager>

<in-packets-lan-session-manager>0</in-packets-lan-session-manager>

<out-packets-lan-session-manager>1</out-packets-lan-session-manager>

<crc-errors>0</crc-errors>

<local-host-mss>1460</local-host-mss>

<remote-host-mss>1460</remote-host-mss>

</lan-flow-statistics>

Viewing the Global LAN Statistics

This example uses a GET request to view the global LAN statistics for the Extension switch or blade.

Structure

GET <base_URI>/running/brocade-extension/global-lan-statistics/slot/slot_number/dp-id/dp_id

URI

GET https://10.10.10.10/rest/running/brocade-extension/global-lan-statistics/slot/8/dp-id/0


Broadcom


Request Body


Response Body

<Response>

<global-lan-statistics>

<slot>8</slot>

<dp-id>0</dp-id>

<active-tcp-connections>0</active-tcp-connections>

<active-tcp-connections-on-local-backup>0</active-tcp-connections-on-local-backup>

<active-tcp-connections-on-remote-backup>0</active-tcp-connections-on-remote-backup>

<established-tcp-connections>0</established-tcp-connections>

<closed-tcp-connections>0</closed-tcp-connections>



<tcp-tcl-deny-connections>0</tcp-tcl-deny-connections>

<tcp-tcl-lookup-fail>0</tcp-tcl-lookup-fail>

<syn-received>0</syn-received>

<syn-fail>0</syn-fail>

<drop-bytes>0</drop-bytes>

<drop-packets>0</drop-packets>

<stale-reset-from-host>0</stale-reset-from-host>

<maximum-tcp-connection-exceeded-as-client>0</maximum-tcp-connection-exceeded-as-client>

<maximum-tcp-connection-exceeded-as-server>0</maximum-tcp-connection-exceeded-as-server>

<maximum-tcp-connection-per-second-exceeded-as-client>0</maximum-tcp-connection-per-second-exceeded-

as-client>

<maximum-tcp-connection-per-second-exceeded-as-server>0</maximum-tcp-connection-per-second-exceeded-

as-server>

<maximum-udp-connection-exceeded>0</maximum-udp-connection-exceeded>

<maximum-udp-connection-exceeded-on-egress>0</maximum-udp-connection-exceeded-on-egress>

<udp-packets-sent-as-is>0</udp-packets-sent-as-is>

<out-pdu-preserve-on>0</out-pdu-preserve-on>

<in-pdu-preserve-on>0</in-pdu-preserve-on>

<total-ipv6-packets>12829</total-ipv6-packets>

<flow-control-on>0</flow-control-on>

<flow-control-off>0</flow-control-off>

<active-udp-connections>0</active-udp-connections>

<established-udp-connections>11643</established-udp-connections>

<closed-udp-connections>11643</closed-udp-connections>

<udp-route-lookup-fail>0</udp-route-lookup-fail>

<udp-pdu-drops-due-to-pko-flow-control>0</udp-pdu-drops-due-to-pko-flow-control>

<out-udp-pdus>0</out-udp-pdus>

<out-udp-pdu-drops>0</out-udp-pdu-drops>

<in-udp-pdus>20549</in-udp-pdus>

<in-udp-tcl-lookup-fail-pdus>15</in-udp-tcl-lookup-fail-pdus>

<in-udp-tcl-deny-pdus>1036</in-udp-tcl-deny-pdus>

<in-total-udp-pdu-drops>1077</in-total-udp-pdu-drops>

<in-udp-pdu-drops-due-to-stream-flow-control>0</in-udp-pdu-drops-due-to-stream-flow-control>

<out-icmp-pdus>0</out-icmp-pdus>

<out-icmp-pdu-drops>0</out-icmp-pdu-drops>

<in-icmp-pdus>0</in-icmp-pdus>


Broadcom


<in-icmp-tcl-lookup-fail-pdus>0</in-icmp-tcl-lookup-fail-pdus>

<in-icmp-tcl-deny-pdus>0</in-icmp-tcl-deny-pdus>

<in-total-icmp-pdu-drops>0</in-total-icmp-pdu-drops>

<in-icmp-pdu-drops-due-to-stream-flow-control>0</in-icmp-pdu-drops-due-to-stream-flow-control>

<out-as-is-ip-pdus>0</out-as-is-ip-pdus>

<out-as-is-ip-pdu-drops>0</out-as-is-ip-pdu-drops>

<in-as-is-ip-pdus>1764</in-as-is-ip-pdus>

<in-as-is-ip-tcl-lookup-fail-pdus>12</in-as-is-ip-tcl-lookup-fail-pdus>

<in-as-is-ip-tcl-deny-pdus>84</in-as-is-ip-tcl-deny-pdus>

<in-total-as-is-ip-pdu-drops>96</in-total-as-is-ip-pdu-drops>

<in-as-is-ip-pdu-drops-due-to-stream-flow-control>0</in-as-is-ip-pdu-drops-due-to-stream-flow-control>

<in-error-ip-checksum>0</in-error-ip-checksum>

<in-error-tcp-checksum>0</in-error-tcp-checksum>

<in-error-mac>0</in-error-mac>

<in-error-crc>0</in-error-crc>

<in-error-parity>0</in-error-parity>

<in-error-length>0</in-error-length>

<out-udp-packets-64-bytes>0</out-udp-packets-64-bytes>










<in-udp-packets-64-bytes>6263</in-udp-packets-64-bytes>










</global-lan-statistics>

</Response>

History




Broadcom


brocade-extension-ip-routeThis module is used to retrieve or configure IP route information on the specified switch.

Module Tree

This is the tree view of the module from the brocade-extension-ip-route.yang-tree.txt file. See YANG Module Overview forYANG node field definitions and possible values, and see Supported Data Types for data type descriptions.module: brocade-extension-ip-route

+--rw brocade-extension-ip-route

+--rw extension-ip-route* [name dp-id ip-address ip-prefix-length]

+--rw name ge-interface-type

+--rw dp-id uint16

+--rw ip-address inet:ip-address

+--rw ip-prefix-length ip-prefix-length

+--rw ip-gateway ip-gateway-type

+--ro status-flags? string

URI Format


<base_URI>/running/brocade-extension-ip-route/extension-ip-route/ followed by the leafs as listed inthe module tree to create, modify, or delete an IP route.

Parametersbrocade-extension-ip-route

Description: The module container.Optional: NoFlag: read-writeThis container has the following leafs.extension-ip-route

Description: The static IP route on the IP interface defined on an extension blade or system.Flag: read-writeKey: name plus dp-id plus ip-address plus ip-prefix-length. All must be included to identify aspecific interface.This list has the following leafs.name

Description: The name of the interface.Flag: read-writeType: ge-interface-typeValues: The slot and port number of the port in the format “slot/port”.Optional: No

dp-idDescription: The Extension Data Path Processor ID associated with the IP interface.Flag: read-writeType: uint16Values: Either 0 or 1. There is no default value.Optional: No

ip-addressDescription: The destination IPv4 or IPv6 address.


Broadcom


Flag: read-writeType: inet:ip-addressValues: An address in valid IPv4 or IPv6 format.Optional: No

ip-prefix-lengthDescription: The prefix length operator for the destination IP address. Once set, prefix lengthcan not be changed.Flag: read-writeType: ip-prefix-lengthValues: A value in the range from 1 to 32 for IPv4 or from 1 to 128 for IPv6. There is no defaultvalue.Optional: No

ip-gatewayDescription: The IP address of an IP router that can route packets to the destination IP address.The gateway address must be on the same IP subnet as one of the port IP addresses. Once set,the IP gateway address can not be changed. This operand is optional with IPv6 addresses.Flag: read-writeType: inet:ip-gateway-typeValues: An address in valid IPv4 or IPv6 format.Mandatory: True during route creation using POST operationsOptional: This leaf is optional, except in POST route creation operations

status-flagsDescription: IP route status flags.Flag: read-onlyType: StringValues:C = Created (Interface)G = GatewayH = HostL = Link LayerU = UsableS = StaticOptional: Yes

Supported Methods


ExamplesCreating an IP RouteThe following example uses POST to create an IP route to 3.0.0.0 using port 4/0 on the 2.2.2.3 gateway.StructurePOST <base_URI>/running/brocade-extension-ip-route/extension-ip-routeURIPOST http://10.10.10.10/rest/running/brocade-extension-ip-route/extension-ip-route

Request BodyWhen the operation is successful, the response has a message body similar to the following, and a “200 OK”status in the headers.


Broadcom


<extension-ip-route>

<name>4/0</name>



<dp-id>0</dp-id>


</extension-ip-route>

Response BodyWhen the resource is successfully deleted, the response contains an empty message body and a "201Created" status in the first line of the headers.Deleting an IP RouteThe following example uses DELETE to delete the IP route to 3.0.0.0 from port 4/0.StructureDELETE <base_URI>/running/brocade-extension-ip-route/extension-ip-routeURIDELETE http://10.10.10.10/rest/running/brocade-extension-ip-route/extension-ip-route

Request Body<extension-ip-route>

<name>4/0</name>



<dp-id>0</dp-id>


Response BodyWhen the operation is successful, the response contains an empty message body and a "204 No Content"status in the first line of the headers.Retrieving an IP RouteThe following example uses GET to retrieve all the IP routes on the switch.StructureGET <base_URI>/running/brocade-extension-ip-route/extension-ip-routeURIGET http://10.10.10.10/rest/running/brocade-extension-ip-route/extension-ip-route


<Response>


<name>0/2</name>

<dp-id>0</dp-id>



Broadcom




<status-flags>U G S </status-flags>



<name>0/2</name>

<dp-id>0</dp-id>



<ip-gateway>*</ip-gateway>

<status-flags>U C </status-flags>


</Response>

History




Broadcom


brocade-extension-ipsec-policyThis module is used to retrieve or configure the IP security (IPsec) policy on the specified switch. IPsec policy creationsupports creating a profile name using either a preshared format or a PKI format. The authentication-data attribute willcontain the preshared key for a preshared profile and a key pair for a PKI profile.

Module Tree

This is the tree view of the module from the brocade-extension-ipsec-policy.yang-tree.txt file. See YANG Module Overviewfor YANG node field definitions and possible values, and see Supported Data Types for data type descriptions.module: brocade-extension-ipsec-policy

+--rw brocade-extension-ipsec-policy

+--rw extension-ipsec-policy* [policy-name]

+--rw policy-name string

+--rw profile-name? extension-ipsec-profile-name

+--rw authentication-data? authentication-data

+--ro num-ike-sessions? uint16

+--rw restart-ike-sessions? uint8

URI Format


<base_URI>/running/brocade-extension-ipsec-policy/extension-ipsec-policy/ followed by the leafsas listed in the module tree to create, modify, or delete an IPsec policy.

Parametersbrocade-extension-ipsec-policy

Description: The container for this module.Flag: read-writeOptional: NoThis container has the following leafs:extension-ipsec-policy

Description: The IPsec policy defined on an extension blade or platform.Flag: read-writeOptional: NoKey: policy-nameThis list has the following leafs:policy-name

Description: Name of the extension IPSec policy being called.Flag: read-writeType: StringValues: From 1 to 31 alphanumeric characters. This is case-sensitive, and must not containkeywords such as “all” or “none” and cannot contain the following characters: ; $ ! # ` / \> < & ' " = , ? . * ^ { } ( ) .Optional: No

profile-nameDescription: Specifies the IPsec profile to use with the IPSec policy.Flag: read-writeType: extension-ipsec-profile-nameValues: preshared = Preshared key profile. pki = PKI key-pair profile. Default: presharedOptional: Yes


Broadcom


authentication-dataDescription: The authentication-data value depends on the profile used.Flag: read-writeType: authentication-dataValues:For a preshared profile, this is the preshared-key to be used for authentication. This operand isrequired for shared-key authentication profiles. A preshared key must be from 16 to 64 charactersin length.For a pki profile, this is the local key pair name to use for IKE authentication. This operand isrequired for PKI authentication profiles. A PKI key pair name must be from 1 to 32 characters inlength.Authentication data is returned as a zero-length string for read operations on policies with a“preshared” profile.Optional: Yes

num-ike-sessionsDescription: Number of Internet Key Exchange (IKE) sessions.Flag: read-onlyType: uint16Values: From 0 to 128. There is no default valueOptional: Yes

restart-ike-sessionsDescription: Control to restart all inactive IKE sessions for this policy.Flag: read-writeType: uint8Values: 1 = restart all inactive IKE sessions. 0 = do not restart all inactive IKE sessions. Default:0Optional: Yes

Supported Methods

Only the GET, POST, PATCH, DELETE, OPTIONS, and HEAD operations are supported in this module.

ExamplesCreating an IPsec Policy Using a Preshared ProfileThis example uses a POST request to create the IPsec policy “psk1” using a preshared profile.StructurePOST <base_URI>/running/brocade-extension-ipsec-policy/extension-ipsec-policyURIPOST https://10.10.10.10/rest/running/brocade-extension-ipsec-policy/extension-ipsec-policy

Request Body<extension-ipsec-policy>

<policy-name>psk1</policy-name>

<profile-name>preshared</profile-name>

<authentication-data>1234567891011121314</authentication-data>

</extension-ipsec-policy>


Broadcom


Response BodyWhen the operation is successful, the response has an empty message body and a “201 Created” status inthe headers.Creating an IPsec Policy Using a PKI ProfileThis example uses a POST request to create the IPsec policy “pki_1” using a PKI profile.StructurePOST <base_URI>/running/brocade-extension-ipsec-policy/extension-ipsec-policyURIPOST https://10.10.10.10/rest/running/brocade-extension-ipsec-policy/extension-ipsec-policy

Request Body<extension-ipsec-policy>

<policy-name>pki_1</policy-name>

<profile-name>pki</profile-name>

<authentication-data>pki-key-1</authentication-data>


Response BodyWhen the operation is successful, the response has an empty message body and a “201 Created” status inthe headers.Deleting an IPsec PolicyThe following example uses a DELETE request to delete the IPsec policy named “psk1”.StructureDELETE <base_URI>/running/brocade-extension-ipsec-policy/extension-ipsec-policy/policy-name/policy_nameURIDELETE https://10.10.10.10/rest/running/brocade-extension-ipsec-policy/extension-ipsec-policy/

policy-name/psk1

Request BodyThe request body is empty.Response BodyWhen the operation is successful, the response has an empty message body and a “204 No Content” statusmessage.Retrieving a List of IPsec PoliciesThe following example uses a GET request to retrieve all the IPsec policies on the switch.StructureGET <base_URI>/running/brocade-extension-ipsec-policy/extension-ipsec-policyURIGET https://10.10.10.10/rest/running/brocade-extension-ipsec-policy/extension-ipsec-policy



Broadcom


Response BodyWhen the operation is successful, the response has a message body similar to the following, and a “200 OK”status in the headers.<?xml version="1.0"?>

<Response>

<extension-ipsec-policy>

<policy-name>pki_policy</policy-name>

<profile-name>pki</profile-name>

<authentication-data>kprest</authentication-data>

<num-ike-sessions>0</num-ike-sessions>

<restart-ike-sessions>0</restart-ike-sessions>


<extension-ipsec-policy>

<policy-name>preshared_policy</policy-name>

<profile-name>preshared</profile-name>

<authentication-data/>

<num-ike-sessions>0</num-ike-sessions>

<restart-ike-sessions>0</restart-ike-sessions>


</Response>

History




Broadcom


brocade-extension-tunnelThis module is used to retrieve information on or configure Brocade Extension tunnels.

Module Tree

This is the tree view of the module from the brocade-extension-tunnel.yang-tree.txt file. See YANG ModuleOverview for YANG node field definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-extension-tunnel

+--rw brocade-extension-tunnel

+--rw extension-tunnel* [name] {fibrechannel:fibrechannel_extension_platform}?

| +--rw name extension:ve-interface-type

| +--rw user-friendly-name? union

| +--ro local-wwn? fibrechannel:wwn-type

| +--rw remote-wwn? fibrechannel:wwn-type

| +--ro peer-wwn? fibrechannel:wwn-type

| +--rw admin-enabled? uint8

| +--rw fast-write-enabled? uint8

| +--rw tape-read? uint8

| +--rw tape-write? uint8

| +--ro tunnel-status? extension:operational-type

| +--ro ipsec-enabled? uint8

| +--rw ipsec-policy? string

| +--ro ha-operational-status? uint16

| +--rw ficon? uint8

| +--rw ficon-xrc-acceleration? uint8

| +--rw ficon-tape-write-acceleration? uint8

| +--rw ficon-tape-read-acceleration? uint8

| +--rw ficon-tin-tir-emulation? uint8

| +--rw ficon-device-acknowledgement-emulation? uint8

| +--rw ficon-read-block-id-emulation? uint8

| +--rw ficon-teradata-read-acceleration? uint8

| +--rw ficon-teradata-write-acceleration? uint8

| +--rw ficon-tape-write-max-pipe? uint32

| +--rw ficon-tape-read-max-pipe? uint32

| +--rw ficon-tape-write-max-devices? uint32

| +--rw ficon-tape-read-max-devices? uint32

| +--rw ficon-tape-write-timer? uint32

| +--rw ficon-tape-write-max-chain? uint32

| +--rw ficon-oxid-base? uint32

| +--rw ip-extension? uint16

| +--rw load-level? extension:tunnel-load-level

| +--ro active-load-level? extension:tunnel-load-level

| +--ro peer-load-level? extension:tunnel-load-level

| +--rw compression-tunnel? uint16

| +--rw compression-protocol

| | +--rw fc-compression? string

| | +--rw ip-compression? string

| +--rw qos-ratio

| +--rw distribution? string

| +--rw distribution-value? string

| +--rw fc-high-qos? string


Broadcom


| +--rw fc-medium-qos? string

| +--rw fc-low-qos? string

| +--rw ip-high-qos? string

| +--rw ip-medium-qos? string

| +--rw ip-low-qos? string

+--ro extension-tunnel-statistics* [name]

| +--ro name extension:ve-interface-type

| +--ro flow-status? uint16

| +--ro operational-status? extension:operational-type

| +--ro connection-count? yang:zero-based-counter32

| +--ro duration? uint32

| +--ro uncompressed-bytes? yang:zero-based-counter64

| +--ro compressed-bytes? yang:zero-based-counter64

| +--ro local-hcl-in-progress? boolean

| +--ro remote-hcl-in-progress? boolean

| +--ro fc-ha-status? extension:operational-status-type

| +--ro ip-ha-status? extension:operational-status-type

| +--ro last-error? uint32

+--rw extension-circuit* [name circuit-id] {fibrechannel:fibrechannel_extension_platform}?

| +--rw name extension:ve-interface-type

| +--rw circuit-id uint16

| +--rw local-ip-address? inet:ip-address

| +--rw remote-ip-address? inet:ip-address

| +--rw metric? uint32

| +--rw failover-group-id? uint32

| x--rw admin-enabled? uint8

| +--rw is-admin-enabled? boolean

| +--ro admin-status? uint8

| +--ro path-mtu-discovered? uint32

| +--rw minimum-communication-rate? uint32

| +--rw maximum-communication-rate? uint32

| +--rw keep-alive-timeout? uint32

| +--ro vlan-id? uint32

| +--rw l2-cos

| | +--rw priority-control? string

| | +--rw fc-priority-high? string

| | +--rw fc-priority-medium? string

| | +--rw fc-priority-low? string

| | +--rw ip-priority-high? string

| | +--rw ip-priority-medium? string

| | +--rw ip-priority-low? string

| +--rw dscp

| | +--rw priority-control? string

| | +--rw fc-priority-high? string

| | +--rw fc-priority-medium? string

| | +--rw fc-priority-low? string

| | +--rw ip-priority-high? string

| | +--rw ip-priority-medium? string

| | +--rw ip-priority-low? string

| +--ro circuit-status? extension:operational-type

| +--rw local-ha-ip-address? inet:ip-address

| +--rw remote-ha-ip-address? inet:ip-address

| +--rw arl-algorithm-mode? uint32


Broadcom


+--ro extension-circuit-statistics* [name circuit-id] {fibrechannel:fibrechannel_extension_platform}?

| +--ro name extension:ve-interface-type

| +--ro circuit-id uint16

| +--ro flow-status? uint16




| +--ro out-packet-lost? yang:zero-based-counter64

| +--ro out-packet-total? yang:zero-based-counter64

+--ro circuit-qos-statistics* [ve-port circuit-id ha-type priority]

{fibrechannel:fibrechannel_extension_platform}?

| +--ro ve-port extension:ve-interface-type

| +--ro circuit-id uint16

| +--ro ha-type extension:tunnel-ha-type

| +--ro priority extension:extension-qos-type

| +--ro flow-status? boolean




| +--ro in-bytes? yang:zero-based-counter64

| +--ro in-bytes-average? yang:gauge64

| +--ro in-packets? yang:zero-based-counter64

| +--ro out-bytes? yang:zero-based-counter64

| +--ro out-bytes-average? yang:gauge64

| +--ro out-packets? yang:zero-based-counter64

| +--ro in-tcp-bytes? yang:zero-based-counter64

| +--ro out-tcp-bytes? yang:zero-based-counter64

| +--ro in-tcp-packets? yang:zero-based-counter64

| +--ro out-tcp-packets? yang:zero-based-counter64

| +--ro tcp-retransmits? yang:zero-based-counter64

| +--ro rtt? yang:zero-based-counter64

| +--ro tcp-out-of-order-packets? yang:zero-based-counter64

| +--ro tcp-slow-starts? yang:zero-based-counter64

+--ro wan-statistics* [ve-port circuit-id connection-id]

{fibrechannel:fibrechannel_extension_platform}?

+--ro ve-port extension:ve-interface-type

+--ro circuit-id uint16

+--ro connection-id uint32

+--ro priority? extension:extension-qos-type

+--ro ha-type? extension:tunnel-ha-type

+--ro source-port? inet:port-number

+--ro destination-port? inet:port-number

+--ro connection-mss? yang:zero-based-counter32

+--ro arl-minimum? yang:gauge32

+--ro arl-maximum? yang:gauge32

+--ro arl-current? yang:gauge32

+--ro arl-next-reset-algorithm? extension:arl-algo-type

+--ro out-bytes? yang:zero-based-counter64

+--ro out-packets? yang:zero-based-counter64

+--ro rtt? yang:gauge32

+--ro rtt-maximum? yang:gauge32

+--ro rtt-variance? yang:gauge32

+--ro rtt-variance-maximum? yang:gauge32


Broadcom


+--ro out-window-size? yang:gauge32

+--ro out-window-scale? uint32

+--ro slow-start-threshold? yang:gauge32

+--ro congestion-window? yang:gauge32

+--ro operation-mode? extension:tcp-operation-mode

+--ro out-queued-packets-next-sequence? yang:zero-based-counter32

+--ro out-queued-packets-minimum-sequence? yang:zero-based-counter32

+--ro out-queued-packets-maximum-sequence? yang:zero-based-counter32

+--ro out-in-flight-packets? yang:gauge32

+--ro out-unacknowledged-packets-sequence? yang:zero-based-counter32

+--ro retransmit-timeout? yang:zero-based-counter64

+--ro retransmits? yang:zero-based-counter64

+--ro maximum-retransmits? yang:zero-based-counter64

+--ro fast-retransmits? yang:zero-based-counter64

+--ro maximum-fast-retransmits? yang:zero-based-counter64

+--ro slow-retransmits? yang:zero-based-counter64

+--ro duplicate-acknowledgement? yang:zero-based-counter64

+--ro slow-starts? yang:zero-based-counter64

+--ro in-bytes? yang:zero-based-counter64

+--ro in-packets? yang:zero-based-counter64

+--ro in-window-size? yang:zero-based-counter32

+--ro in-window-size-maximum? yang:zero-based-counter32

+--ro in-window-scale? uint32

+--ro in-queued-packets? yang:gauge32

+--ro in-queued-packets-next-sequence? yang:zero-based-counter32

+--ro in-queued-packets-minimum-sequence? yang:zero-based-counter32

+--ro in-queued-packets-maximum-sequence? yang:zero-based-counter32

+--ro in-queued-out-of-order? yang:zero-based-counter32

+--ro in-queued-out-of-order-total? yang:zero-based-counter32

+--ro in-queued-out-of-order-maximum? yang:zero-based-counter32

URI Formats


• <base_URI>/running/brocade-extension-tunnel/extension-tunnel/ followed by the leafs as listed in themodule tree to create, modify, or delete an extension tunnel.

• <base_URI>/running/brocade-extension-tunnel/extension-circuit/ followed by the leafs as listed in themodule tree to create, modify, or delete a circuit on an extension tunnel.

• <base_URI>/running/brocade-extension-tunnel/extension-tunnel-statistics/ followed by the leafsas listed in the module tree to return the statistics for the extension tunnel.

• <base_URI>/running/brocade-extension-tunnel/extension-circuit-statistics/ followed by the leafsas listed in the module tree to return the statistics for the extension circuit.

• <base_URI>/running/brocade-extension-tunnel/circuit-qos-statistics/ followed by the leafs aslisted in the module tree to return the circuit QOS statistics for the extension circuit.

• <base_URI>/running/brocade-extension-tunnel/wan-statistics/ followed by the leafs as listed in themodule tree to return the WAN statistics for the extension tunnel.


Broadcom


Parametersbrocade-extension-tunnel

Description:The top-level module container. The switch must be an Extension switch.Flag: read-writeThis container has the following leafs.extension-tunnel

Description: The tunnel and circuit configuration and operational status for the named extension blade orsystem.Key: nameThis container has the following leafs.name

Description: The name of the interface.Flag: read-writeType: extension:ve-interface-typeValues: The slot and port number of the port in the format slot/port.Optional: No

user-friendly-nameDescription: Description of the specified tunnel.Flag: read-writeType: stringValues: 0 to 255 alphanumeric characters. This is case-sensitive, and must not contain specialcharacters (high-ASCII). Default: A zero-length string.Optional: Yes

local-wwnDescription: The WWN of the local Fibre Channel device.Flag: read-onlyType: fibrechannel:wwn-typeConfig: falseValues: Valid WWN (Colon-separated hexadecimal octets, most significant bit first, with leadingzeros.)Optional: Yes

remote-wwnDescription: A WWN that can be optionally configured to be verified against the WWN of theremote Fibre Channel entity.Flag: read-writeType: fibrechannel:wwn-typeValues: Valid WWN (Colon-separated hexadecimal octets, most significant bit first, with leadingzeros.)Optional: Yes

peer-wwnDescription: The WWN of the remote Fibre Channel device.Flag: read-onlyConfig: falseType: fibrechannel:wwn-typeValues: Valid WWN (Colon-separated hexadecimal octets, most significant bit first, with leadingzeros.)Optional: Yes

admin-enabledDescription: Enables or disables the tunnel VE port on the circuit.


Broadcom


Flag: read-writeType: uint8Values: 0 = Admin status disabled. 1 = Admin status enabled. Default: 1Optional: Yes

fast-write-enabledDescription: Enables or disables FCIP FastWrite on the specified extension tunnel.Flag: read-writeType: uint8Values: 0 = FCIP FastWrite disabled. 1 = FCIP FastWrite enabled. Default: 0Optional: Yes

tape-readDescription: Enables Read Tape Pipelining on the specified extension tunnel.To enable this, FCIP FastWrite must also be enabled. Read Tape Pipelining can not be enabled ifWrite Tape Pipelining is disabled.Flag: read-writeType: uint8Values: 0 = Read Tape Pipelining disabled. 1 = Read Tape Pipelining enabled. Default: 0Optional: Yes

tape-writeDescription: Enables Write Tape Pipelining on the specified extension tunnel.To enable this, FCIP FastWrite must also be enabled.Flag: read-writeType: uint8Values: 0 = Write Tape Pipelining disabled. 1 = Write Tape Pipelining enabled. Default: 0Optional: Yes

tunnel-statusDescription: Operational status of specified extension tunnel.Flag: read-onlyConfig: falseType: extension:operational-typeValues:0 = NULL. 1 = Offline. 2 = Online. 3 = Online Warning. 4 = Disabled. 5 = Degraded.6 = Initializing. 7 = Delete Pending. 8 = HA Online. 9 = HA Offline. 10 = HA Ready.11 = Empty. 12 = In Progress. 13 = Misconfiguration. 14 = Failover. 15 = Down Pending.16 = Circuit Disabled/Fenced/Testing. 17 = Internal Error. 18 = IPSec Error. 19 = Network Error.20 = Authentication Error. 21 = Timeout. 22 = TCP-Timeout. 23 = Remote Close Timeout.24 = Remote Close. 25 = Rejected. 26 = No Port. 27 = No Route. 28 = DP Offline.29 = HCL In progress. 30 = Internal Error. 31 = Configuration Incomplete. 32 = Circuit Fenced.33 = Child Delete Complete. 34 = Delete Failure. 35 = Spillover. 36 = Running. 37 = Testing.38 = Aborted. 39 = Passed. 40 = Failed.Optional: Yes

ipsec-enabledDescription: The Internet Protocol Security (IPsec) state of the specified extension tunnel.Flag: read-onlyType: uint8Config: falseValues: 0 = IPsec is disabled on the tunnel. 1 = IPsec is enabled on the tunnel. Default: 0Optional: Yes


Broadcom


ipsec-policyDescription: The name of the Internet Protocol Security (IPsec) policy to be used on thespecified extension tunnel.Flag: read-writeType: StringValues: 0 to 31 alphanumeric characters. Cannot contain any of the following characters ; $ !# ` / \ > < & ' " = , ? . * ^ { } ( ) . This value is not case-sensitive and must notcontain special characters (high-ASCII) or keywords such as all. Using none disables IPsec forthe tunnel. Default: A zero-length string.Optional: Yes

ha-operational-statusDescription: The High Availability (HA) status of the tunnel.Flag: read-onlyType: uint16Config: falseValues: 8 = HA Online. 9 = HA Offline. 10= HA ReadyOptional: Yes

ficonDescription: Enables or disables FICON emulation on the specified extension tunnel.Flag: read-writeType: uint8Values: 0 = FICON emulation disabled. 1 = FICON emulation enabled. Default: 0Optional: Yes

ficon-xrc-accelerationDescription: Enables or disables FICON XRC emulation.FICON XRC Emulation allows XRC (IBM eXtendedRemote Copy, also known as IBM z/OSGlobal Mirroring) to operate effectively at extended distances. This field is valid only if FICONemulation is enabled on the specified tunnel.Flag: read-writeType: uint8Values: 0 = FICON XRC emulation disabled. 1 = FICON XRC emulation enabled. Default: 0Optional: Yes

ficon-tape-write-accelerationDescription: Enables or disables FICON Tape Write Pipelining.This feature improves the performance of certain applications when writing to tape over extendeddistances. This field is valid only if FICON emulation is enabled on the specified tunnel.Flag: read-writeType: uint8Values: 0 = FICON Tape Write Pipelining disabled. 1 = FICON Tape Write Pipelining enabled.Default: 0Optional: Yes

ficon-tape-read-accelerationDescription: Enables or disables FICON Tape Read Pipelining.This feature improves performance for certain applications when reading from FICON tape overextended distances. This field is valid only if FICON emulation is enabled on the specified tunnel.Flag: read-writeType: uint8Values: 0 = FICON Tape Read Pipelining disabled. 1 = FICON Tape Read Pipelining enabled.Default: 0Optional: Yes


Broadcom


ficon-tin-tir-emulationDescription: Enables or disables FICON TIN/TIR emulation.This feature enhances recovery when a TIN/TIR exchange occurs as part of a channel recoveryoperation during tape emulation and is enabled by default (recommended setting). This field isvalid only if FICON emulation is enabled on the specified tunnel.Flag: read-writeType: uint8Values: 0 = FICON TIN/TIR emulation disabled. 1 = FICON TIN/TIR emulation enabled. Default:1Optional: Yes

ficon-device-acknowledgement-emulationDescription: Enables or disables FICON Device Level Acknowledgement emulation.This feature is applicable to both FICON Disk and Tape configurations. The feature removesone network round trip for exchanges that end with a Device Level Acknowledgment frame fromthe device, and is enabled by default (recommended setting). This field is valid only if FICONemulation is enabled on the specified tunnel.Flag: read-writeType: uint8Values: 0 = FICON Device Level Acknowledgement emulation disabled. 1 = FICON Device LevelAcknowledgement emulation enabled. Default: 1Optional: Yes

ficon-read-block-id-emulationDescription: Enables or disables FICON read Tape Read Block ID emulation.This feature permits FICON write channel programs containing embedded read block IDcommands (CCWs) with a byte count of exactly four bytes to be processed as emulatedcommands during write emulation processes. This field is valid only if FICON emulation isenabled on the specified tunnel.Flag: read-writeType: uint8Values: 0 = FICON Tape Read Block ID emulation disabled. 1 = FICON Tape Read Block IDemulation enabled. Default: 0Optional: Yes

ficon-teradata-read-accelerationDescription: Enables or disables FICON Read emulation for a Teradata server on the specifiedextension tunnel.This field is valid only if FICON emulation is enabled on the specified tunnel.Flag: read-writeType: uint8Values: 0 = FICON Read emulation for Teradata disabled. 1 = FICON Read emulation forTeradata enabled. Default: 0Optional: Yes

ficon-teradata-write-accelerationDescription: Enables or disables FICON Write emulation for a Teradata server on the specifiedextension tunnel.This field is valid only if FICON emulation is enabled on the specified tunnel.Flag: read-writeType: uint8Values: 0 = FICON Write emulation for Teradata disabled. 1 = FICON Write emulation forTeradata enabled. Default: 0Optional: Yes


Broadcom


ficon-tape-write-max-pipeDescription: Defines the maximum number of tape write channel commands (CCWs) that canenter the write pipeline for a single device whether all the CCWs are bundled in a single channelprogram or in multiple channel programs.This setting has significance only for host (channel) initiated operations at this side and willnot affect tape write operations initiated by hosts (channels) attached at the opposite side. Toosmall of a value will result in poor performance. The value should be chosen based upon thetypical tape channel program that requires optimum performance. This field is valid only if FICONemulation is enabled on the specified tunnel.Flag: read-writeType: uint32Values: 1 through 100. Default: 32 (Recommended setting)Optional: Yes

ficon-tape-read-max-pipeDescription: Defines the maximum number of tape read channel commands (CCWs) that canenter the read pipeline for a single device whether all the CCWs are bundled in a single channelprogram or in multiple channel programs.This setting has significance only for host (channel) initiated operations at this side and willnot affect tape write operations initiated by hosts (channels) attached at the opposite side. Toosmall of a value will result in poor performance. The value should be chosen based upon thetypical tape channel program that requires optimum performance. This field is valid only if FICONemulation is enabled on the specified tunnel.Flag: read-writeType: uint32Values: 1 through 100. Default: 32 (Recommended setting)Optional: Yes

ficon-tape-write-max-devicesDescription: Defines the maximum number of concurrent emulated tape write operations.As concurrency increases, the value of emulation decreases. Excessive concurrency hasthe potential to oversubscribe packet data memory. The setting has significance only for host(channel) initiated operations at this side and will not affect tape write operations initiated by hosts(channels) attached. This field is valid only if FICON emulation is enabled on the specified tunnel.Flag: read-writeType: uint32Values: 1 through 32. Default: 16 (Recommended setting)Optional: Yes

ficon-tape-read-max-devicesDescription: Defines the maximum number of concurrent emulated tape read operations.As concurrency increases, the value of emulation decreases. Excessive concurrency hasthe potential to oversubscribe packet data memory. The setting has significance only for host(channel) initiated operations at this side and will not affect tape read operations initiated by hosts(channels) attached at the opposite side. This field is valid only if FICON emulation is enabled onthe specified tunnel.Flag: read-writeType: uint32Values: 1 through 32. Default: 16 (Recommended setting)Optional: Yes

ficon-tape-write-timerDescription: The time limit for pipelined write chains.If a pipelined write chain takes longer than this value to complete, the ending status for the nextwrite chain will be withheld from the channel. This limits processing to what the network and


Broadcom


device can support. Too small a value limits pipelining performance. Too large a value results intoo much data being accepted for one device on a path. This field is valid only if FICON emulationis enabled on the specified tunnel.Flag: read-writeType: uint32Units: milliseconds (ms)Values: 100 through 1500. Default: 300Optional: Yes

ficon-tape-write-max-chainDescription: The maximum amount of data that can be contained in a single CCW (ChannelCommand Words) chain.If this value is exceeded, emulation is suspended. This field is valid only if FICON emulation isenabled on the specified tunnel.Flag: read-writeType: uint32Units: bytesValues: 1000000 through 5000000 (1 MB through 5 MB). Default: 3200000 (3.2 MB)Optional: Yes

ficon-oxid-baseDescription: Defines the base value of an entry pool of 256 0XIDs (Format 0 exchangeidentifications) supplied to emulation-generated exchanges.The base value specified should fall outside the range used by FICON channels and devices toavoid conflicts. This field is valid only if FICON emulation is enabled on the specified tunnel.Flag: read-writeType: uint32Values: One of the following values: 0, 4096, 8192, 12288, 16384, 20480, 24576, 28672, 32768,36864, 40960, 45056, 49152, or 53248. Default: 36864 (Recommended setting)Optional: Yes

ip-extensionDescription: Enables or disables the IP Extension capability of the specified tunnel.Flag: read-writeType: uint16Values: 0 = IP Extension capability disabled. 1 = IP Extension capability enabled. Default: 0Optional: Yes

load-levelDescription: Specifies spillover or failover load-balancing method for the specified tunnel. Thisprovides an orderly means to recover from circuit failures.Flag: read-writeType: extension:tunnel-load-levelValues: One of the following values:default = This uses the load-balancing method that is already specified on the switch.failover = This load-balancing method tries to retransmit any pending send traffic over the nextlowest metric circuit. Failover load balancing, in comparison to spillover, requires that all lowermetric circuits become unavailable before the higher metric circuits are used. (Default)spillover = This load-balancing method allows you to define circuits that are used only when thereis congestion or a period of high bandwidth utilization.Refer to the Brocade Fabric OS Extension User Guide for a more complete description of howload balancing is managed in Brocade Extension tunnels.Optional: Yes

active-load-levelDescription: Load level value currently active on the tunnel.


Broadcom


Flag: read-onlyType: extension:tunnel-load-levelConfig: falseValues:failover = This load-balancing method tries to retransmit any pending send traffic over the nextlowest metric circuit. Failover load balancing, in comparison to spillover, requires that all lowermetric circuits become unavailable before the higher metric circuits are used.spillover = This load-balancing method allows you to define circuits that are used only when thereis congestion or a period of high bandwidth utilization.Refer to the Brocade Fabric OS Extension User Guide for a more complete description of howload balancing is managed in Brocade Extension tunnels.Optional: Yes

peer-load-levelDescription: The load level configured on the peer-end of the tunnel.Flag: read-onlyType: extension:tunnel-load-levelConfig: falseValues:default = Use the load-balancing method that is already specified on the switch.failover = Trunking tries to retransmit any pending send traffic over the next lowest metric circuit.Failover load balancing, in comparison to spillover, requires that all lower metric circuits becomeunavailable before the higher metric circuits are used. (Default)spillover = This is a load-balancing method that allows you to define circuits that are used onlywhen there is congestion or a period of high bandwidth utilizationRefer to the Brocade Fabric OS Extension User Guide for a more complete description of howload balancing is managed in Brocade Extension tunnels.Optional: Yes

compression-tunnelDescription: Configures compression on the specified tunnel. Fast Deflate (5) is only supportedon the Brocade 7840 and the SX6 blade.Flag: read-writeType: uint16Values: 0 = Off (Compression disabled), 3 = Deflate, 4 = Aggressive Deflate, 5 = Fast Deflate.Default: 0Optional: Yes

compression-protocolThe FC/IP compression mode for the specified tunnel.This container has the following leafs.fc-compression

Description: The Fibre Channel compression level applied to the specified tunnel. FastDeflate (5) is only supported on the Brocade 7840 and the SX6 blade.Flag: read-writeType: stringValues: -1 = The default compression level specified in the compression-tunnel attribute,0 = Off (Compression disabled), 3 = Deflate, 4 = Aggressive Deflate, 5 = Fast Deflate.Default: -1Optional: Yes

ip-compressionDescription: The Internet Protocol compression level applied to the specified tunnel.Flag: read-writeType: string


Broadcom


Values: -1 = The default IP compression level specified in the compression-tunnelattribute, 0 = Off (Compression disabled), 3 = Deflate, 4 = Aggressive Deflate. Default: -1Note: If “default” is configured for either the Fibre Channel or IP compression protocolvalue, a GET request returns -1. If a user-configured value is defined, a GET requestreturns the configured value.Optional: Yes

qos-ratioDescription: The tunnel bandwidth distribution values to be applied. This container has thefollowing leafs.distribution

Description: The tunnel bandwidth distribution mode.Flag: read-writeType: stringValues: 1 = FCIP mode. 2 = Hybrid mode. Default: 1Optional: Yes

distribution-valueDescription: The value for bandwidth distribution.Flag: read-writeType: stringUnits: Percentage as an integer.Values: This is either blank for FCIP mode or FC_bandwidth,IP_bandwidth forHybrid mode. Each distribution value can be a minimum of 10%. The sum of bothpercentages must equal 100%.Optional: Yes

fc-high-qosDescription: The QoS percentage value for high priority FCIP traffic.Each priority can have a minimum of 10%. The sum of all three percentages must equal100%.Flag: read-writeType: stringUnits: Percentage as an integerValues: 10 through 80. Default: 50Optional: Yes

fc-medium-qosDescription: The QoS percentage value for medium priority FCIP traffic.Flag: read-writeType: stringUnits: Percentage as an integerValues: 10 through 80. Default: 30Optional: Yes

fc-low-qosDescription: The QoS percentage value for low priority FCIP traffic.Flag: read-writeType: stringUnits: Percentage as an integerValues: 10 through 80. Default: 20Optional: Yes

ip-high-qosDescription: The QoS percentage value for high priority IP Extension traffic.


Broadcom


Each priority can have a minimum of 10%. The sum of all three percentages must equal100%.Flag: read-writeType: stringUnits: Percentage as an integerValues: 10 through 80. Default: 50Optional: Yes

ip-medium-qosDescription: The QoS percentage value for medium priority IP Extension traffic.Flag: read-writeType: stringUnits: Percentage as an integerValues: 10 through 80. Default: 30Optional: Yes

ip-low-qosDescription: The QoS percentage value for low priority IP Extension traffic.Flag: read-writeType: stringUnits: Percentage as an integerValues: 10 through 80. Default: 20Optional: Yes

extension-tunnel-statisticsDescription: The tunnel statistics for the extension blade or system.Key: nameConfig: falseThis list has the following leafs.name

Description: The name of the interface.Flag: read-writeType: extension:ve-interface-typeValues: The slot and port number of the port in the format slot/port.Optional: No

flow-statusDescription: Flow control status.Flag: read-writeType: uint16Values: 0 = Flow control is off. 1 = Flow control is on. Default: 0Optional: Yes

operational-statusDescription: Operational status of tunnel.Flag: read-onlyType: extension:operational-typeValues:0 = NULL. 1 = Offline. 2 = Online. 3 = Online Warning. 4 = Disabled. 5 = Degraded.6 = Initializing. 7 = Delete Pending. 8 = HA Online. 9 = HA Offline. 10 = HA Ready.11 = Empty. 12 = In Progress. 13 = MisConfiguration. 14 = Failover. 15 = Down Pending.16 = Circuit Disabled/Fenced/Testing. 17 = Internal Error. 18 = IPsec Error. 19 = Network Error.20 = Authentication Error. 21 = Timeout. 22 = TCP-Timeout. 23 = Remote Close Timeout.24 = Remote Close. 25 = Rejected. 26 = No Port. 27 = No Route. 28 = DP Offline.29 = HCL In progress. 30 = Internal Error. 31 = Configuration Incomplete. 32 = Circuit Fenced.


Broadcom


33 = Child Delete Complete. 34 = Delete Failure. 35 = Spill Over. 36 = Running. 37 = Testing.38 = Aborted. 39 = Passed. 40 = Failed. There is no default value.Optional: Yes

connection-countDescription: The number of times the tunnel or circuit has transitioned to an online state. It startsat 0 at time of tunnel/circuit creation, or at a statistics reset, then increments by 1 every time thetunnel or circuit comes online.Flag: read-onlyType: yang:zero-based-counter32Values: 0 to 4294967295. There is no default.Optional: Yes

durationDescription: The length of time (in seconds) since the tunnel/circuit last transitioned to an onlinestate.Flag: read-onlyType: uint32Units: secondsValues: 0 to 4294967295. There is no defaultOptional: Yes

uncompressed-bytesDescription: The number of uncompressed bytes of data that have traversed the tunnel.Flag: read-onlyType: yang:zero-based-counter64Units: BytesValues: 0 through 18446744073709551615. Default: 0Optional: Yes

compressed-bytesDescription: The number of compressed bytes of data that have traversed the tunnel.Flag: read-onlyType: yang:zero-based-counter64Units: BytesValues: 0 through 18446744073709551615. Default: 0Optional: Yes

local-hcl-in-progressDescription: Whether local HCL is in progress.Flag: read-onlyType: booleanValues: true = Local HCL is in progress. false = Local HCL is not in progress.Optional: Yes

remote-hcl-in-progressDescription: Whether remote HCL is in progress.Flag: read-onlyType: booleanValues: true: Remote HCL in progress. false: Remote HCL in not in progress.Optional: Yes

fc-ha-statusDescription: The FC HA status of the Extension tunnel.Flag: read-onlyType: extension:operational-status-type


Broadcom


Values: 0 = NULL. 1 = Offline. 2 = Online. 3 = Online Warning. 4 = Disabled. 5 = Degraded. 6 =Initializing. 7 = Delete Pending. 8 = HA Online. 9 = HA Offline. 10 = HA Ready. 11 = Empty. 12= In Progress. 13 = Misconfiguration. 14 = Failover. 15 = Down Pending. 16 = Circuit Disabled/Fenced/Testing. 17 = Internal Error. 18 = IPSec Error. 19 = Network Error. 20 = AuthenticationError. 21 = Timeout. 22 = TCP-Timeout. 23 = Remote Close Timeout. 24 = Remote Close. 25= Rejected. 26 = No Port. 27 = No Route. 28 = DP Offline. 29 = HCL In progress. 30 = InternalError. 31 = Configuration Incomplete. 32 = Circuit Fenced. 33 = Child Delete Complete. 34 =Delete Failure. 35 = Spillover. 36 = Running. 37 = Testing. 38 = Aborted. 39 = Passed. 40 =Failed.Optional: Yes

ip-ha-statusDescription: The IP HA status of the Extension tunnel.Flag: read-onlyType: extension:operational-status-typeValues: 0 = NULL. 1 = Offline. 2 = Online. 3 = Online Warning. 4 = Disabled. 5 = Degraded. 6 =Initializing. 7 = Delete Pending. 8 = HA Online. 9 = HA Offline. 10 = HA Ready. 11 = Empty. 12= In Progress. 13 = Misconfiguration. 14 = Failover. 15 = Down Pending. 16 = Circuit Disabled/Fenced/Testing. 17 = Internal Error. 18 = IPSec Error. 19 = Network Error. 20 = AuthenticationError. 21 = Timeout. 22 = TCP-Timeout. 23 = Remote Close Timeout. 24 = Remote Close. 25= Rejected. 26 = No Port. 27 = No Route. 28 = DP Offline. 29 = HCL In progress. 30 = InternalError. 31 = Configuration Incomplete. 32 = Circuit Fenced. 33 = Child Delete Complete. 34 =Delete Failure. 35 = Spillover. 36 = Running. 37 = Testing. 38 = Aborted. 39 = Passed. 40 =Failed.Optional: Yes

last-errorDescription: The last error encountered during HCL for an extension tunnel. The error is clearedas part of the VE recovery sequence after HCL processing is complete. This parameter displaysonly when there is an error; otherwise, this parameter does not display in the GET response.Flag: read-onlyType: uint32Values: The last tunnel error seen.Optional: Yes

extension-circuitDescription: The circuit interface for the extension blade or system. The switch must be an Extensionswitch.Key: name plus circuit-id. Both must be included to identify a specific circuit interface.This list has the following leafs:name

Description: The name of the extension tunnel interface.Flag: read-writeType: extension:ve-interface-typeValues: The slot and port number of the port in the format slot/port.Optional: No

circuit-idDescription: Circuit ID for the specified extension circuit.Flag: read-writeType: uint16Values: 0 through 9. Default: 0. For the Brocade 7810, the values are 0 through 5.Optional: No


Broadcom


local-ip-addressDescription: The local IP address to use for the circuit.Flag: read-writeType: inet:ip-addressValues: An address in valid IPv4 or IPv6 format.Optional: Yes

remote-ip-addressDescription: The remote IP address to use for the circuit.Flag: read-writeType: inet:ip-addressValues: An address in valid IPv4 or IPv6 format.Optional: Yes

metricDescription: The metric for the configured circuit.A lower metric assigns a higher priority to the circuit. As data is flowing through the extensiontunnel, it automatically traverses the lowest metric cost circuits. For example, if a tunnel hasfour circuits, three of which are set to a metric of 0 and one is set to a metric of 1, all data willflow over the metric 0 circuits. This parameter is meaningful only if you configure more than onecircuit.Flag: read-writeType: uint32Values: 0 = Primary. 1 = Failover. Default: 0Optional: Yes

failover-group-idDescription: The failover group ID for the configured circuit.The circuit failover groups must be defined at both ends of the extension tunnel and each failovergroup should include at least one metric 0 and one metric 1 circuit. If all metric 0 circuits in thefailover group go down, the transmission fails over to the metric 1 circuits in the group. If all metric0 circuits in a tunnel go down, by default the traffic will run over the metric 1 circuits. This field hasno meaning when load level for the tunnel is ‘spillover’.Flag: read-writeType: uint32Values: A value in the range from 0 to 9. Default group ID: 0Optional: Yes

admin-enabledDescription: The parameter is deprecated. Use the is-admin-enabled leaf to configure and theadmin-status leaf to obtain the current status of the circuit. Enables or disables the circuit.Flag: read-writeType: uint8Values: 0 = Circuit disabled on the tunnel. 1 = Circuit enabled on the tunnel. Default: 1 Thefollowing values are internal read-only states which may display in a GET request: 2 = Circuit is inconfiguration mode. 3 = Circuit is HA-disabled. 4 = Circuit is fenced. 5 = Circuit is in test.Optional: Yes

is-admin-enabledDescription: Enables or disables the circuit.Flag: read-writeType: booleanValues: true = Circuit enabled on the tunnel. false = Circuit disabled on the tunnel.Optional: Yes


Broadcom


admin-statusDescription: The status of the circuit.Flag: read-onlyType: uint8Values: 0 = Circuit disabled on the tunnel. 1 = Circuit enabled on the tunnel. 2 = Circuit is inconfiguration mode. 3 = Circuit is HA-disabled. 4 = Circuit is fenced. 5 = Circuit is in test.Optional: Yes

path-mtu-discoveredDescription: Discovered Path MTU value.This field is valid only when Path MTU discovery is enabled. The min and max values arerestricted by mtu-size of the interface.Flag: read-onlyType: uint32Config: falseValues: 1280 to 9216 or 0 if not used. Default: 0Optional: Yes

minimum-communication-rateDescription: Minimum communication rate of the tunnel.You can set a minimum and a maximum for the committed rate to configure the tunnel forAdaptive Rate Limiting (ARL), which allows for a more effective sharing of bandwidth betweenapplications. The maximum committed rate can be no larger than five times the minimumcommitted rate, and both sides of the circuit must have matching configurations.Flag: read-writeType: uint32Units: kbpsValues: 20000 through 10000000. Default: 0. The value is 0 when the rate is not yet configured.For the Brocade 7810, the range is restricted to 0 (not configured) or 20000 through 2500000.Optional: Yes

maximum-communication-rateDescription: Maximum communication rate of the tunnel.You can set a minimum and a maximum for the committed rate to configure the tunnel forAdaptive Rate Limiting (ARL), which allows for a more effective sharing of bandwidth betweenapplications. The maximum committed rate can be no larger than five times the minimumcommitted rate, and both sides of the circuit must have matching configurations.Flag: read-writeType: uint32Units: kbpsValues: 20000 through 10000000. Default: 0. This must be a larger value than minimum-communication-rate, and the value is 0 when the rate is not yet configured. For the Brocade7810, the range is restricted to 0 (not configured) or 20000 through 2500000.Optional: Yes

keep-alive-timeoutDescription: The keep alive timeout.Flag: read-writeType: uint32Units: milliseconds (ms)Values: 500 through 7200000If the tunnel does not already have FICON Emulation enabled, circuits created on the tunneldefault to a keep-alive timeout of 6000 ms (6 seconds). If FICON emulation is enabled on theextension tunnel when a circuit is created, the keep-alive timeout defaults to 1000 ms (1 second).Optional: Yes


Broadcom


vlan-idDescription: Specifies the VLAN ID.Flag: read-writeType: uint32Config: falseValues: 0 through 4095. Default: 0. When not set, this value will register as 0.Optional: Yes

l2-cosDescription: L2 class of service or priority as defined by IEEE 802.1p for the tunnel.This container has the following leafs.priority-control

Description: The Layer 2 Class of Service (L2CoS) value for F-Class Traffic.This priority setting controls connections between switches.Flag: read-writeType: stringValues: 0 through 7. Default: 0Optional: Yes

fc-priority-highDescription: The L2 CoS value for Fibre Channel high priority traffic.Flag: read-writeType: stringValues: 0 through 7. Default: 0Optional: Yes

fc-priority-mediumDescription: The L2 CoS value for Fibre Channel medium priority traffic.Flag: read-writeType: stringValues: 0 through 7. Default: 0Optional: Yes

fc-priority-lowDescription: The L2 CoS value for Fibre Channel low priority traffic.Flag: read-writeType: stringValues: 0 through 7. Default: 0Optional: Yes

ip-priority-highDescription: The L2 CoS value for Internet Protocol high priority traffic.Flag: read-writeType: stringValues: 0 through 7. Default: 0Optional: Yes

ip-priority-mediumDescription: The L2 CoS value for Internet Protocol medium priority traffic.Flag: read-writeType: stringValues: 0 through 7. Default: 0Optional: Yes

ip-priority-lowDescription: The L2 CoS value for Internet Protocol low priority traffic.


Broadcom


Flag: read-writeType: stringValues: 0 through 7. Default: 0Optional: Yes

dscpDescription: The Internet Protocol (IP) Differentiated Services Code Point (DSCP) markings forframes.Config: falseThis container has the following leafs:priority-control

Description: The DSCP value for F-class traffic.Flag: read-writeType: stringValues: 0 through 63. Default: 0Optional: Yes

fc-priority-highDescription: The DSCP value for Fibre Channel high priority traffic.Flag: read-writeType: stringValues: 0 through 63. Default: 0Optional: Yes

fc-priority-mediumDescription: The DSCP value for Fibre Channel medium priority traffic.Flag: read-writeType: stringValues: 0 through 63. Default: 0Optional: Yes

fc-priority-lowDescription: The DSCP value for Fibre Channel low priority traffic.Flag: read-writeType: stringValues: 0 through 63. Default: 0Optional: Yes

ip-priority-highDescription: The DSCP value for Internet Protocol high priority traffic.Flag: read-writeType: stringValues: 0 through 63. Default: 0Optional: Yes

ip-priority-mediumDescription: The DSCP value for Internet Protocol medium priority traffic.Flag: read-writeType: stringValues: 0 through 63. Default: 0Optional: Yes

ip-priority-lowDescription: The DSCP value for Internet Protocol low priority traffic.Flag: read-writeType: string


Broadcom


Values: 0 through 63. Default: 0Optional: Yes

circuit-statusDescription: Operational status of the circuit.Flag: read-onlyType: operational-typeConfig: falseValues:0 = NULL, 1 = Offline, 2 = Online, 3 = Online Warning, 4 = Disabled, 5 = Degraded, 6 = Initializing,7 = Delete Pending, 8 = HA Online, 9 = HA Offline, 10 = HA Ready, 11 = Empty, 12 = In Progress,13 = Misconfiguration, 14 = Failover, 15 = Down Pending, 16 = Circuit Disabled/Fenced/Testing,17 = Internal Error, 18 = IPsec Error, 19 = Network Error, 20 = Authentication Error, 21 = Timeout,22 = TCP-Timeout, 23 = Remote Close Timeout, 24 = Remote Close, 25 = Rejected, 26 = No Port,27 = No Route, 28 = DP Offline, 29 = HCL In progress, 30 = Internal Error, 31 = Configuration Incomplete,32 = Circuit Fenced, 33 = Child Delete Complete, 34 = Delete Failure, 35 = Spill Over, 36 = Running,37 = Testing, 38 = Aborted, 39 = Passed, 40 = Failed. There is no default value.

local-ha-ip-addressDescription: The local High Availability IP address to use for the circuit. This HA configuration is onlysupported on Brocade 7840 and SX6.Flag: read-writeType: inet:ip-addressValues: Valid IPV4 or IPv6 addressOptional: Yes

remote-ha-ip-addressDescription: The remote High Availability IP address to use for the circuit.Flag: read-writeType: inet:ip-addressValues: Valid IPV4 or IPv6 addressOptional: Yes

arl-algorithm-modeDescription: The adaptive rate limiting (ARL) algorithm in use.Flag: read-writeType: inet:ip-addressValues: 0 = auto, 1 = reset, 2 = step-down, 3 = timed-step-down. Default: 0Optional: Yes

extension-circuit-statisticsDescription: Represents circuit statistics for extension blade or system. The switch must be an Extensionswitch.Key: name plus circuit-id. Both must be included to identify a specific circuit.Config: falseThis list has the following leafs:name

Description: The name of the interface.Flag: read-onlyType: extension:ve-interface-typeValues: The slot and port number of the port in the format slot/port.Optional: No

circuit-idDescription: Circuit identifier.Flag: read-only


Broadcom


Type: uint16Values: 0 through 9. Default: 0. For the Brocade 7810, the values are 0 through 5.Optional: No

flow-statusDescription: Flow control status of circuit.Flag: read-onlyType: uint16Values: 0 = Flow control is off. 1 = Flow control is on. Default: 0Optional: Yes

operational-statusDescription: Operational status of circuit.Flag: read-onlyType: extension:operational-type0 = NULL, 1 = Offline, 2 = Online, 3 = Online Warning, 4 = Disabled, 5 = Degraded,6 = Initializing, 7 = Delete Pending, 8 = HA Online, 9 = HA Offline, 10 = HA Ready,11 = Empty, 12 = In Progress, 13 = MisConfiguration, 14 = Failover, 15 = Down Pending,16 = Circuit Disabled/Fenced/Testing, 17 = Internal Error, 18 = IPsec Error, 19 = Network Error,20 = Authentication Error, 21 = Timeout, 22 = TCP-Timeout, 23 = Remote Close Timeout,24 = Remote Close, 25 = Rejected. 26 = No Port, 27 = No Route, 28 = DP Offline,29 = HCL In progress, 30 = Internal Error, 31 = Configuration Incomplete, 32 = Circuit Fenced,33 = Child Delete Complete, 34 = Delete Failure, 35 = Spill Over, 36 = Running, 37 = Testing,38 = Aborted, 39 = Passed, 40 = Failed. There is no default value.Optional: Yes

connection-countDescription: Active connection count on circuit.Flag: read-onlyType: yang:zero-based-counter32Values: 0 through 4294967295. Default: 0Optional: Yes

durationDescription: Duration of time that the circuit has been in an online state.Flag: read-onlyType: uint32Units: secondsValues: 0 through 4294967295. Default: 0Optional: Yes

out-packet-lostDescription: The number of TCP packets lost because of delay or drop in the Network.Flag: read-onlyConfig: falseType: yang:zero-based-counter64Units: tcp packetsValues: 0 through 18446744073709551615.Optional: Yes

out-packet-totalDescription: The number of total TCP packets sent out in the Network.Flag: read-onlyConfig: falseType: yang:zero-based-counter64Units: tcp packets


Broadcom


Values: 0 through 18446744073709551615.Optional: Yes

circuit-qos-statisticsDescription: The circuit statistics for Extension blade or switch. The switch must be an Extension switch.Flag: read-onlyFlag: ve-port plus circuit-id plus ha-type priorityOptional: NoThis list has the following leafs:ve-port

Description: The name of the Extension tunnel interface.Flag: read-onlyType: extension:ve-interface-typeValues: The slot and port number of the port in the format slot/port.Optional: No

circuit-idDescription: The circuit identifier.Flag: read-onlyType: uint16Values: 0 through 9. Default: 0. For the Brocade 7810, the values are 0 through 5.Optional: No

ha-typeDescription: The tunnel group HA type configuration.Flag: read-onlyType: extension:tunnel-ha-typeValues: main = The primary tunnel of the Extension tunnel configured between the local source-ip-address and the destination remote-ip-address of the circuit[s]. The main tunnel is used tocarry traffic over the WAN in standard operating conditions. The traffic may failover to either the'local-backup' or 'remote-backup' during the window when HCL is in progress. The failover trafficon either of 'local-backup' and 'remote-backup' and subsequent failback is determined by whichswitch is under HCL (local or remote). local-backup = The backup for the main tunnel for the localHCL and uses the local-ha-ip-address and remote-ip-address of the circuit as the endpoint. Notethat the local-ha-ip-address and local-ip-address must be configured on different DP's. This isto make sure that the traffic can sequentially failover to the other DP during the HCL sequence.The 'local-backup' tunnel is viewed as the 'remote-backup' tunnel on the remote switch becauseof symmetric configuration. remote-backup = The backup for the main tunnel for the remote HCLand uses the source-ip-address and remote-ha-ip-address of the circuit as the endpoint. Notethat the remote-ip-address and remote-ha-ip-address must be configured on different DP's onthe remote switch. This is to make sure that the traffic can sequentially failover to the other DPof remote switch during the HCL sequence. The 'remote-backup' tunnel is viewed as the 'local-backup' tunnel on the remote switch because of symmetric configuration.Optional: No

priorityDescription: The QoS priority value for the tunnel.Flag: read-onlyType: extension:extension-qos-typeValues: priority-control = The logical or virtual segregation of an Extension tunnel to providespecific QoS for control messaging and communication, including F-CLass traffic. This is alsoknown as a control tunnel and is common for both FC/IP protocols in case of hybrid tunnels. Thecontrol tunnel is a higher priority QoS and has no guaranteed minimum bandwidth. As needed, itcan use all available bandwidth up to the maximum configured bandwidth rate although this trafficutilizes very little bandwidth. fc-qos-type (FC-priory-high, FC-priory-medium, or FC-priory-low) =


Broadcom


The logical or virtual segregation of an extension tunnel to provide high, medium, or low priorityQoS for FC data traffic. This WAN optimized TCP traffic class is via per priority TCP QoS. ip-qos-type (IP-priory-high, IP-priory-medium, or IP-priory-low) = The logical or virtual segregation of anextension tunnel to provide high, medium, or low priority QoS for IP LAN data traffic. This WANoptimized TCP traffic class is via per priority TCP QoS. This is present only when the tunnel is ahybrid tunnel.Optional:No

flow-statusDescription: The flow control status.Flag: read-onlyType: booleanValues: false = The flow control is off. true = The flow control is on.Optional:No

operational-statusDescription:Flag: read-onlyType: extension:operational-typeValues: 0 = NULL. 1 = Offline. 2 = Online. 3 = Online Warning. 4 = Disabled. 5 = Degraded. 6 =Initializing. 7 = Delete Pending. 8 = HA Online. 9 = HA Offline. 10 = HA Ready. 11 = Empty. 12= In Progress. 13 = Misconfiguration. 14 = Failover. 15 = Down Pending. 16 = Circuit Disabled/Fenced/Testing. 17 = Internal Error. 18 = IPSec Error. 19 = Network Error. 20 = AuthenticationError. 21 = Timeout. 22 = TCP-Timeout. 23 = Remote Close Timeout. 24 = Remote Close. 25= Rejected. 26 = No Port. 27 = No Route. 28 = DP Offline. 29 = HCL In progress. 30 = InternalError. 31 = Configuration Incomplete. 32 = Circuit Fenced. 33 = Child Delete Complete. 34 =Delete Failure. 35 = Spillover. 36 = Running. 37 = Testing. 38 = Aborted. 39 = Passed. 40 =Failed.Optional:No

connection-countDescription: The active connection count.Flag: read-onlyType: yang:zero-based-counter32Values: The active connection count.Optional:No

durationDescription: The connection duration (in seconds).Flag: read-onlyType: uint32Values: The connection duration (in seconds).Optional:No

in-bytesDescription: The total number of octets received.Flag: read-onlyType: yang:zero-based-counter64Values: The total number of octets received.Optional:No

in-bytes-averageDescription: The average of the total number of octets received per 30 seconds.Flag: read-onlyType: yang:gauge64Values: The average of the total number of octets received per 30 seconds.


Broadcom


Optional:Noin-packets

Description: The total number of packets received.Flag: read-onlyType: yang:zero-based-counter64Values: The total number of packets received.Optional:No

out-bytesDescription: The total number of octets sent.Flag: read-onlyType: yang:zero-based-counter64Values: The total number of octets sent.Optional:No

out-bytes-averageDescription: The average of the total number of octets send per 30 seconds.Flag: read-onlyType: yang:gauge64Values: The average of the total number of octets send per 30 seconds.Optional:No

out-packetsDescription: The total number of TCP packets sent.Flag: read-onlyType: yang:zero-based-counter64Values: The total number of TCP packets sent.Optional:No

in-tcp-bytesDescription: The total number of TCP bytes received.Flag: read-onlyType: yang:zero-based-counter64Values: The total number of TCP bytes received.Optional:No

ro out-tcp-bytesDescription: The total number of TCP bytes sent.Flag: read-onlyType: yang:zero-based-counter64Values: The total number of TCP bytes sent.Optional:No

in-tcp-packetsDescription: The number of TCP packets received.Flag: read-onlyType: yang:zero-based-counter64Values: The number of TCP packets received.Optional:No

out-tcp-packetsDescription: The number of TCP packets sent.Flag: read-onlyType: yang:zero-based-counter64Values: The number of TCP packets sent.Optional:No


Broadcom


tcp-retransmitsDescription: The number of TCP retransmits or lost packets.Flag: read-onlyType: yang:zero-based-counter64Values: The number of TCP retransmits or lost packets.Optional:No

rttDescription: The round trip time.Flag: read-onlyType: yang:zero-based-counter64Values: The round trip time.Optional:No

tcp-out-of-order-packetsDescription: The total number of TCP out of order packets.Flag: read-onlyType: yang:zero-based-counter64Values: The total number of TCP out of order packets.Optional:No

tcp-slow-startsDescription: The number of TCP slow starts.Flag: read-onlyType: yang:zero-based-counter64Values: The number of TCP slow starts.Optional:No

wan-statisticsDescription: The TCP WAN statistics for an Extension blade or system. The switch must be anExtension switch.Flag: read-onlyKey: ve-port plus circuit-id plus connection-idOptional:This list has the following leafs:ve-port

Description: The name of the interface.Flag: read-onlyType: extension:ve-interface-typeValues: The name of the interface.Optional:No

circuit-idDescription: The circuit identifier.Flag: read-onlyType: uint16Values: 0 to 9.Optional:No

connection-idDescription: The TCP connection identifier associated with the WAN TCP connection. The TCPconnection identifier may change when a connection goes down or establishes. These are notpersistent identifiers associated with the connection.Flag: read-onlyType: uint32Values: The TCP connection identifier associated with the WAN TCP connection.


Broadcom


Optional:Nopriority

Description: The QoS priority value for the tunnel.Flag: read-onlyType: extension:extension-qos-typeValues: priority-control = The logical or virtual segregation of an Extension tunnel to providespecific QoS for control messaging and communication, including F-CLass traffic. This is alsoknown as a control tunnel and is common for both FC/IP protocols in case of hybrid tunnels. Thecontrol tunnel is a higher priority QoS and has no guaranteed minimum bandwidth. As needed, itcan use all available bandwidth up to the maximum configured bandwidth rate although this trafficutilizes very little bandwidth. fc-qos-type (FC-priory-high, FC-priory-medium, or FC-priory-low) =The logical or virtual segregation of an extension tunnel to provide high, medium, or low priorityQoS for FC data traffic. This WAN optimized TCP traffic class is via per priority TCP QoS. ip-qos-type (IP-priory-high, IP-priory-medium, or IP-priory-low) = The logical or virtual segregation of anextension tunnel to provide high, medium, or low priority QoS for IP LAN data traffic. This WANoptimized TCP traffic class is via per priority TCP QoS. This is present only when the tunnel is ahybrid tunnel.Optional:No

ha-typeDescription: The HA type configuration for the Extenstion tunnel.Flag: read-onlyType: extension:tunnel-ha-typeValues: main = The primary tunnel of the Extension tunnel configured between the localsourceip-address and the destination remote-ip-address of the circuit[s]. The main tunnel is usedto carry traffic over the WAN in standard operating conditions. The traffic may failover to eitherthe 'local-backup' or 'remote-backup' during the window when HCL is in progress. The failovertraffic on either of 'local-backup' and 'remote-backup' and subsequent failback is determinedby which switch is under HCL (local or remote). local-backup = The backup for the main tunnelfor the local HCL and uses the local-ha-ip-address and remote-ip-address of the circuit as theendpoint. Note that the local-ha-ip-address and local-ip-address must be configured on differentDP's. This is to make sure that the traffic can sequentially failover to the other DP during theHCL sequence. The 'local-backup' tunnel is viewed as the 'remote-backup' tunnel on the remoteswitch because of symmetric configuration. remote-backup = The backup for the main tunnelfor the remote HCL and uses the source-ip-address and remote-ha-ip-address of the circuit asthe endpoint. Note that the remote-ip-address and remote-ha-ip-address must be configured ondifferent DP's on the remote switch. This is to make sure that the traffic can sequentially failoverto the other DP of remote switch during the HCL sequence. The 'remote-backup' tunnel is viewedas the 'localbackup' tunnel on the remote switch because of symmetric configuration.Optional:No

source-portDescription: The TCP source port number.Flag: read-onlyType: inet:port-numberValues: The TCP source port number.Optional:No

destination-portDescription: The TCP remote destination port number.Flag: read-onlyType: inet:port-numberValues: The TCP remote destination port number.Optional:No


Broadcom


connection-mssDescription: The TCP connection maximum segment size (MSS).Flag: read-onlyType: yang:zero-based-counter32Values: The TCP connection MSS.Optional:No

arl-minimumDescription: The minimum Adaptive Rate Limiting (ARL) value.Flag: read-onlyType: yang:gauge32Values: The minimum ARL value.Optional:No

arl-maximumDescription: The maximum ARL value.Flag: read-onlyType: yang:gauge32Values: The maximum ARL value.Optional:No

arl-currentDescription: The current ARL value.Flag: read-onlyType: yang:gauge32Values: The current ARL value.Optional:No

arl-next-reset-algorithmDescription: The ARL next reset algorithm.Flag: read-onlyType: extension:arl-algo-typeValues: auto = Selects the 'static-reset', 'step-down', or 'timed-step-down' algorithm. This is usedonly in configuration. static-reset = When congestion is detected at the current bandwidth, thisalgorithm resets to the minimum configured bandwidth for the circuit and restarts the climb towardmaximum bandwidth. step-down = When RTT is less than 200ms, this algorithm reduces theconfigured bandwidth . timed-step-down = When RTT is greater than or equal to 200ms, thisalgorithm reduces rate.Optional:No

out-bytesDescription: The total number of bytes sent.Flag: read-onlyType: yang:zero-based-counter64Values: The total number of bytes sent.Optional:No

out-packetsDescription: The total number of TCP packets sent.Flag: read-onlyType: yang:zero-based-counter64Values: The total number of TCP packets sent.Optional:No

rttDescription: The round trip time in milliseconds.Flag: read-only


Broadcom


Type: yang:gauge32Values: The round trip time in milliseconds.Optional:No

rtt-maximumDescription: The maximum round trip time.Flag: read-onlyType: yang:gauge32Values: The maximum round trip time.Optional:No

rtt-varianceDescription: The variance in the round trip time.Flag: read-onlyType: yang:gauge32Values: The variance in the round trip time.Optional:No

rtt-variance-maximumDescription: The maximum variance in the round trip time.Flag: read-onlyType: yang:gauge32Values: The maximum variance in the round trip time.Optional:No

out-window-sizeDescription: The source window size.Flag: read-onlyType: yang:gauge32Values: The source window size.Optional:No

out-window-scaleDescription: The source window scaling shift count.Flag: read-onlyType: uint32Values: 0 to 14.Optional:No

slow-start-thresholdDescription: The source slow start threshold.Flag: read-onlyType: yang:gauge32Values: The source slow start threshold.Optional:No

congestion-windowDescription: The maximum data that can be sent before an acknowledgement is received.Flag: read-onlyType: yang:gauge32Values: The maximum data that can be sent before an acknowledgement is received.Optional:No

operation-modeDescription: The TCP operation mode algorithm used for connection.Flag: read-onlyType: extension:tcp-operation-mode


Broadcom


Values: slow-start = The TCP connection is operating in slow-starts. congestion-avoidance = TheTCP connection is in congestion avoidance algorithm. fast-retransmits = The TCP connection isin fast-retransmits. fast-recovery = The TCP connection is in fast-recovery. Refer RFC 2001 formore details.Optional:No

out-queued-packets-next-sequenceDescription: The source TCP queued packets next sequence number.Flag: read-onlyType: yang:zero-based-counter32Values: The source TCP queued packets next sequence number.Optional:No

out-queued-packets-minimum-sequenceDescription: The source TCP queued packets minimum sequence number.Flag: read-onlyType: yang:zero-based-counter32Values: The source TCP queued packets minimum sequence number.Optional:No

out-queued-packets-maximum-sequenceDescription: The source TCP queued packets maximum sequence number.Flag: read-onlyType: yang:zero-based-counter32Values: The source TCP queued packets maximum sequence number.Optional:No

out-in-flight-packetsDescription: The source in flight packets.Flag: read-onlyType: yang:gauge32Values: The source in flight packets.Optional:No

out-unacknowledged-packets-sequenceDescription: The source unacknowledged packets sequence.Flag: read-onlyType: yang:zero-based-counter32Values: The source unacknowledged packets sequence.Optional:No

retransmit-timeoutDescription: The TCP retransmits timeout.Flag: read-onlyType: yang:zero-based-counter64Values: The TCP retransmits timeout.Optional:No

retransmitsDescription: The number of TCP retransmits.Flag: read-onlyType: yang:zero-based-counter64Values: The number of TCP retransmits.Optional:No

maximum-retransmitsDescription: The number of TCP maximum retransmits.


Broadcom


Flag: read-onlyType: yang:zero-based-counter64Values: The number of TCP maximum retransmits.Optional:No

fast-retransmitsDescription: The number of TCP fast retransmits.Flag: read-onlyType: yang:zero-based-counter64Values: The number of TCP fast retransmits.Optional:No

maximum-fast-retransmitsDescription: The maximum number of TCP fast retransmits.Flag: read-onlyType: yang:zero-based-counter64Values: The maximum number of TCP fast retransmits.Optional:No

slow-retransmitsDescription: The number of TCP slow retransmits.Flag: read-onlyType: yang:zero-based-counter64Values: The number of TCP slow retransmits.Optional:No

duplicate-acknowledgementDescription: The number of TCP duplicate acknowledgements received.Flag: read-onlyType: yang:zero-based-counter64Values: The number of TCP duplicate acknowledgements received.Optional:No

slow-startsDescription: The number of TCP slow starts.Flag: read-onlyType: yang:zero-based-counter64Values: The number of TCP slow starts.Optional:No

in-bytesDescription: The total number of bytes received.Flag: read-onlyType: yang:zero-based-counter64Values: The total number of bytes received.Optional:No

in-packetsDescription: The total number of TCP packets received.Flag: read-onlyType: yang:zero-based-counter64Values: The total number of TCP packets received.Optional:No

in-window-sizeDescription: The receiver window size.Flag: read-only


Broadcom


Type: yang:zero-based-counter32Values: The receiver window size.Optional:No

in-window-size-maximumDescription: The receiver maximum window size.Flag: read-onlyType: yang:zero-based-counter32Values: The receiver maximum window size.Optional:No

in-window-scaleDescription: The receiver negotiated window scale.Flag: read-onlyType: uint32Values: 0 to 14.Optional:No

in-queued-packetsDescription: The number of TCP queued packets received.Flag: read-onlyType: yang:gauge32Values: The number of TCP queued packets received.Optional:No

in-queued-packets-next-sequenceDescription: The TCP queued packets next sequence number received.Flag: read-onlyType: yang:zero-based-counter32Values: The TCP queued packets next sequence number received.Optional:No

in-queued-packets-minimum-sequenceDescription: The TCP queued packets minimum sequence number received.Flag: read-onlyType: yang:zero-based-counter32Values: The TCP queued packets minimum sequence number received.Optional:No

in-queued-packets-maximum-sequenceDescription: The TCP queued packets maximum sequence number received.Flag: read-onlyType: yang:zero-based-counter32Values: The TCP queued packets maximum sequence number received.Optional:No

in-queued-out-of-orderDescription: The number of TCP queued out of order packets received.Flag: read-onlyType: yang:zero-based-counter32Values: The number of TCP queued out of order packets received.Optional:No

in-queued-out-of-order-totalDescription: The total number of TCP out of order packets received.Flag: read-onlyType: yang:zero-based-counter32


Broadcom


Values: The total number of TCP out of order packets received.Optional:No

in-queued-out-of-order-maximumDescription: The total number of TCP out of order packets received.Flag: read-onlyType: yang:zero-based-counter32Values: The total number of TCP out of order packets received.Optional:No

Supported Methods

The following table lists the supported and unsupported methods for this module.

Table 22: Supported and unsupported methods

URI Supported Methods Unsupported Methods

<base_URI>/running/brocade-extension-tunnel/extension-tunnel GET, POST, PATCH, DELETE,OPTIONS, and HEAD

<base_URI>/running/brocade-extension-tunnel/extension-tunnel-statistics

GET, OPTIONS, and HEAD POST, PATCH, andDELETE

<base_URI>/running/brocade-extension-tunnel/extension-circuit GET, POST, PATCH, DELETE,OPTIONS, and HEAD

<base_URI>/running/brocade-extension-tunnel/extension-circuit-statistics

GET, OPTIONS, and HEAD POST, PATCH, andDELETE

Examples

NOTEThe examples presented here illustrate only the key parameters required to create a tunnel or circuit. Multipleattributes can be provided in the data body of the request to set the values along with the key parameters.

Creating a TunnelThis example uses a POST request to create a tunnel on port 4/17.StructurePOST <base_URI>/running/brocade-extension-tunnel/extension-tunnelURIPOST https://10.10.10.10/rest/running/brocade-extension-tunnel/extension-tunnel

Request BodyNotice that the slash character in the name resource is not encoded as “%2f”. This is because it is in therequest body.<extension-tunnel>

<name>4/17</name>

</extension-tunnel>

Response BodyWhen the operation is successful, the response contains an empty message body and a "201 Created" statusin the headers.


Broadcom


Creating a Circuit on a TunnelThis example uses a POST request to create circuit 0 on tunnel 4/17.StructurePOST <base_URI>/running/brocade-extension-tunnel/extension-circuitURIPOST https://10.10.10.10/rest/running/brocade-extension-tunnel/extension-circuit

Request body<extension-circuit>

<name>4/17</name>

<circuit-id>0</circuit-id>

</extension-circuit>

Response BodyWhen the operation is successful, the response contains an empty message body and a "201 Created" statusin the headers.Deleting a TunnelThis example uses a DELETE request to delete the tunnel and circuit running on port 4/17.StructureDELETE <base_URI>/running/brocade-extension-tunnel/extension-tunnel/name/4%2f17URIDELETE https://10.10.10.10/rest/running/brocade-extension-tunnel/extension-tunnel/name/4%2f17

Request BodyNo request body is required.Response BodyWhen the operation is successful, the response contains an empty message body and a "204 No Content"status in the headers.List all the Tunnels on a SwitchThis example uses a GET request to retrieve the list of all tunnels available on the switch without retrievingtunnel statistics, circuits, or circuit statistics.StructureGET <base_URI>/running/brocade-extension-tunnel/extension-tunnelURIGET https://10.10.10.10/rest/running/brocade-extension-tunnel/extension-tunnel


<Response>

<extension-tunnel>


Broadcom


<name>8/16</name>

<user-friendly-name/>

<local-wwn>10:00:c1:f1:1c:1a:1:b4</local-wwn>

<remote-wwn>00:00:00:00:00:00:00:00</remote-wwn>

<peer-wwn>10:00:c1:f1:1c:cd:c0:c0</peer-wwn>

<compression-tunnel>0</compression-tunnel>

<admin-enabled>1</admin-enabled>

<fast-write-enabled>0</fast-write-enabled>

<tape-read>0</tape-read>

<tape-write>0</tape-write>

<tunnel-status>5</tunnel-status>

<ipsec-enabled>1</ipsec-enabled>

<ipsec-policy>myPolicy1</ipsec-policy>

<ha-operational-status>8</ha-operational-status>

<ficon>1</ficon>

<ficon-xrc-acceleration>0</ficon-xrc-acceleration>

<ficon-tape-write-acceleration>0</ficon-tape-write-acceleration>

<ficon-tape-read-acceleration>0</ficon-tape-read-acceleration>

<ficon-tin-tir-emulation>1</ficon-tin-tir-emulation>

<ficon-device-acknowledgement-emulation>1</ficon-device-acknowledgement-emulation>

<ficon-read-block-id-emulation>0</ficon-read-block-id-emulation>

<ficon-teradata-read-acceleration>0</ficon-teradata-read-acceleration>

<ficon-teradata-write-acceleration>0</ficon-teradata-write-acceleration>

<ficon-tape-write-max-pipe>32</ficon-tape-write-max-pipe>

<ficon-tape-read-max-pipe>32</ficon-tape-read-max-pipe>

<ficon-tape-write-max-devices>16</ficon-tape-write-max-devices>

<ficon-tape-read-max-devices>16</ficon-tape-read-max-devices>

<ficon-tape-write-timer>300</ficon-tape-write-timer>

<ficon-tape-write-max-chain>3200000</ficon-tape-write-max-chain>

<ficon-oxid-base>36864</ficon-oxid-base>

<ip-extension>1</ip-extension>

<qos-ratio>

<distribution>2</distribution>

<distribution-value>50,50</distribution-value>

<fc-high-qos>50</fc-high-qos>

<fc-medium-qos>30</fc-medium-qos>

<fc-low-qos>20</fc-low-qos>

<ip-high-qos>50</ip-high-qos>

<ip-medium-qos>30</ip-medium-qos>

<ip-low-qos>20</ip-low-qos>

</qos-ratio>

<compression-protocol>

<fc-compression>-1</fc-compression>

<ip-compression>-1</ip-compression>

</compression-protocol>

<load-level>failover</load-level>

<active-load-level>failover</active-load-level>

<peer-load-level>failover</peer-load-level>

</extension-tunnel>

<extension-tunnel>

<name>8/17</name>

<user-friendly-name/>

<local-wwn>10:00:c1:f1:1c:1a:b1:b4</local-wwn>


Broadcom


<remote-wwn>00:00:00:00:00:00:00:00</remote-wwn>

<peer-wwn>10:00:18:14:11:13:c1:74</peer-wwn>

<compression-tunnel>0</compression-tunnel>


<fast-write-enabled>0</fast-write-enabled>

<tape-read>0</tape-read>

<tape-write>0</tape-write>

<tunnel-status>3</tunnel-status>

<ipsec-enabled>1</ipsec-enabled>

<ipsec-policy>myPolicy1</ipsec-policy>

<ha-operational-status>9</ha-operational-status>

<ficon>1</ficon>

<ficon-xrc-acceleration>0</ficon-xrc-acceleration>

<ficon-tape-write-acceleration>0</ficon-tape-write-acceleration>

<ficon-tape-read-acceleration>0</ficon-tape-read-acceleration>

<ficon-tin-tir-emulation>1</ficon-tin-tir-emulation>

<ficon-device-acknowledgement-emulation>1</ficon-device-acknowledgement-emulation>

<ficon-read-block-id-emulation>0</ficon-read-block-id-emulation>

<ficon-teradata-read-acceleration>0</ficon-teradata-read-acceleration>

<ficon-teradata-write-acceleration>0</ficon-teradata-write-acceleration>

<ficon-tape-write-max-pipe>32</ficon-tape-write-max-pipe>

<ficon-tape-read-max-pipe>32</ficon-tape-read-max-pipe>

<ficon-tape-write-max-devices>16</ficon-tape-write-max-devices>

<ficon-tape-read-max-devices>16</ficon-tape-read-max-devices>

<ficon-tape-write-timer>300</ficon-tape-write-timer>

<ficon-tape-write-max-chain>3200000</ficon-tape-write-max-chain>

<ficon-oxid-base>36864</ficon-oxid-base>

<ip-extension>1</ip-extension>

<qos-ratio>

<distribution>2</distribution>

<distribution-value>50,50</distribution-value>

<fc-high-qos>50</fc-high-qos>

<fc-medium-qos>30</fc-medium-qos>

<fc-low-qos>20</fc-low-qos>

<ip-high-qos>50</ip-high-qos>

<ip-medium-qos>30</ip-medium-qos>

<ip-low-qos>20</ip-low-qos>

</qos-ratio>

<compression-protocol>

<fc-compression>-1</fc-compression>

<ip-compression>-1</ip-compression>

</compression-protocol>

<load-level>failover</load-level>

<active-load-level>failover</active-load-level>

<peer-load-level>failover</peer-load-level>

</extension-tunnel>

</Response>

Getting a List of Tunnel StatisticsThis example uses a GET request to retrieve a list of extension tunnel statistics.StructureGET <base_URI>/running/brocade-extension-tunnel/extension-tunnel-statistics


Broadcom


URIGET https://10.10.10.10/rest/running/brocade-extension-tunnel/extension-tunnel-statistics


<Response>

<extension-tunnel-statistics>

<name>8/16</name>

<flow-status>0</flow-status>


<connection-count>1</connection-count>

<duration>4367</duration>

<uncompressed-bytes>0</uncompressed-bytes>

<compressed-bytes>0</compressed-bytes>

<local-hcl-in-progress>false</local-hcl-in-progress>

<remote-hcl-in-progress>false</remote-hcl-in-progress>

<fc-ha-status>HA-online</fc-ha-status>

<ip-ha-status>HA-online</ip-ha-status>

</extension-tunnel-statistics>

<extension-tunnel-statistics>

<name>8/17</name>





<uncompressed-bytes>0</uncompressed-bytes>

<compressed-bytes>0</compressed-bytes>

<local-hcl-in-progress>false</local-hcl-in-progress>

<remote-hcl-in-progress>false</remote-hcl-in-progress>

<fc-ha-status>HA-offline</fc-ha-status>

<ip-ha-status>HA-offline</ip-ha-status>

</extension-tunnel-statistics>

</Response>

Getting a List of Extension CircuitsThis example uses a GET request to retrieve a list of extension circuits.StructureGET <base_URI>/running/brocade-extension-tunnel/extension-circuitURIGET https://10.10.10.10/rest/running/brocade-extension-tunnel/extension-circuit



Broadcom


Response BodyWhen the operation is successful, the response has a message body similar to the following, and a “200 OK”status in the headers.<?xml version="1.0"?>

<Response>

<extension-circuit>

<name>8/16</name>


<local-ip-address>11.11.10.1</local-ip-address>

<remote-ip-address>11.11.10.11</remote-ip-address>

<metric>0</metric>


<is-admin-enabled>true</is-admin-enabled>

<admin-status>1</admin-status>

<path-mtu-discovered>0</path-mtu-discovered>

<minimum-communication-rate>200000</minimum-communication-rate>

<maximum-communication-rate>500000</maximum-communication-rate>

<keep-alive-timeout>1000</keep-alive-timeout>


<l2-cos>

<priority-control>0</priority-control>

<fc-priority-high>0</fc-priority-high>

<fc-priority-medium>0</fc-priority-medium>

<fc-priority-low>0</fc-priority-low>

<ip-priority-high>0</ip-priority-high>

<ip-priority-medium>0</ip-priority-medium>

<ip-priority-low>0</ip-priority-low>

</l2-cos>

<dscp>








</dscp>

<failover-group-id>0</failover-group-id>

<circuit-status>2</circuit-status>

<local-ha-ip-address>192.168.20.101</local-ha-ip-address>

<remote-ha-ip-address>192.168.20.111</remote-ha-ip-address>

<arl-algorithm-mode>1</arl-algorithm-mode>


...

<extension-circuit>

<name>8/17</name>




<metric>1</metric>


<is-admin-enabled>true</is-admin-enabled>


Broadcom


<admin-status>1</admin-status>

<path-mtu-discovered>0</path-mtu-discovered>



<keep-alive-timeout>1000</keep-alive-timeout>


<l2-cos>








</l2-cos>

<dscp>








</dscp>

<failover-group-id>0</failover-group-id>

<circuit-status>12</circuit-status>

<local-ha-ip-address>0.0.0.0</local-ha-ip-address>

<remote-ha-ip-address>0.0.0.0</remote-ha-ip-address>

<arl-algorithm-mode>1</arl-algorithm-mode>


</Response>

Getting a List of Extension Circuit StatisticsThis example uses a GET request to retrieve a list of extension circuit statistics.StructureGET <base_URI>/running/brocade-extension-tunnel/extension-circuit-statisticsURIGET https://10.10.10.10/rest/running/brocade-extension-tunnel/extension-circuit-statistics


<Response>

<extension-circuit-statistics>

<name>8/16</name>




Broadcom





<out-packet-total>926418</out-packet-total>

<out-packet-lost>0</out-packet-lost>

</extension-circuit-statistics>

...


<name>8/17</name>









</Response>

Viewing a List of Circuit QoS Statistics

This example uses a GET request to retrieve a list of circuit QoS statistics.

Structure

GET base_URI/running/brocade-extension-tunnel/circuit-qos-statistics

URI

GET https://10.10.10.10/rest/running/brocade-extension-tunnel/circuit-qos-statistics

Request Body


Response Body


<Response>

<circuit-qos-statistics>



<ha-type>main</ha-type>

<priority>priority-control</priority>



<flow-status>false</flow-status>


<in-bytes>1474356</in-bytes>


<in-packets>4230</in-packets>

<out-bytes>1231008</out-bytes>


<out-packets>4158</out-packets>




Broadcom





<rtt>1</rtt>


<tcp-slow-starts>0</tcp-slow-starts>

</circuit-qos-statistics>

...

<circuit-qos-statistics>




<priority>IP-priority-low</priority>



<flow-status>true</flow-status>













<rtt>0</rtt>


<tcp-slow-starts>0</tcp-slow-starts>

</circuit-qos-statistics>

</Response>

Viewing a List of WAN Statistics

This example uses a GET request to retrieve a list of WAN statistics.

Structure

GET base_URI/running/brocade-extension-tunnel/wan-statistics

URI

GET https://10.10.10.10/rest/running/brocade-extension-tunnel/wan-statistics

Request Body


Response Body


<Response>


Broadcom


<wan-statistics>



<connection-id>42538446</connection-id>

<priority>IP-priority-medium</priority>

<ha-type>local-backup</ha-type>



<connection-mss>1460</connection-mss>

<arl-minimum>250000</arl-minimum>

<arl-maximum>625000</arl-maximum>

<arl-current>250000</arl-current>

<arl-next-reset-algorithm>step-down</arl-next-reset-algorithm>



<rtt>0</rtt>

<rtt-maximum>0</rtt-maximum>

<rtt-variance>0</rtt-variance>

<rtt-variance-maximum>0</rtt-variance-maximum>

<out-window-size>15624192</out-window-size>

<out-window-scale>9</out-window-scale>

<slow-start-threshold>16777216</slow-start-threshold>

<congestion-window>1460</congestion-window>

<operation-mode>slow-start</operation-mode>

<out-queued-packets-next-sequence>3886119460</out-queued-packets-next-sequence>

<out-queued-packets-minimum-sequence>3886119380</out-queued-packets-minimum-sequence>

<out-queued-packets-maximum-sequence>3886119460</out-queued-packets-maximum-sequence>

<out-in-flight-packets>0</out-in-flight-packets>

<out-unacknowledged-packets-sequence>80</out-unacknowledged-packets-sequence>

<retransmit-timeout>400</retransmit-timeout>

<retransmits>11</retransmits>

<maximum-retransmits>11</maximum-retransmits>


<maximum-fast-retransmits>0</maximum-fast-retransmits>



<slow-starts>1</slow-starts>



<in-window-size>15624704</in-window-size>

<in-window-size-maximum>15624704</in-window-size-maximum>

<in-window-scale>9</in-window-scale>

<in-queued-packets>0</in-queued-packets>

<in-queued-packets-next-sequence>220073876</in-queued-packets-next-sequence>

<in-queued-packets-minimum-sequence>220073876</in-queued-packets-minimum-sequence>

<in-queued-packets-maximum-sequence>235698580</in-queued-packets-maximum-sequence>

<in-queued-out-of-order>0</in-queued-out-of-order>

<in-queued-out-of-order-total>0</in-queued-out-of-order-total>

<in-queued-out-of-order-maximum>0</in-queued-out-of-order-maximum>

</wan-statistics>

...

<wan-statistics>



Broadcom



<connection-id>42539249</connection-id>

<priority>FC-priority-low</priority>




<connection-mss>1460</connection-mss>

<arl-minimum>50000</arl-minimum>

<arl-maximum>625000</arl-maximum>

<arl-current>50000</arl-current>

<arl-next-reset-algorithm>step-down</arl-next-reset-algorithm>



<rtt>0</rtt>

<rtt-maximum>0</rtt-maximum>

<rtt-variance>0</rtt-variance>

<rtt-variance-maximum>0</rtt-variance-maximum>

<out-window-size>15624192</out-window-size>

<out-window-scale>9</out-window-scale>

<slow-start-threshold>16777216</slow-start-threshold>

<congestion-window>1460</congestion-window>

<operation-mode>slow-start</operation-mode>

<out-queued-packets-next-sequence>1399545204</out-queued-packets-next-sequence>

<out-queued-packets-minimum-sequence>1399545124</out-queued-packets-minimum-sequence>

<out-queued-packets-maximum-sequence>1399545204</out-queued-packets-maximum-sequence>

<out-in-flight-packets>0</out-in-flight-packets>

<out-unacknowledged-packets-sequence>80</out-unacknowledged-packets-sequence>

<retransmit-timeout>400</retransmit-timeout>

<retransmits>15</retransmits>

<maximum-retransmits>15</maximum-retransmits>


<maximum-fast-retransmits>0</maximum-fast-retransmits>



<slow-starts>1</slow-starts>



<in-window-size>15624704</in-window-size>

<in-window-size-maximum>15624704</in-window-size-maximum>

<in-window-scale>9</in-window-scale>

<in-queued-packets>0</in-queued-packets>

<in-queued-packets-next-sequence>221155678</in-queued-packets-next-sequence>

<in-queued-packets-minimum-sequence>221155678</in-queued-packets-minimum-sequence>

<in-queued-packets-maximum-sequence>236780382</in-queued-packets-maximum-sequence>

<in-queued-out-of-order>0</in-queued-out-of-order>

<in-queued-out-of-order-total>0</in-queued-out-of-order-total>

<in-queued-out-of-order-maximum>0</in-queued-out-of-order-maximum>

</wan-statistics>

</Response>


Broadcom


History



Fabric OS 8.2.1 This API call was modified to add the out-packet-total and out-packet-lost leafs to theextension-circuit-statistics list. It was also modified to add Brocade 7810 and/or SX6 bladespecific changes to the remote-ha-ip-address, compression-tunnel, compression-protocol,circuit-id, minimum-communication-rate, and maximum-communication-rate parameters.

Fabric OS 9.0.0 This API call was modified to add the local-hcl-in-progress, remote-hcl-in-progress, fc-ha-status, ip-ha-status, and last-error to the extension-tunnel-statistics list. This API call wasalso modified to add the circuit-qos-statistics and wan-statistics lists

Fabric OS 9.0.1 This API call was modified to edit the distribution-value parameter.


Broadcom


brocade-interface/extension-ip-interfaceThe extension IP interface parameters in this module are used to retrieve or configure IP interfaces on the specifiedswitch.

NOTEThe brocade-fibrechannel, brocade-extension-ip-interface, and brocade-gigabitethernet modules have beenmerged into the brocade-interface module in Fabric OS 8.2.1b or later. However, this section only coversbrocade-extension-ip-interface. For information about brocade-fibrechannel, refer to brocade-interface/fibrechannel. For information about brocade-gigabitethernet, refer to brocade-interface/gigabitethernet.

Module Tree

This is the tree view of the module from the brocade-extension-ip-interface.yang-tree.txt file. See YANG Module Overviewfor YANG node field definitions and possible values, and see Supported Data Types for data type descriptions.

module: brocade-interface



| +--rw name string









| +--rw g-port-locked? uint8 {fibrechannel:fibrechannel_switch_platform}?





| +--ro neighbor





| +--ro port-type? brocade-interface-types:port-type-type


| +--rw compression-configured? uint8

| +--ro compression-active? uint8













Broadcom















| +--rw rate-limit-enabled? int16 {fibrechannel:fibrechannel_switch_platform}?

| +--rw non-dfe-enabled? uint8 {fibrechannel:fibrechannel_switch_platform}?




| +--ro pod-license-status? boolean


| +--rw name string


































Broadcom






























| +--ro bb-credit? yang:zero-based-counter64

| +--ro peer-bb-credit? yang:zero-based-counter64

+--rw extension-ip-interface* [name ip-address dp-id]

| +--rw name brocade-interface-types:ge-interface-type

| +--rw ip-address inet:ip-address

| +--rw dp-id uint16

| +--rw ip-prefix-length brocade-interface-types:ip-prefix-length

| +--rw mtu-size? uint16

| +--rw vlan-id? uint16

| +--ro status-flags? string

+--rw gigabitethernet* [name]


| +--rw enabled-state? uint8

| +--rw speed? brocade-interface-types:speed-type

| +--ro mac-address? yang:mac-address



+--rw gigabitethernet-statistics* [name]

+--rw name brocade-interface-types:ge-interface-type

+--ro out-pkts? yang:zero-based-counter64

+--ro out-octets? yang:zero-based-counter64

+--ro out-unicast-pkts? yang:zero-based-counter64

+--ro out-multicast-pkts? yang:zero-based-counter64

+--ro out-broadcast-pkts? yang:zero-based-counter64

+--ro out-vlan-pkts? yang:zero-based-counter64


Broadcom


+--ro out-pause-pkts? yang:zero-based-counter64

+--ro in-pkts? yang:zero-based-counter64

+--ro in-octets? yang:zero-based-counter64

+--ro in-unicast-pkts? yang:zero-based-counter64

+--ro in-multicast-pkts? yang:zero-based-counter64

+--ro in-broadcast-pkts? yang:zero-based-counter64

+--ro in-vlan-pkts? yang:zero-based-counter64

+--ro in-pause-pkts? yang:zero-based-counter64

+--ro carrier-loss-error? yang:zero-based-counter64

+--ro crc-error? yang:zero-based-counter64

+--ro jabber-error? yang:zero-based-counter64

+--rw reset-statistics? uint8

+--ro time-generated? fibrechannel:time-generated-type

URI Format

The URI for this module takes the following form:

<base_URI>/running/brocade-interface/extension-ip-interface/ followed by the leafs as listed in themodule tree.


Description: The module container.Flag: read-writeThis container has the following leafs.extension-ip-interface

Description: The IP interface defined on the extension blade or system.Flag: read-writeKey: name plus ip-address plus dp-id. All must be included to identify a specific interface.This list has the following leafs.name

Description: The name of the interface.Flag: read-writeType: ge-interface-typeValues: The slot and port number of the port, shown as “slot/port”.Optional: No

ip-addressDescription: The source IPv4 or IPv6 address of the interface.Flag: read-writeType: inet:ip-addressValues: A properly-formatted IPv4 or IPv6 address.Optional: No

dp-idDescription: Extension Data Path Processor ID associated with the IP interface.Flag: read-writeType: uint16Values: 0 or 1. Default: NoneOptional: No


Broadcom


ip-prefix-lengthDescription: The prefix length operator for the IP address. Once set, the prefix length can not bechanged.Flag: read-writeType: ip-prefix-lengthValues: 1 through 31 for IPv4, or 1 through 128 for IPv6. Default: NoneMandatory: This is true only when creating a new interface instance; that is, in a POSToperation, and is optional in other operations such as GET, DELETE, or PATCH.Units: BitsOptional: Yes

mtu-sizeDescription: The maximum transmission unit (MTU) size.Flag: read-writeType: uint16Units: BytesValues: 1 or a value from 1280 through 9216. Default: 1500The special value of 1 is equivalent to ‘auto’ mode to enable PMTU discovery. The discoveredvalue of MTU in ‘auto’ mode can be found as a circuit attribute.Optional: Yes

vlan-idDescription: The VLAN ID.Flag: read-writeType: uint16Values: 0 through 4095. Default: 0Optional: Yes

status-flagsDescription: The IP interface status flags.Flag: read-onlyConfig: falseType: stringValues: B = Broadcast; D = Debug; I = InUse; L = Loopback; LU = LinkUp; M = Multicast;N = NoArp; P = Point2Point; PR = Promiscuous; R = Running; S = StaticArp; U = Up.Optional: Yes

Supported Methods


ExamplesCreating an IP InterfaceThis example uses a POST request to create an IP interface on port 4/5 with a MTU of 1500 and a VLAN ID of100.StructurePOST <base_URI>/running/brocade-interface/extension-ip-interfaceURIPOST http://10.10.10.40/rest/running/brocade-interface/extension-ip-interface


Broadcom


Request BodyNotice that the slash character in the name resource is not encoded as “%2f”. This is because it is in therequest body.


<name>4/5</name>

<dp-id>0</dp-id>


<mtu-size>1500</mtu-size>



Response BodyWhen the resource is successfully created, the response contains an empty message body and a “204 NoContent” status in the headers.Deleting an IP InterfaceThis example uses a DELETE request to delete the IP interface on port 4/5.StructureDELETE <base_URI>/running/brocade-interface/extension-ip-interfaceURIDELETE http://10.10.10.10/rest/running/brocade-interface/extension-ip-interface

Request Body


<name>4/5</name>

<dp-id>0</dp-id>




Response BodyWhen the resource is successfully deleted, the response contains an empty message body and a “204 NoContent” status in the headers.Retrieving Information on an IP InterfaceThe following example uses a GET request to retrieve information on the IP interface on port 0/2.StructureGET <base_URI>/running/brocade-interface/extension-ip-interfaceURIGET https://10.10.10.10/rest/running/brocade-interface/extension-ip-interface/name/0%2f2/dp-id/0/

ip-address/192.168.20.1/



Broadcom



<Response>


<name>0/2</name>

<dp-id>0</dp-id>





<status-flags>U R M I </status-flags>


</Response>

History




Broadcom


brocade-interface/gigabitethernetThe Gigabit Ethernet parameters in this module allow you to retrieve or configure both Gigabit Ethernet interfaces andGigabit Ethernet interface statistics.

NOTEThe brocade-fibrechannel, brocade-extension-ip-interface, and brocade-gigabitethernet modules have beenmerged into the brocade-interface module in Fabric OS 8.2.1b and later. However, this section only coversbrocade-gigabitethernet. For information about brocade-fibrechannel, see brocade-interface/fibrechannel. Forinformation about brocade-extension-ip-interface, see brocade-interface/extension-ip-interface.

Module Tree

This is the tree view of the module from the brocade-gigabitethernet.yang-tree.txt file. See YANG ModuleOverview for YANG node field definitions and possible values, and see Supported Data Types for data type descriptions.




| +--rw name string









| +--rw g-port-locked? uint8 {fibrechannel:fibrechannel_switch_platform}?





| +--ro neighbor





| +--ro port-type? brocade-interface-types:port-type-type


| +--rw compression-configured? uint8

| +--ro compression-active? uint8













Broadcom















| +--rw rate-limit-enabled? int16 {fibrechannel:fibrechannel_switch_platform}?

| +--rw non-dfe-enabled? uint8 {fibrechannel:fibrechannel_switch_platform}?




| +--ro pod-license-status? boolean


| +--rw name string


































Broadcom






























| +--ro bb-credit? yang:zero-based-counter64

| +--ro peer-bb-credit? yang:zero-based-counter64

+--rw extension-ip-interface* [name ip-address dp-id]


| +--rw ip-address inet:ip-address

| +--rw dp-id uint16

| +--rw ip-prefix-length brocade-interface-types:ip-prefix-length

| +--rw mtu-size? uint16

| +--rw vlan-id? uint16

| +--ro status-flags? string

+--rw gigabitethernet* [name]


| +--rw enabled-state? uint8

| +--rw speed? brocade-interface-types:speed-type

| +--ro mac-address? yang:mac-address



+--rw gigabitethernet-statistics* [name]

+--rw name brocade-interface-types:ge-interface-type

+--ro out-pkts? yang:zero-based-counter64

+--ro out-octets? yang:zero-based-counter64

+--ro out-unicast-pkts? yang:zero-based-counter64

+--ro out-multicast-pkts? yang:zero-based-counter64

+--ro out-broadcast-pkts? yang:zero-based-counter64

+--ro out-vlan-pkts? yang:zero-based-counter64


Broadcom


+--ro out-pause-pkts? yang:zero-based-counter64

+--ro in-pkts? yang:zero-based-counter64

+--ro in-octets? yang:zero-based-counter64

+--ro in-unicast-pkts? yang:zero-based-counter64

+--ro in-multicast-pkts? yang:zero-based-counter64

+--ro in-broadcast-pkts? yang:zero-based-counter64

+--ro in-vlan-pkts? yang:zero-based-counter64

+--ro in-pause-pkts? yang:zero-based-counter64

+--ro carrier-loss-error? yang:zero-based-counter64

+--ro crc-error? yang:zero-based-counter64

+--ro jabber-error? yang:zero-based-counter64

+--rw reset-statistics? uint8

+--ro time-generated? fibrechannel:time-generated-type

URI Format

The URI for this module takes one of the following forms:

• <base_URI>/running/brocade-interface/gigabitethernet/ to return a list of all the Gigabit Ethernet portson the switch.

• <base_URI>/running/brocade-interface/gigabitethernet-statistics/ to return the statistics for all theGigabit Ethernet ports on the switch.


Description: The container for this module.Flag: read-writeThis container has the following leafs.gigabitethernet

Description: The list of Gigabit Ethernet interfaces on the device.System-controlled interfaces created by the system are always present in this list, whether they areconfigured or not.Flag: read-writeKey: nameThis list has the following leafs.name


enabled-stateDescription: The state of the interface.Flag: read-writeType: uint8Values: 1 = Enabled. 2 = Disabled. Default: 1Optional: Yes

speedDescription: For physical layer device types that may operate at various speeds, this leaf allowsthe interface to be forced to operate at a particular speed. Without any explicit configuration,gigabitethernet interfaces run at the maximum speed that they are capable of.


Broadcom


Flag: read-writeType: speed-typeValues:1000000000 = 1Gb/s10000000000 = 10Gb/s40000000000 = 40Gb/sNote: Ports ge0 and ge1 have a fixed speed of 40Gb/s. Ports ge2 through ge17 have a defaultspeed of 10Gb/s.Optional: Yes

mac-addressDescription: MAC address for the interface.Flag: read-onlyType: yang:mac-addressConfig: falseValues: Valid MAC addressOptional: Yes

operational-statusDescription: Operational status of the port.Flag: read-onlyType: uint16Config: falseValues: 1 = Online. 2 = Offline. Default: No valueOptional: Yes

persistent-disableDescription: Indicates if the port is persistently enabled or persistently disabled.Flag: read-writeType: uint8Value: 0 = persistently enabled. 1 = persistently disabled. Default: 0Optional: Yes

gigabitethernet-statisticsDescription: A list of interface-related statistics for a Gigabit Ethernet port.Flag: read-writeKey: nameThis list has the following leafs.name


out-pktsDescription: The total number of packets transmitted out of the interface.Flag: read-onlyType: yang:zero-based-counter64Config: falseValues: 0 through 18446744073709551615Optional: Yes

out-octetsDescription: The total number of octets transmitted out of the interface.Flag: read-only


Broadcom


Type: yang:zero-based-counter64Config: falseValues: 0 through 18446744073709551615Optional: Yes

out-unicast-pktsDescription: The total number of unicast packets transmitted out of the interface.Flag: read-onlyType: yang:zero-based-counter64Config: falseValues: 0 through 18446744073709551615Optional: Yes

out-multicast-pktsDescription: The total number of multicast packets transmitted out of the interface.Flag: read-onlyType: yang:zero-based-counter64Config: falseValues: 0 through 18446744073709551615Optional: Yes

out-broadcast-pktsDescription: The total number of broadcast packets transmitted out of the interface.Flag: read-onlyType: yang:zero-based-counter64Config: falseValues: 0 through 18446744073709551615Optional: Yes

out-vlan-pktsDescription: The total number of VLAN packets transmitted out of the interface.Flag: read-onlyType: yang:zero-based-counter64Config: falseValues: 0 through 18446744073709551615Optional: Yes

out-pause-pktsDescription: The total number of pause packets transmitted out of the interface.Flag: read-onlyType: yang:zero-based-counter64Config: falseValues: 0 through 18446744073709551615Optional: Yes

in-pktsDescription: The number of packets received on the interface.Flag: read-onlyType: yang:zero-based-counter64Config: falseValues: 0 through 18446744073709551615Optional: Yes

in-octetsDescription: The total number of octets received on the interface.Flag: read-onlyType: yang:zero-based-counter64


Broadcom


Config: falseValues: 0 through 18446744073709551615Optional: Yes

in-unicast-pktsDescription: The number of unicast packets received on the interface.Flag: read-onlyType: yang:zero-based-counter64Config: falseValues: 0 through 18446744073709551615Optional: Yes

in-multicast-pktsDescription: The number of multicast packets received on the interface.Flag: read-onlyType: yang:zero-based-counter64Config: falseValues: 0 through 18446744073709551615Optional: Yes

in-broadcast-pktsDescription: The number of broadcast packets received on the interface.Flag: read-onlyType: yang:zero-based-counter64Config: falseValues: 0 through 18446744073709551615Optional: Yes

in-vlan-pktsDescription: The total number of VLAN packets received on the interface.Flag: read-onlyType: yang:zero-based-counter64Config: falseValues: 0 through 18446744073709551615Optional: Yes

in-pause-pktsDescription: The total number of pause packets received on the interface.Flag: read-onlyType: yang:zero-based-counter64Config: falseValues: 0 through 18446744073709551615Optional: Yes

carrier-loss-errorDescription: The total number of carrier loss errors.Flag: read-onlyType: yang:zero-based-counter64Config: falseValues: 0 through 18446744073709551615Optional: Yes

crc-errorDescription: The total number of cyclic redundancy check (CRC) errors.Flag: read-onlyType: yang:zero-based-counter64Config: false


Broadcom


Values: 0 through 18446744073709551615Optional: Yes

jabber-errorDescription: The total number of jabber errors.Flag: read-onlyType: yang:zero-based-counter64Config: falseValues: 0 through 18446744073709551615Optional: Yes

reset-statisticsDescription: Resets statistic countersFlag: read-writeType: uint8Values: 0 = Statistical counters have not been reset. 1 = reset statistical counters. A 0will always be returned on a GET. Default: 0Optional: Yes

time-generatedDescription: The time at which the statistics were queried.Flag: read-onlyType: fibrechannel:time-generated-typeConfig: falseUnits: secondsValues: 1 through 2147483646Optional: Yes

Supported Methods

The GET, PATCH, OPTIONS, and HEAD methods are supported in this module. The DELETE and POST methods are notsupported.

ExamplesRetrieving the List of all Gigabit Ethernet Ports on a SwitchThis example uses a GET request to retrieve the list of all the Gigabit Ethernet ports on the specified switch.StructureGET <base_URI>/running/brocade-interface/gigabitethernetURIGET https://10.10.10.10/rest/running/brocade-interface/gigabitethernet


<Response>

<gigabitethernet>

<name>4/0</name>



Broadcom


<speed>40000000000</speed>

<mac-address>14:15:1c:16:d0:4c</mac-address>



</gigabitethernet>

.

.

.

<gigabitethernet>

<name>4/17</name>


<speed>10000000000</speed>

<mac-address>14:15:1c:16:d0:5d</mac-address>



</gigabitethernet>

</Response>

Retrieving Gigabit Ethernet Port StatisticsThis example uses a GET request to retrieve the Gigabit Ethernet port statistics for all Gigabit Ethernet portson the switch.StructureGET <base_URI>/running/brocade-interface/gigabitethernet-statisticsURIGET https://10.10.10.10/rest/running/brocade-interface/gigabitethernet-statistics


<Response>

<gigabitethernet-statistics>

<name>4/0</name>

<out-pkts>178269</out-pkts>

<out-octets>23396402</out-octets>

<out-unicast-pkts>176862</out-unicast-pkts>

<out-multicast-pkts>0</out-multicast-pkts>

<out-broadcast-pkts>1407</out-broadcast-pkts>

<out-vlan-pkts>0</out-vlan-pkts>

<out-pause-pkts>0</out-pause-pkts>

<in-pkts>278070</in-pkts>

<in-octets>30069936</in-octets>

<in-unicast-pkts>267797</in-unicast-pkts>

<in-multicast-pkts>0</in-multicast-pkts>

<in-broadcast-pkts>10273</in-broadcast-pkts>

<in-vlan-pkts>0</in-vlan-pkts>

<in-pause-pkts>0</in-pause-pkts>

<carrier-loss-error>3</carrier-loss-error>


Broadcom


<crc-error>0</crc-error>

<jabber-error>0</jabber-error>

<reset-statistics>0</reset-statistics>

<time-generated>1500431065</time-generated>

</gigabitethernet-statistics>

.

.

.

<gigabitethernet-statistics>

<name>4/17</name>

<out-pkts>0</out-pkts>

<out-octets>0</out-octets>

<out-unicast-pkts>0</out-unicast-pkts>

<out-multicast-pkts>0</out-multicast-pkts>

<out-broadcast-pkts>0</out-broadcast-pkts>

<out-vlan-pkts>0</out-vlan-pkts>

<out-pause-pkts>0</out-pause-pkts>

<in-pkts>0</in-pkts>

<in-octets>0</in-octets>

<in-unicast-pkts>0</in-unicast-pkts>

<in-multicast-pkts>0</in-multicast-pkts>

<in-broadcast-pkts>0</in-broadcast-pkts>

<in-vlan-pkts>0</in-vlan-pkts>

<in-pause-pkts>0</in-pause-pkts>

<carrier-loss-error>0</carrier-loss-error>

<crc-error>0</crc-error>

<jabber-error>0</jabber-error>

<reset-statistics>0</reset-statistics>

<time-generated>1500431065</time-generated>

</gigabitethernet-statistics>

</Response>

Retrieving Information for a Single Gigabit Ethernet PortThis example uses a GET request to retrieve information about the Gigabit Ethernet port “4/1”.StructureGET <base_URI>/running/brocade-interface/gigabitethernet/name/4%2f1URINotice that the slash character in the name resource is encoded as “%2f”.GET https://10.10.10.10/rest/running/brocade-interface/gigabitethernet/name/4%2f1


<Response>

<gigabitethernet>

<name>4/1</name>



Broadcom


<speed>40000000000</speed>

<mac-address>14:15:1c:16:d0:4d</mac-address>



</gigabitethernet>

</Response>

Resetting the Port Stats for a Single Gigabit Ethernet PortThis example uses a PATCH request to reset statistics for the Gigabit Ethernet port 4/2. The “name” key/valueis included in the URI to indicate the correct port.StructurePATCH <base_URI>/running/brocade-interface/gigabitethernet/name/name/reset-statistics/1Request BodyNo request body is required.Response BodyWhen the statistics are is successfully reset, the response contains an empty message body and a "204 NoContent" status in the headers.

History




Broadcom


brocade-interface/portchannelThis modules enables you to view and configure port channel interfaces on the switch.

Module Tree

This is the tree view of the brocade-interface/portchannel module from the brocade-interface.yang-tree.txt file. See YANGModule Overview for YANG node field definitions and possible values, and see Supported Data Types for data typedescriptions.



+--rw portchannel* [name] {fibrechannel:portchannel_platform}?

+--rw name string

+--rw key? uint32

+--rw portchannel-type? portchannel-type

+--ro speed? brocade-interface-types:portchannel-speed-type

+--ro lacp-system-mac-address? ietf:mac-address

+--rw admin-state-enabled? boolean

+--rw auto-negotiation-enabled? boolean

+--ro operational-status-enabled? boolean

+--rw gigabit-ethernet-member-ports

| +--rw port* brocade-interface-types:ge-interface-type

+--ro primary-member-gigabit-ethernet-port? brocade-interface-types:ge-interface-type

URI Format


• <base_URI>running/brocade-interface/portchannel/name/port_channel_name to view or configure aport channel.

Parametersportchannel

Description: A list of port channel interfaces on the switch and includes the port channel configuration andoperational state. The switch must support port channels and must be in Native mode.Flag: read-writeKey: nameOptional: NoThis container has the following leafs:name

Description: The port channel name.Flag: read-writeType: stringValue: 1 to 31 characters using alphanumeric characters, hyphen, and underscore.Optional: No

keyDescription: The port channel key. Once created, the port channel key cannot be modified. If you do notprovide the key during port channel creation, the system auto-assigns an available key. The port channelkey is unique across all port channel interfaces on the switch.Flag: read-write


Broadcom


Type: uint32Value: 1 to 1000.Optional: No

portchannel-typeDescription: The type of portchannel interface (static or dynamic). The port channel type is a mandatoryparameter during the portchannel creation.Flag: read-writeType: portchannel-typeValue: static = A static port channel. dynamic = A dynamic port channel.Optional: No

speedDescription: The speed of the port channel interface. The speed of the port channel is the speed of itsmember ports.

NOTEThe speed for all members of a port channel must match.

Flag: read-onlyType: brocade-interface-types:portchannel-speed-typeConfig: falseValue: 0 = Auto-negotiated. 1000000000 = 1 GbE. 10000000000 = 10 GbE. 25000000000 = 25 GbE.40000000000 = 40 GbEOptional: No

lacp-system-mac-addressDescription: The LACP MAC address of the system.Flag: read-onlyType: ietf:mac-addressConfig: falseValue: The LACP MAC address of the system.Optional: No

admin-state-enabledDescription: Enables or disables the admin state of the port channel.Flag: read-writeType: booleanValue: false = Disables the port channel. true = Enables the port channel. The default is enabled.Optional: No

auto-negotiation-enabledDescription: Enables or disables auto negotiation of the FCIP port channel. This parameter is availableonly when the speed of the port channel interface is 1000000000 (1 GbE).Flag: read-writeType: booleanValue:Optional: No

operational-status-enabledDescription: The port channel operational status.Flag: read-onlyType: booleanConfig: falseValue: false = The port channel is offline. true = The port channel is online.Optional: No


Broadcom


gigabit-ethernet-member-portsDescription: A list of Gigabit Ethernet port channel members.Flag: read-writeOptional: NoThis list has the following leaf:port

Description: A GE_Port interface that is a member of the port channel.Flag: read-writeType: brocade-interface-types:ge-interface-typeValue: A GE_Port interface that is a member of the port channel.Optional: No

primary-member-gigabit-ethernet-portDescription: The primary member interface of the port channel. This parameter is available only whenthe port channel type is dynamic (type = dynamic) and the operational status is enabled (operational-status-enabled = true).Flag: read-onlyType: brocade-interface-types:ge-interface-typeConfig: falseValue: The GE_Port interface (in slot/port format) of the portchannel primary member.Optional: No

Supported Methods


Examples

This section provides basic examples for using the brocade-operation-extension module.

Displaying Port Channel Details

This example uses a GET request to display the port channel details.

Structure

GET base_URI/brocade-interface/portchannel/name/port_channel_name

URI

GET https://10.10.10.10/rest/running/brocade-interface/portchannel/name/port_channel_name

Request Body


Response Body


<Response>

<portchannel>

<name>rest-test4</name>

<lacp-system-mac-address>88:94:71:52:c6:8e</lacp-system-mac-address>

<portchannel-type>dynamic</portchannel-type>

<speed>1000000000</speed>



Broadcom


<auto-negotiation-enabled>true</auto-negotiation-enabled>

<operational-status-enabled>false</operational-status-enabled>

<primary-member-gigabit-ethernet-port/>

<gigabit-ethernet-member-ports>

<port>0/0</port>

<port>0/1</port>

</gigabit-ethernet-member-ports>

<key>999</key>

</portchannel>

<portchannel>

<name>dynamic</name>

<lacp-system-mac-address>c4:f5:7c:8d:b2:ce</lacp-system-mac-address>


<speed>10000000000</speed>


<operational-status-enabled>true</operational-status-enabled>

<primary-member-gigabit-ethernet-port>5/2</primary-member-gigabit-ethernet-port>


<port>5/2</port>

<port>5/3</port>


<key>2</key>

</portchannel>

</Response>

Configuring a Port Channel

This example uses a POST request to create a port channel 'dlag101'.

Structure

POST base_URI/brocade-interface/portchannel/name/port_channel_name

URI

POST https://10.10.10.10/rest/brocade-interface/portchannel/name/dlag101

Request Body

<portchannel>




<port>5/4</port>

<port>5/5</port>


<key>6</key>

</portchannel>

Response Body

When the operation is successful, there is no response, and a “201 Created” status appears in the headers.


Broadcom


History



Fabric OS 9.0.0 The API was modified to update the primary-member-gigabit-ethernet-port parameter.


Broadcom


Sample Use CasesThis section provides procedures for using the FOS REST API.

Logging On, Retrieving Switch Information, and Logging OutThis example uses a POST request to log on to a fabric, uses a GET request to retrieve the switch information for aswitch, and uses a POST request to log out of the fabric.

1. Use a POST request to log on to a fabric.POST <base_URI>/login

Authorization

You must provide a valid Fabric OS user name and password (such as, administrator / password) throughauthorization.Figure 5: Authorization

URI


Request Body


Response Body

There is no request response. When the operation is successful, the response body contains an empty message bodyand a “200 OK” status in the header.

If authentication is successful, a session authorization key is returned to the client in the response headers(for example, Custom_Basic Tk0ZmY2Zjg3NTY2ZDYwYjhmNj5NGQ0NTkzZjM0M2ZlMWM=). SubsequentFOS REST API operations must include this authorization key in the request authorization header. The clientapplications use this token to obtain further access to the server using the persistent connection.

2. Use a GET request to retrieve the information for a switch.

GET <base_URI>running/brocade-fabric/fabric-switch

URI


Broadcom


GET https://10.10.10.10/rest/running/brocade-fabric/fabric-switch

Request Body

No request body is required; however, you must include the session authorization key in the request authorizationheader.

Response Body

When the operation is successful, the response has a message body similar to the following and a “200 OK” status inthe headers.<?xml version="1.0"?>

<Response>

<fabric-switch>

<name>10:10:14:15:1c:9e:3b:c8</name>

<chassis-wwn>10:10:14:15:1c:9e:3c:07</chassis-wwn>


<fcid>16776199</fcid>








</fabric-switch>

<fabric-switch>

<name>10:10:14:15:1c:a2:1f:40</name>

<chassis-wwn>10:10:14:15:1c:a2:1f:7f</chassis-wwn>


<fcid>16776195</fcid>








</fabric-switch>

</Response>

3. Use a POST request to log out of a fabric.

<base_URI>/logout

URI


Request Body

No request body is required; however, you must include the session authorization key in the request authorizationheader.

Response Body

There is no request response. When the operation is successful, the response contains an empty message body anda “204 No Content” status in the header.


Broadcom


Logging On, Retrieving Chassis Information, and Logging Out UsingSession-Less REST API OperationFOS REST API session-less operation requests complete the login, GET operation, and logout as one complete request.You can use only basic authentication formats for FOS REST API session-less operation, which includes plain text orBase64.

NOTE

• Fabric OS 8.2.2 and later support FOS REST API session-less operation for GET requests only.• You must have at least one REST API session available to execute session-less requests.

This example uses a GET request with plain text authentication to log on, retrieve information about the chassis in JSONformat, and log out using session-less REST API operation.

Use a GET request to obtain chassis information.

Request

curl -v -X GET -u admin:password1 -H "Accept: application/yang-data+json" "https://10.11.12.13/rest/running/


Response Body

{

"Response": {

"chassis": {


"license-id": "10:00:c1:f2:3c:00:af:40",




"part-number": "40-1001199-03",

"vf-enabled": true,









"date": "12/24/2020-10:34:37"

}

}

Creating a Port Trunk Area Using JSONThis example provides step-by-step instructions for creating a port trunk area using JSON. Note that JSON requires thatyou define additional keys (Accept and Content-Type) in the request headers.

1. Use a GET request to confirm that all ports to be members of the port trunk area are disabled.

Request Headers


Broadcom


• Authorization = user name and password (such as, administrator / password)• Accept = application/yang-data+json• Content-Type = application/yang-data+json

URI

GET https://10.10.10.10/rest/running/brocade-interface/fibrechannel/name/0%2f16/enabled-state

Request Body


Response Body

When the operation is successful, the response has a message body similar to the following and a “200 OK” status inthe headers.

{

"Response": {

"fibrechannel": {

"name": "0/16",

"enabled-state": 6

}

}

}

2. Use a PATCH request to disable that port, if necessary

Request Headers


URI

PATCH https://10.10.10.10/rest/running/brocade-interface/fibrechannel/name/0%2f16/enabled-state/6

Request Body


Response Body

When the operation is successful, the response contains an empty message body and a “204 No Content” statusappears in the header.

3. Use a GET request to confirm that the ports all have trunking enabled.

Request Headers


URI

GET https://10.10.10.10/rest/running/brocade-interface/fibrechannel/name/0%2f16/trunk-port-enabled

Request Body



Broadcom


Response Body


{

"Response": {

"fibrechannel": {

"name": "0/16",

"trunk-port-enabled": 1

}

}

}

4. Use a PATCH request to enable trunking on a port, if necessary.

Request Headers


URI

PATCH https://10.10.10.10/rest/running/brocade-interface/fibrechannel/name/0%2f16/trunk-port-enabled/1

Request Body


Response Body


5. Use a POST request to create the port trunk area.

Request Headers


URI


Request Body

{

"trunk-members": {

"trunk-member": [

"0/16",

"0/17",

"0/18",

"0/19"

]


Broadcom


}

}

Response Body

When the operation is successful, the response has an empty message body and a “201 Created” status in theheaders.

6. Use a PATCH request to enable all ports in the port trunk area.

Request Headers


URI

PATCH https://10.10.10.10/rest/running/brocade-interface/fibrechannel/name/0%2f16/enabled-state/2

Request Body


Response Body


7. Use a GET request to confirm the port trunk area creation.

Request Headers


URI

GET https://10.10.10.10/rest/running/brocade-fibrechannel-trunk/trunk-area/trunk-index/16

Request Body


Response Body


{

"Response": {

"trunk-area": {

"trunk-index": 16,

"trunk-active": true,

"master-port": "0/16",

"trunk-members": {

"trunk-member": [

"0/16",

"0/17",

"0/18",

"0/19"


Broadcom


]

}

}

}

}

Disabling and Enabling a PortThis example uses PATCH to disable and enable a specific port.

The following example first uses GET to identify the state of a gigabitethernet port, uses PATCH to disable the port, usesGET to verify that the state value got changed, and finally uses PATCH to re-enable the port.

1. Use a GET request to identify the enabled-state attribute of the gigabitethernet port 0/3.GET <base_URI>/running/brocade-interface/gigabitethernet/name/0%2f3/enabled-state

Request Body


Response Body<?xml version="1.0"?>

<Response>

<gigabitethernet>

<name>0/0</name>

<enabled-state>1</enabled-state> <-Port is in enabled state.

</gigabitethernet>

</Response>

2. Use a PATCH request to modify the value for enabled-state attribute.PATCH <base_URI>/running/brocade-interface/gigabitethernet/name/0%2f3/enabled-state/0

Request Body


Response Body

When the port status is successfully changed, the response contains an empty message body and a "204 No Content"status in the first line of the headers.

3. Use a GET request to retrieve and verify that the enabled-state attribute value is changed.GET <base_URI>/running/brocade-interface/gigabitethernet/name/0%2f3/enabled-state

Request Body


Response Body


<Response>

<gigabitethernet>

<name>0/0</name>

<enabled-state>0</enabled-state> <-Port is in disabled state.

</gigabitethernet>

</Response>


Broadcom


4. Use a PATCH request to re-enable the port.PATCH <base_URI>/running/brocade-interface/gigabitethernet/name/0%2f0/enabled-state/1

Request Body


Response Body

When the port status is successfully changed, the response contains an empty message body and a "204 No Content"status in the first line of the headers.

Creating an Up State Tunnel Using Multiple URIsThis example uses POST to create a specific port (IP interface), and then adds an Extension tunnel and a circuit to thatport.

1. Make a POST request to create the IP interface on port 4/0.

URI

POST <base_URI>/running/brocade-interface/extension-ip-interface

Request Body


<name>4/0</name>

<dp-id>1</dp-id>





Response Body

When the interface is successfully created, the response contains an empty message body and a "201 Created" statusin the first line of the headers.

NOTEThis is the equivalent of portcfg ipif 4/ge0.dp1 create 10.10.0.10/24.

2. Make a GET request to confirm that the IP interface has been created.

URI

GET <base_URI>/running/brocade-interface/extension-ip-interface/name/4%2f0/dp-id/1/

Request Body


Response Body

When the operation is successful, the response has a message body similar to the following, and a “200 OK” status inthe headers.


<Response>


<name>4/0</name>

<dp-id>1</dp-id>


Broadcom






<status-flags>U R M </status-flags>


</Response>

3. Make a POST request to create the tunnel on port 4/30.

URI

POST <base_URI>/running/brocade-extension-tunnel/extension-tunnel

Request Body

<extension-tunnel>

<name>4/30</name>

</extension-tunnel>

Response Body

When the tunnel is successfully created, the response contains an empty message body and a "201 Created" status inthe first line of the headers.

NOTEThis is the equivalent of portcfg fciptunnel 4/30 create.

4. Make a GET request to confirm that the tunnel has been created.

URI

GET <base_URI>/running/brocade-extension-tunnel/extension-circuit-statistics

Request Body


Response Body



<Response>


<name>4/16</name>









...



Broadcom


<name>4/30</name>









</Response>

5. Make a POST request to create circuit 0.

URI

POST <base_URI>/running/brocade-extension-tunnel/extension-circuit

Request Body

<extension-circuit>

<name>4/30</name>







Response Body

When the circuit is successfully created, the response contains an empty message body and a "201 Created" status inthe first line of the headers.

NOTEThis is the equivalent of portcfg fcipcircuit 4/30 create 0 --local-ip 10.10.0.10 --remote-ip 10.10.0.20 --min-comm-rate 1000000 --max-comm-rate 1000000.

6. Make a GET request to confirm that the tunnel has been created.

URI

GET <base_URI>/running/brocade-extension-tunnel/extension-circuit-statistics

Request Body


Response Body



<Response>


<name>4/16</name>




Broadcom








...


<name>4/30</name>









</Response>

Running a ClearLink Diagnostic Port TestThis example demonstrates using the FOS REST API to perform a ClearLink diagnostic test on an existing D_Port.

1. Use a GET request to verify that the port (0/89) is configured as a diagnostic port (D_Port). Notice that the slashcharacter in the name resource is encoded as “%2f”.

URI

GET <base_URI>/brocade-interface/fibrechannel/name/0%2f89/d-port-enable

Request Body


Response Body



<Response>

<fibrechannel>

<name>0/89</name>


</fibrechannel>

</Response>

Per the YANG definition, a “1” in the “d-port-enable” field indicates that the port is configured as a diagnostic port.

2. Use a PATCH request to start the ClearLink diagnostic test on the desired D_Port. This example uses a diagnostic testframe-size value of 2048.

URI

PATCH <base_URI>/brocade-diagnostics/fibrechannel-diagnostics/name/0%2f89/diagnostic-control/1

Request Body



Broadcom


Response Body

When the operation is successful, the response has a message body similar to the following, and a “204 No Content”status in the headers.

3. Use a GET request to retrieve the diagnostic results.

URI

GET <base_URI>/brocade-diagnostics/fibrechannel-diagnostics/name/0%2f89

Request Body


Response Body



<Response>


<name>0/89</name>


<mode>automatic</mode>

<state>STOPPED</state>

<distance>-1</distance>

<electrical-loopback-test>

<result>NOT STARTED</result>

<comments>----------</comments>

</electrical-loopback-test>

<optical-loopback-test>



</optical-loopback-test>

<link-traffic-test>



</link-traffic-test>

<start-time>Fri Aug 24 09:39:18 2018</start-time>



<time/>

<fec>

<enable>yes</enable>

<active>yes</active>

<option>no</option>

</fec>

<cr>

<enable>yes</enable>

<active>no</active>

<option>no</option>

</cr>


<buffers-required/>


Broadcom


<failure-report>

<errors-detected-local>no</errors-detected-local>

<errors-detected-remote>no</errors-detected-remote>

</failure-report>

<end-time>Fri Aug 24 09:39:39 2018</end-time>

<egress-power-loss>

<tx>-5.57</tx>

<rx/>

<loss/>

<comments/>

</egress-power-loss>

<ingress-power-loss>

<tx/>

<rx>-1.28</rx>

<loss/>

<comments/>

</ingress-power-loss>

<payload-pattern>

<pattern>jCRPAT</pattern>

</payload-pattern>


</Response>

Creating a MAPS Rule to Monitor CRC Errors on FC PortsThis example demonstrates using the FOS REST API to create a MAPS rule to monitor CRC errors on FC ports.

1. Use a POST request to create a MAPS rule to monitor CRC errors on all the ports with a RASlog alert action.

URI

POST <base_URI>/brocade-maps/rule

Request Body

<rule>

<name>rule_to_monitor_crc_error</name>



<time-base>MIN</time-base>




<actions>


</actions>

</rule>

Response Body


2. Use a GET request to verify the newly created rule and its contents.

URI


Broadcom


GET <base_URI>/brocade-maps/rule/name/rule_to_monitor_crc_error

Request Body


Response Body



<Response>

<rule>








<actions>


</actions>

</rule>

</Response>

3. Use a POST request to create a policy with the newly created rule and activate the policy.

URI

POST <base_URI>/brocade-maps/maps-policy

Request Body

<maps-policy>

<name>monitor_crc_error</name>

<rule-list>

<rule>rule_to_monitor_crc_error</rule>

</rule-list>

<is-active-policy>true</is-active-policy>

</maps-policy>

Response Body


4. Use a PATCH request to enable the RASlog action at switch level.

URI

PATCH <base_URI>/brocade-maps/maps-config

Request Body



Broadcom


<maps-config>

<actions>


</actions>

</maps-config>

Response Body


Monitoring the Execution of a MAPS RuleThis example demonstrates using the FOS REST API to monitor the execution of a MAPS rule.

1. Use a GET request to retrieve the dashboard data for executed rules.

URI

GET <base_URI>/brocade-maps/dashboard-rule

Request Body


Response Body



<Response>

<dashboard-rule>

<category>Port Health</category>



<time-stamp>Aug 04 21:50:54</time-stamp>


<objects>

<object>F-Port 10:90</object>

</objects>

</dashboard-rule>

</Response>

2. Verify the RASLOG alert.

2019/08/04-21:50:54, [MAPS-1003], 10737, FID 128, WARNING, TOM_2____________________TOM_2, port10, F-Port

10, Condition=ALL_PORTS(CRC/min>0), Current Value:[CRC, 90 CRCs], RuleName=rule_to_monitor_crc_error,

Dashboard Category=Port Health.


Broadcom


Creating a User-Defined Group, Adding Ports to the Group, and Usingthe Group to Monitor a RuleThis example demonstrates using the FOS REST API to create a user-defined group, add ports to the group, and use thegroup to monitor a rule.

1. Use a POST request to create a user-defined port group.

URI

POST <base_URI>/brocade-maps/group

Request Body

<group>

<name>new_group_to_mon_ITW</name>


</group>

Response Body


2. Use a POST request to add ports to the group.

URI


Request Body

<group>

<name>new_group_to_mon_ITW</name>

<members>


</members>

</group>

Response Body


3. Use a POST request to create a new rule to monitor ITW errors on the ports.

URI


Request Body

<rule>

<name>rule_to_monitor_ITW_error</name>






Broadcom



<group-name>new_group_to_mon_ITW</group-name>

<actions>


</actions>

</rule>

Response Body


Retrieving the Switch Status Policy ReportThis example demonstrates using the FOS REST API to retrieve the switch status policy report.

Use a GET request to retrieve the switch status policy report.

URI

GET <base_URI>/brocade-maps/switch-status-policy-report

Request Body


Response Body



<Response>

<switch-status-policy-report>

<switch-health>healthy</switch-health>

<power-supply-health>healthy</power-supply-health>

<fan-health>healthy</fan-health>

<wwn-health>healthy</wwn-health>

<temperature-sensor-health>healthy</temperature-sensor-health>

<ha-health>healthy</ha-health>

<control-processor-health>healthy</control-processor-health>

<core-blade-health>healthy</core-blade-health>

<blade-health>healthy</blade-health>

<flash-health>healthy</flash-health>

<marginal-port-health>healthy</marginal-port-health>

<faulty-port-health>healthy</faulty-port-health>

<missing-sfp-health>healthy</missing-sfp-health>

<error-port-health>healthy</error-port-health>

<expired-certificate-health>healthy</expired-certificate-health>

<airflow-mismatch-health>healthy</airflow-mismatch-health>

<trusted-fos-cert-health>healthy</trusted-fos-cert-health>

</switch-status-policy-report>

</Response>


Broadcom


Generating a CSR and Importing a Security CertificateThe following example first uses a POST request to generate a CSR (certificate signing request), uses a PATCH requestto export the CSR to third-party CA (certificate authority), uses a PATCH request to import the client CA on the localswitch, and finally uses a PATCH request to import the signed switch certificate.

1. Use a POST request to generate a CSR (certificate signing request).

URI

POST https://10.10.10.10/rest/running/brocade-security/security-certificate-generate

Request Body







<years>10</years>

<country-name>US</country-name>

<state-name>Colorado</state-name>

<locality-name>Smallville</locality-name>

<organization-name>Acme Inc.</organization-name>

<unit-name>abc_division</unit-name>

<domain-name>10.10.10.10.abc.acme.com</domain-name>


Response Body


NOTEGenerating a CSR for HTTPS may restart HTTP and HTTPS and inadvertently terminate REST operations.

2. Use a PATCH request to export a CSR to third-party CA (certificate authority). The CA then signs the CSR andgenerates a switch certificate.

URI

PATCH https://10.10.10.10/rest/running/brocade-security/security-certificate-action

Request Body


<certificate-entity></certificate-entity>

<certificate-name></certificate-name>

<certificate-type></certificate-type>

<operation></operation>

<protocol></protocol>

<remote-directory></remote-directory>

<remote-host-ip></remote-host-ip>

<remote-user-name></remote-user-name>

<remote-user-password></remote-user-password>



Broadcom


Response Body


3. Use a PATCH request to import the client CA on the local switch, which is the CA certificate that signed the switchcertificate.

URI


Request Body


<certificate-entity></certificate-entity>

<certificate-name></certificate-name>

<certificate-type></certificate-type>

<operation></operation>

<protocol></protocol>

<remote-directory></remote-directory>

<remote-host-ip></remote-host-ip>

<remote-user-name></remote-user-name>

<remote-user-password></remote-user-password>


Response Body


4. Use a PATCH request to import the signed switch certificate.

URI


Request Body





<certificate-name>10.10.10.10.fcap.pem</certificate-name>



<remote-user-name>ca_user</remote-user-name>

<remote-directory>/certs</remote-directory>

<remote-user-password>cGFzc3dvcmQxMjM=</remote-user-password>


Response Body



Broadcom


Configuring SSH Public Key Authentication on a Switch for IncomingConnectionsThe following example first uses a POST request to generate and install an 'dsa' private key on the device, then uses aPATCH request to import a public key from a remote host.

1. Use a POST request to generate and install an 'dsa' private key on the device.Note that the passphrase used in this example is Base64 encoded.

URI

POST https://10.10.10.10/rest/running/brocade-security/sshutil-key

Request Body

<sshutil-key>



<passphrase>U2lsYfraW4xMjM=</passphrase>

</sshutil-key>

Response Body


2. Use a PATCH request to import a public key from a remote host.Note that the password used in this example is Base64 encoded.

URI

PATCH https://10.10.10.10/rest/running/brocade-security/sshutil-public-key-action

Request Body









<public-key-name>in_coming.pub</public-key-name>


Response Body



Broadcom


3. Test the setup by logging in to the switch from a remote device, or by running a command remotely using SSH.

Configuring SSH Public Key Authentication on a Switch for OutgoingConnectionsThe following example first uses a POST request to generate and install an 'dsa' private key on the device, then uses aPATCH request to export a public key to a remote host.

1. Use a POST request to generate and install an 'dsa' private key on the device.Note that the passphrase used in this example is Base64 encoded.

URI

POST https://10.10.10.10/rest/running/brocade-security/sshutil-key

Request Body

<sshutil-key>



<passphrase>U2lsYfraW4xMjM=</passphrase>

</sshutil-key>

Response Body


2. Use a PATCH request to export a public key to a remote host.Note that the password used in this example is Base64 encoded.

URI

PATCH https://10.10.10.10/rest/running/brocade-security/sshutil-public-key-action

Request Body









<public-key-name>out_going.pub</public-key-name>


Response Body


3. Append the public key to a remote host by logging in to the remote host, locating the directory where authorized keysare stored, and appending the public key to the file.You may need to refer to the host’s documentation to locate where the authorized keys are stored.


Broadcom


4. Test the setup by using a command that uses SCP and authentication.

Creating a New Zone Using RESTIn this use case, use a POST request to create a new zone, “zone1” with three zone members “10:00:00:00:00:00:00:01”,“10:00:00:00:00:00:00:02”, and "10:00:00:00:00:00:00:03".

1. Use a POST request to create the new zone, “zone1”.

URI

POST <base_URI>/rest/running/brocade-zone/zone

Request Body

<zone>

<zone-name>zone1</zone-name>


<member-entry>

<entry-name>10:00:00:00:00:00:00:01</entry-name>



</member-entry>

</zone>

Response Body

When the resource is successfully created, the response contains an empty message body and a “201 Created” statusin the first line of the headers.

2. Use a GET request to verify the new zone, "zone1".

URI

GET <base_URI>/rest/running/brocade-zone/zone/zone-name/zone1

Request Body


Response Body

The response contains a message body similar to the following, and has a “200 OK” status in the first line of theheaders.<?xml version="1.0"?>

<Response>

<zone>




<member-entry>




</member-entry>

</zone>

</Response>


Broadcom


Adding Additional Zone Members to an Existing ZoneIn this use case, "zone1" already exists with zone members “10:00:00:00:00:00:00:01”, “10:00:00:00:00:00:00:02”, and"10:00:00:00:00:00:00:03". This will add new zone members “10:00:00:00:00:00:00:04”, “10:00:00:00:00:00:00:05”, and"10:00:00:00:00:00:00:06" to the existing “zone1”.

1. Use a GET request to verify the zone.

URI

GET <base_URI>/rest/running/brocade-zone/zone/zone-name/zone1

Request Body


Response Body


<Response>

<zone>




<member-entry>




</member-entry>

</zone>

</Response>

2. Use a POST request to add new zone members “10:00:00:00:00:00:00:04”, “10:00:00:00:00:00:00:05”, and"10:00:00:00:00:00:00:06" to the zone1.

URI

POST <base_URI>/rest/running/brocade-zone/defined-configuration/zone

Request Body

<zone>



<member-entry>




</member-entry>

</zone>

Response Body



Broadcom


Creating, Modifying, and Deleting a Zone Using RESTThis use case set walks you through the following actions:

• Creating a zone• Modifying a zone• Aborting a zone transaction• Deleting a zone

In this use case set, zone configuration “cfg1” already exists with member zones “zone1”, “zone2”, and “zone4”. Wewill create a new zone, “zone3” and add it to the “cfg1” zone configuration. We will then delete “zone4” from the zoneconfiguration.

Creating a New Zone in an Existing Configuration Using RESTIn this use case, zone configuration “cfg1” already exists with member zones “zone1”, and “zone2”. This will create a newzone, “zone3”, and add it to the existing “cfg1” zone configuration.

1. Use a GET request to verify the current zone configuration.

URI

GET <base_URI>/rest/running/brocade-zone/effective-configuration

Request Body


Response Body


<Response>

<effective-configuration>

<default-zone-access>1</default-zone-access>

<cfg-action>0</cfg-action>

<db-max>1045274</db-max>

<db-avail>1023818</db-avail>

<db-committed>17186</db-committed>

<db-transaction>0</db-transaction>

<db-chassis-wide-committed>18198</db-chassis-wide-committed>

<transaction-token>0</transaction-token>

<checksum>fd0d26c940d4f55b467b76552d687e74</checksum> <== record this value

<cfg-name>cfg1</cfg-name>

<enabled-zone>



<member-entry>




</member-entry>

</enabled-zone>

<enabled-zone>




Broadcom


<member-entry>




</member-entry>

</enabled-zone>

</effective-configuration>

</Response>

2. Record the checksum value.

3. Use a POST request to create the new zone, “zone3”.

URI

POST <base_URI>/rest/running/brocade-zone/defined-configuration/zone

Request Body

<zone>



<member-entry>




</member-entry>

</zone>

Response Body


4. Use a PATCH request to add “zone3” to the existing configuration “cfg1” with all desired zone members. Because aPATCH operation overwrites the entire member-zone leaf-list for “cfg1”, all desired member-zones must be included,including any member zones that were already in the configuration.

URI

PATCH <base_URI>/rest/running/brocade-zone/defined-configuration/cfg

Request Body

<cfg>


<member-zone>



<zone-name>zone3<zone-name>

</member-zone>

</cfg>

Response Body

When the resource is successfully created, the response contains an empty message body and a “204 No Content”status in the first line of the headers.

5. Use a PATCH request to save the zone configuration using the zoneDB checksum from step 1.

URI


Broadcom


PATCH <base_URI>/rest/running/brocade-zone/effective-configuration/cfg-action/1

Request Body

<checksum>fd0d26c940d4f55b467b76552d687e74</checksum>

Response Body

When the request is successfully completed, the response contains an empty message body and a “204 No Content”status in the first line of the headers.

6. Use a GET request to retrieve the new zoneDB checksum value.

URI

GET <base_URI>/rest/running/brocade-zone/effective-configuration/checksum

Request Body


Response Body The response contains a message body similar to the following, and has a “200 OK” status in thefirst line of the headers.


<Response>


<checksum>d2ba41573853f387d9fd1d76f3b56112</checksum>


</Response>

7. Use a PATCH request to enable the new zone configuration using the zoneDB checksum from step 6.

URI

PATCH <base_URI>/rest/running/brocade-zone/effective-configuration/cfg-name/cfg1

Request Body


Response Body


8. Use a GET request to view the new effective zoning configuration.

URI

GET <base_URI>/rest/running/brocade-zone/effective-configuration

Request Body


Response Body

The response contains a message body similar to the following, and has a “200 OK” status in the first line of theheaders. The zone named “zone3” has been added to the zoning configuration named “cfg1”.<?xml version="1.0"?>

<Response>


<default-zone-access>1</default-zone-access>


Broadcom


<cfg-action>0</cfg-action>

<db-max>1045274</db-max>

<db-avail>1023812</db-avail>

<db-committed>17192</db-committed>

<db-transaction>0</db-transaction>

<db-chassis-wide-committed>18204</db-chassis-wide-committed>




<enabled-zone>



<member-entry>




</member-entry>

</enabled-zone>

<enabled-zone>



<member-entry>




</member-entry>

</enabled-zone>

<enabled-zone>



<member-entry>




</member-entry>

</enabled-zone>


</Response>

Modifying a ZoneThis example modifies the existing "zone2" in the defined-configuration “cfg1”, which is currently enabled.

1. Use a GET request to retrieve the current zoneDB checksum value.

URI


Request Body


Response Body

The response contains a message body similar to the following, and has a “200 OK” status in the headers.<?xml version="1.0"?>


Broadcom


<Response>


<checksum>fd0d26c940d4f55b467b76552d687e74</checksum> <== record this value


</Response>

2. Use a GET request to verify the current zone “zone2” configuration.

URI

GET <base_URI>/rest/running/brocade-zone/defined-configuration/zone/zone-name/zone2

Request Body


Response Body

The response contains a message body similar to the following, and has a “200 OK” status in the headers.<?xml version="1.0"?>

<Response>

<zone>



<member-entry>




</member-entry>

</zone>

</Response>

3. Use a PATCH request to update the existing zone “zone2”. Because a PATCH operation overwrites the entire member-entry leaf-list for “zone2”, all desired member-entries must be included, including any member entries that werealready in the configuration.

URI

PATCH <base_URI>/rest/running/brocade-zone/defined-configuration/zone

Request Body

<zone>



<member-entry>







</member-entry>

</zone>

Response Body

When the operation completes successfully, the response returns an empty message body and a “204 No Content”status in the headers.


Broadcom


4. Use a PATCH request to enable the updated zone configuration using the zoneDB checksum from step 1.

URI

PATCH <base_URI>/rest/running/brocade-zone/effective-configuration/cfg-name/cfg1

Request Body

<checksum>fd0d26c940d4f55b467b76552d687e74</checksum>

Response Body


5. Use a GET request to view the updated zone “zone2” effective zoning configuration.

URI

GET <base_URI>/rest/running/brocade-zone/effective-configuration/enabled-zone/zone-name/zone2

Request Body


Response Body

The response contains a message body similar to the following, and has a “200 OK” status in the headers. The zonenamed “zone2” has been updated in the effective zoning configuration.


<Response>


<enabled-zone>



<member-entry>







</member-entry>

</enabled-zone>


</Response>

Aborting a Zone TransactionThis example aborts a zone transaction before you commit a zone transaction.

This example assumes you have followed steps 1 through 4 of the 'Creating a zone using REST' or steps 1 through 3 ofthe 'Modifying a zone' use cases above.

1. Use a PATCH request to abort pending zone changes.

URI


Request Body


Broadcom



Response Body


2. Use a GET request to verify the pending zone changes are aborted.

URI

GET <base_URI>/rest/running/brocade-zone/effective-configuration/transaction-token

Request Body


Response Body

The response contains a message body similar to the following, and has a “200 OK” status in the headers.


<Response>




</Response>

Deleting a ZoneIn this example, we will delete an existing zone, "zone4", from the defined-configuration.

1. Use a GET request to retrieve the current zoneDB checksum value.

URI


Request Body


Response Body


<Response>


<checksum>5c37a7bfe10f77de3253080b174a3239</checksum> <== record this value


</Response>

2. Use a GET request to verify the current zoning defined-configuration.

URI

GET <base_URI>/rest/running/brocade-zone/defined-configuration/zone

Request Body



Broadcom


Response Body


<Response>

<zone>



<member-entry>




</member-entry>

</zone>

<zone>



<member-entry>




</member-entry>

</zone>

<zone>



<member-entry>




</member-entry>

</zone>

<zone>



<member-entry>




</member-entry>

</zone>

</Response>

3. Use a DELETE request to delete the existing zone “zone4”.

URI

DELETE <base_URI>/rest/running/brocade-zone/defined-configuration/zone/zone-name/zone4

Request Body


Response Body


Broadcom



4. Use a PATCH request to save the zone configuration using the zoneDB checksum from step 1.

URI


Request Body

<checksum>5c37a7bfe10f77de3253080b174a3239</checksum>

Response Body


5. Use a GET request to view the new defined zoning configuration.

URI

GET <base_URI>/rest/running/brocade-zone/defined-configuration/zone

Request Body


Response Body

The response contains a message body similar to the following, and has a “200 OK” status in the first line of theheaders. The zone named “zone4” has been removed from the zoning configuration named “cfg1”.<?xml version="1.0"?>

<Response>

<zone>



<member-entry>




</member-entry>

</zone>

<zone>



<member-entry>




</member-entry>

</zone>

<zone>



<member-entry>





Broadcom


</member-entry>

</zone>

</Response>

Concurrent Zoning Transactions on a Local SwitchIn this example, assume that there are two FOS API REST clients (R1a and R1b) logged in to the same switch.

FOS API REST client 1a (R1a) opens a zone transaction normally. If FOS API REST client 1b (R1b) also attempts to opena zone transaction, the zone operation attempt from R1b will fail with the following error:<?xml version="1.0"?>

<errors xmlns="urn:ietf:params:xml:ns:yang:ietf-restconf">

<error>

<error-type>protocol</error-type>

<error-tag>Operation-failed</error-tag>

<error-app-tag>Error</error-app-tag>

<error-path>/zone/zone-name/rest1b_zone1/</error-path>

<error-message>There is an outstanding REST transaction, and you are not the owner of that

transaction. (4 mins 48 secs left)

</error-message>

<error-info>


<error-module>zone</error-module>

</error-info>

</error>

</errors>

Because R1a has an open zone transaction and is still logged in, the R1a client transaction will not be disturbed as longas that client is logged in and the session has not reached the 5-minute timeout limit.

Multiswitch Concurrent Transaction CancellationFor this example, assume that there are two switches in a fabric (Switch 1 and Switch 2) and the transaction has beenpending for more than 5 minutes.

1. A FOS API REST client on Switch 1 (Rest_sw1) starts a zone transaction.2. While the transaction is in progress, a CLI user on Switch 2 (CLI_sw2) starts a different zone transaction.3. Subsequently CLI_sw2 commits its zone changes while the Rest_sw1 zone transaction is still open.

As part of the fabric-wide commit of the CLI_sw2 zone transaction, Rest_sw1's zone transaction will be automaticallycancelled.As Rest_sw1 does not have any knowledge of CLI_sw2's commit operation, if Rest_sw1 attempts to perform anotherzone edit operation, Rest_sw1 will receive an error similar to the following notifying Rest_sw1 that their previous zonetransaction was cancelled:<errors xmlns="urn:ietf:params:xml:ns:yang:ietf-restconf">

<error>




<error-path>/zone/zone-name/rest_sw1_zone2/</error-path>

<error-message>Warning: Cannot complete operation due to the current zoning transaction being

aborted (Reason: User Command). Retry prior operation(s) to recover.</error-message>

<error-info>




Broadcom


</error-info>

</error>

</errors>

Simultaneous Multiswitch Zone Transaction CommitmentsFor this example, assume that there are two switches in a fabric (Switch 1 and Switch 2).

1. A FOS API REST client (Rest_sw1) starts a zone transaction on Switch 1.2. A different FOS API REST client (Rest_sw2) starts a zone transaction on Switch 2.3. Both clients the attempt to commit their changes at the same time.

In this case, whichever RESTCONF transaction is processed first would win and go through. In the event of an exacttie, both commits would be rejected and failed. The clients would have to retry, and whoever got their retry attempt infirst would win. The client who loses would have its pending transaction aborted as a result of the winning REST client'scommit operation.

REST Zone Transaction Timer TimeoutFor this example, assume that FOS REST API client 1 is logged in to Switch 1.

1. A FOS REST API client on Switch 1 (Rest_sw1) starts a zone transaction.2. The Rest_sw1 user leaves its zone transaction open with no activity occurring for more than 5 minutes.3. At this point, a CLI user on Switch 1 (CLI_sw1) attempts a zone transaction. Because the Rest_sw1 timer has expired,

the CLI_sw1 transaction is allowed to be opened, and as a result, Rest_sw1's transaction is cancelled.4. If Rest_sw1 later attempts to continue its zone transactions by issuing another zone operation, it will see the following

error:<errors xmlns="urn:ietf:params:xml:ns:yang:ietf-restconf">

<error>




<error-path>/zone/zone-name/rest_sw1_zone2/</error-path>

<error-message>Warning: Cannot complete operation due to the current zoning transaction being

aborted (Reason: User Command). Retry prior operation(s) to recover.</error-message>

<error-info>



</error-info>

</error>

</errors>


Broadcom


ReferencesThis section provides additional information about the FOS REST API and the resource and YANG data models.

REST API DescriptionREpresentational State Transfer (REST) is a style of software architecture for networked applications.

REST is based on the following principles:

• Everything is a resource. These resources are exposed through a universal resource indicator (URI).• Every resource is identified by a unique identifier.• Communication is through simple and uniform interfaces by representation.• Clients can cache the responses. The responses must define themselves as cacheable or not cacheable to prevent

the client from sending inappropriate data in response to further requests.• All interactions are stateless; this means that all the information necessary to service the request must be contained in

the URL, query parameters, body, or headers.

REST itself is not a standard, but it prescribes the use of standards such as HTTP, URL, and XML/HTML. RESTCONFis a REST-like protocol running over HTTP, used to access data defined in YANG (Yet Another Next Generation) modellanguage using datastores defined in the Network Configuration Protocol, or NETCONF (RFC 6241).

ResourcesA resource is an object with a type, associated data, relationships to other resources, and a set of methods that operateon it. A resource has a set of methods such as GET, HEAD, OPTIONS, POST, PATCH, and DELETE are defined for it.Resources can be grouped into collections (in the YANG model, a collection is represented as a “List” statement). Eachcollection is homogeneous (a collection contains only one type of resource) and unordered. Refer to the table below for amore complete description of the methods.

Table 23: Supported FOS REST API Methods

Method Description

DELETE Deletes the specified resource.GET Retrieves the representation of the resource (for example, “base, configuration”) including the

metadata.HEAD Retrieves the metadata of the resource identified in the request. The response to this operation

contains only the headers and an empty response body.OPTIONS Retrieves the allowed methods for the resource identified in the request. The response to this

operation contains the headers and an empty response body. The operations allowed on the resourceare returned in the response “Allow” header.

PATCH Specifies an ordered list of edits to be applied to the target datastore by the RESTCONF server.POST Creates a new resource in the resource location identified by the URI specified in the request. The URI

of the new resource is returned in the response “Location” header.


Broadcom



Base ResourcesBase resource elements represent high-level resources in the system and are categorized by media type.

In the FOS REST API implementation the only defined media type is XML. The XML representation is defined in TheYANG 1.1 Data Modeling Language (RFC 7950), and is supported by the “application/yang-data+xml” media type.

The entry point container in the resource model is “/rest”, and all fields and sub-resources with the same resource type aredefined in the namespace “http://<device_ID>/rest”, where <device_ID> is the IP address for the device. Refer to Loggingin and out for more information on the device ID.

The FOS REST API does not support actions on base resources or on the first-level containers of modules.

Resources and the YANG ModelThree types of resources are supported to represent configuration data and YANG-RPC operations: base resource,configuration resource, and YANG-RPC operations resource.

Resources can exist inside or outside a collection. Resources that are outside a collection are known as singletonresources (in the YANG model, these are represented in “Container” statements). Collections are resources themselves.For example, resources defined in the YANG model are physical interface, switches, zones, and so on.

The following figure illustrates the YANG resource model.

Figure 6: YANG Resource Models

Relationship of YANG and Resource Data ModelsThe resource data model is based on the YANG data model. All top-level containment statements such as “List” and“Container” that are present in the YANG data model are the resources, with a few exceptions.

Table 24: Top-level Containment Statements

Statement Description

List A collection of resources that contains the same type of resources, which are ordered. Entries such as a Containerstatement inside a List statement are also a resource.

Container A singleton resource or a group of resources of different types.Leaf Leaf statements inside a List or Container resource are the attributes of these sources. A Leaf is a subresource of a List or

Container. That is, a Leaf cannot be identified without referencing its parent List or Container resource.

The following diagram illustrates the relationship between YANG and Resource data.


Broadcom

https://datatracker.ietf.org/doc/rfc7950/


Figure 7: YANG and Resource Data Model Relationship

Uniform Resource IdentifiersA uniform resource identifier (URI) is a link used to identify a specific resource. It is the only means for clients and serversto exchange resource representations.

URIs have two parts:

• Base URI—The base URI is specific to the Fabric OS server. All URIs accessing the same server use the same baseURI.

• Request URI—The request URI is the URI used to perform a GET, POST, PATCH, DELETE, HEAD, or OPTIONSoperation.

In this example of a URI, the text in bold is the base URI, and the remaining portion is the request URI:http://10.10.10.122:80/rest/running/brocade-fabric/fabric-switch

Common practice for URI illustration is to compact the base URI as <base_URI>, as shown in the followingexample:<base_URI>/running/brocade-extension-tunnel/

NOTEURIs are case-sensitive.

URI StructureThe hierarchical structure of the URI is used to support those resources defined in the YANG model by the List andContainer statement elements.

The URI path conveys a resource model that is similar to the YANG model, with each forward-slash-separated pathsegment corresponding to a unique resource within the model's hierarchy (using the following syntax: <base_URI>/path1/path2/{key1},{key2}/path3/...). For example, the URI /rest/running/brocade-interface/fibrechannel identifiesthe Fibre Channel interfaces as target resources. In this example, anything in the URI from the path element (“…/brocade-interface”) onward represents YANG model resources.

• rest – The entry point.• running – Represents the running configuration datastore.• brocade-interface – Represents all interfaces present in the running configuration.• fibrechannel – Represents all Fibre Channel interfaces present in the running configuration.


Broadcom


There are some additional restrictions that apply specifically to the FOS REST API. See FOS REST API URI Restrictionsfor details.

URI Encoding

The following rules apply to encoding URI content directly in the request. Encoding is not supported for content in requestbodies.

• A key that contains a forward slash (/) must be encoded as “%2f”. For example, the port value “0/2” is encoded as0%2f2 .

• The delimiter between adjacent keywords in URIs is a comma (,). This is encoded as %2C .• There are other scenarios that could require encoding, for example IPsec policy names support the special characters

such as @, %, and *. For example, an IPsec policy named “ABC%123” would be encoded as: /rest/running/brocade-extension-ipsec-policy/extension-ipsec-policy/policy-name/ABC%25123 , with thepercent symbol encoded as “%25”.

For additional information on HTML URI encoding values, refer to https://en.wikipedia.org/wiki/Percent-encoding.

Base URI

The base URI (https://host:port/rest/) is the entry point to access and manage all resources defined in the system. Theport is the default HTTPS port (443). It is used to identify the base resource and to retrieve the first-level child resourcesthat belong to the base resource.

NOTEA leaf attribute can also be present in a URI to identify the exact resource. For example, the URI <base URI>/rest/running/brocade-interface/fibrechannel/name/<name>/operational-status will identifythe operational-status resource of the specified fibrechannel interface.

Top-Level URIs

The URI identifies the first-level resource in its hierarchy with the media type in its request, for example, <base URI>/config/running .

NOTEThe FOS REST API does not support any methods on top-level URIs. For example, you cannot make anyrequest to <base URI>/rest/running/brocade-zone .

XML Resource RepresentationIn the FOS REST API, a resource is represented in XML as an XML element. Sub-resources are encoded as sub-elements to the resource element.

In the XML representation of a list resource, the keys are always present and encoded first, and leafs are propertiesof the resource. Single-valued resource properties are encoded as sub-elements to the resource element, with thevalue encoded as character data in the sub-element. Refer to the module descriptions elsewhere in this publication forillustrations.

The following example shows the XML representation of the “operational-status” resource for port 0/0. Noticethat it uses “%2f” for the slash character. Request URIGET https://10.10.10.10/rest/running/brocade-interface/fibrechannel/name/0%2f0/operational-status

Request Body No request body is required. Response Body When the operation is successful, the responsehas a message body similar to the following, and a “200 OK” status in the headers.<?xml version="1.0"?>

<Response>


Broadcom

https://en.wikipedia.org/wiki/Percent-encoding


<fibrechannel> <== container resource

<name>0/0</name> <== leaf "name"

<operational-status>3</operational-status> <== leaf "operational-status"

</fibrechannel>

</Response>

The “name” and “operational-status” leafs are sub-elements of the “fibrechannel” resource.

JSON Resource RepresentationThe Fabric OS REST API supports JSON (JavaScript Object Notation) resource representation. For JSON, a resourceis represented as a single top-level object or array. Sub-resources are encoded as sub-elements (arrays objects) to theresource element.

In the JSON representation of a list resource, the keys are always present and encoded first, and leafs are propertiesof the resource. Single-valued resource properties are encoded as sub-elements to the resource element, with thevalue encoded as character data in the sub-element. Refer to the module descriptions elsewhere in this publication forillustrations.

Object: An object can be defined as any structured data with name-value pairs. An object begins and endswith curly braces ({ } ). The name and associated value are separated by a colon (for example, "name":"10:00:c4:f5:7c:16:8e:9a" ) and name-value pairs are separated by a comma. In the example below, a switchobject displays:

{

"Response": {

"fibrechannel-switch": {

"name": "10:00:c4:f5:7c:16:8e:9a",

"domain-name": "englab.brocade.com.",

…

…

"principal": 1,

"ip-address": {

"ip-address": "10.10.10.10"

},

"model": "162.0",

"firmware-version": "v8.2.0_01",

"vf-id": 128,

"fabric-user-friendly-name": "xyz",

"ag-mode": 1

}

}

}

Array: An array is a container object that holds a collection of values. An array begins and ends with square brackets([ ] ). Array elements can be a string, number, object, array, boolean or null.

NOTEIn Fabric OS 8.2.1b, for consistency in the FOS REST API implementation all list URIs are returned using thearray format, which begins and ends with square brackets ([ ]), even if the list only has a single member.

In the example below, “entry-name” displays an array of string elements within “zone” object.

{

"zone": {


Broadcom


"zone-name": "z",

"zone-type": 0,

"member-entry": {

"entry-name": [

"10:00:8c:7c:ff:5e:a3:00",

"20:05:00:11:0d:5b:01:00",

"2c:82:8c:7c:ff:5e:a3:00"

]

}

}

}

}

String: A string is zero or more Unicode character within quotes. In the example below, the string is contain within quotes:

{ "domain-name": "englab.brocade.com." }

Number: A number in JSON must be integer or floating point value. In the example below, "ag-mode" displays as 1.

{ "ag-mode": 1 }

Boolean: A boolean values is either true or false without quotes. In the example below, "is-enabled" displays as true.

{ "is-enabled": true }

Null: A null value can be represented by null or empty quotes ("" ). In the examples below, "sample-name" displays asnull.

{ “sample-name”: null }

{ “sample-name”: “” }

The following example shows the JSON representation of the "name", "domain-id", "fcid", "user-friendly-name", "enabled-state", "up-time", "domain-name", "principal", "ip-address", "model", "firmware-version", "vf-id", "fabric-user-friendly-name", and "ag-mode" as sub-elements of the "fibrechannel-switch" resource (top-level object). Request URIGET https://10.10.10.10/rest/running/brocade-switch/fibrechannel-switch

Request Body No request body is required. Response Body When the operation is successful, the responsehas a message body similar to the following, and a “200 OK” status in the headers.

{

"Response": {

"fibrechannel-switch": {

"name": "10:00:c1:f2:3c:10:4e:5a",

"domain-id": "1",

"fcid": "16776193",

"user-friendly-name": "switch1",

"enabled-state": 2,

"up-time": 4846,

"domain-name": "eng.brcd.com",

"principal": 0,

"ip-address": {

"ip-address": "10.10.10.10"


Broadcom


},

"model": "162.0",

"firmware-version": "v8.2.0_01",

"vf-id": 128,

"fabric-user-friendly-name": "xyz",

"ag-mode": 1

}

}

}

The "name", "domain-id", "fcid", "user-friendly-name", "enabled-state", "up-time", "domain-name", "principal","ip-address", "model", "firmware-version", "vf-id", "fabric-user-friendly-name", and "ag-mode" leafs are sub-elements of the “fibrechannel-switch” resource.

Error ReportingA Brocade-specific ResourceID (XML) is encoded in to the standard RESTCONF “errors” structure, so that it is returnedas part as any failure report. The error type determines the error-path value. Object- and operation-level errors use theroot URI command in the error path, while attribute-level errors return the object name and attribute as part of the errorpath value.

If there is an XML parsing error in the request, the request will return without processing any of the objects in the request.If objects are processed and any errors found, the request will be returned with the object identifier along with keys inthe error-path. You can then identify the exact error path and correct any errors before applying the right payload andresubmitting the request.

The following is the YANG tree diagram for error data:+---- errors

+---- error*

+---- error-type enumeration

+---- error-tag string

+---- error-app-tag? string

+---- error-path? instance-identifier

+---- error-message? string

+---- error-info?

Refer to the sample error logs for details on how different single or multiple errors are returned.


Broadcom


Error Returned Due to Invalid POST RequestThis example shows the error returned when an invalid POST request is made.

URIPOST http://10.10.10.10/rest/running/brocade-fibrechannel-configuration/zone-configuration/node-name-zoning-enabled

Request bodyNo request body is required.Response bodyNotice the error-message and error-info fields. They been rendered in bold for the example; they will not bebold in the actual response.

<?xml version="1.0" ?>


<error>

<error-type>application</error-type>

<error-tag>operation-not-supported</error-tag>


<error-path>/rest/running/brocade-fibrechannel-configuration/zone-configuration/node-name-

zoning-enabled</error-path>

<error-message>Method not supported</error-message>

<error-info>

<error-code>25</error-code>

<error-module>rest</error-module>

</error-info>

</error>

</errors>


Broadcom


Existing IP Address ErrorThis example shows the error returned when a multiple IP address configuration is tried using POST and the IP addressesare already configured.

URIhttp://10.10.10.10/running/brocade-interface/extension-ip-interface

Request Body<extension-ip-interface>

<name>4/0</name>

<dp-id>0</dp-id>





<name>4/0</name>

<dp-id>1</dp-id>




Response BodyNotice the value for the error-message fields. This has been rendered in bold for the example; it will not bebold in the actual response.<?xml version="1.0"?>


<error>




<error-path>/extension-ip-interface/name/4/0/</error-path>

<error-message>IP Address already configured.

IP Address 10.10.0.11 already configured on port 4/ge0. IP interface creation failed.</error-

message>

<error-info>


<error-module>extension-service</error-module>

</error-info>

</error>

<error>




<error-path>/extension-ip-interface/name/4/0/</error-path>

<error-message>IP Address already configured.

IP Address 10.10.0.10 already configured on port 4/ge0. IP interface creation failed.</error-

message>

<error-info>


<error-module>extension-service</error-module>

</error-info>

</error>


Broadcom


</errors>

Unsupported Platform ErrorThis example shows the error returned when a GET request using brocade-interface/gigabitethernet is executed on aplatform that does not support a Gigabit Ethernet interface.

URIhttp://10.10.10.10/rest/running/brocade-interface/gigabitethernet

Request bodyNo request body is required.Response bodyNotice the value for the error-message field. This has been rendered in bold for the example; it will not be boldin the actual response.<?xml version="1.0" ?>


<error>


<error-tag>unknown-element</error-tag>


<error-path>/rest/running/brocade-interface/gigabitethernet</error-path>

<error-message>Invalid resource identifier</error-message>

<error-info>


<error-module>cal</error-module>

</error-info>

</error>

</errors>

Login ErrorsLogin errors (other than a flawed ID/password combination) are usually due to either trying to log in using the HTTPSprotocol when a security certificate is not installed on the switch (or using HTTP when a certificate is installed) or havingan invalid session key.

This example shows the error returned when a request is made that is invalid because the session key is not valid. This isusually because the session has not been correctly logged in to the switch or the session has timed out.

URIhttp://10.10.10.10/rest/login

Request bodyNo request body is required.Response bodyNotice the error-message and error-info fields. They are rendered in bold for the example; they will not be boldin the actual response.

<?xml version="1.0" ?>


<error>


Broadcom



<error-tag>operation-failed</error-tag>


<error-path>/rest/login</error-path>

<error-message>Invalid user in the session key</error-message>

<error-info>


<error-module>auth</error-module>

</error-info>

</error>

</errors>


Broadcom


Revision HistoryFOS-90x-REST-API-RM104; 30 June 2021

• In the brocade-operation-firmwaredownload module, added missing content.• In the brocade-operation-pcie-health module, added missing content.• In the brocade-access-gateway module, added missing content.• In the brocade-chassis module, added missing content.

FOS-90x-REST-API-RM103; 21 May 2021

• In the Logging In and Out topic, added links to the Sample Use Cases section for examples of logging in and out.• In the Generating an Encrypted Authorization Token topic, added information about the custom authorization type

(Custom_Auth ).

FOS-90x-REST-API-RM102; 18 December 2020

• Updated the FOS REST API Version History for the Fabric OS 9.0.1 release.• Updated the Deprecated and Obsolete Resources.• In the Additional FOS REST API Data Types section, added the ldap-tls-mode-type in Security Module Data Types.

Edited the serial-number-type in FRU Module Data Types. Edited the maps-types:maps-data-unit, maps-monitoring-system-type, threshold-value-type, and maps-group-feature-type in MAPS Module Data Types.

• In the brocade-interface/fibrechannel module, added the neighbor-port-index and neighbor-switch-user-friendly-name parameters. Edited the speed, max-speed, mirror-port-enabled, credit-recovery-enabled, credit-recovery-active,fec-active, npiv-flogi-logout-enabled, neighbor-switch-ipv4-address, neighbor-switch-ipv6-address, fec-enabled,reserved-buffers, average-transmit-buffer-usage, average-transmit-frame-size, average-receive-buffer-usage, average-receive-frame-size, current-buffer-usage, recommended-buffers, areas, le-domain, port-peer-beacon-enabled, clean-address-enabled, and segmentation-reason parameters.

• In the brocade-logging module, added the port parameter to the supportftp list.• In the brocade-maps module, added the loss-of-sync parameter to the dashboard-history list. Edited the member

(paused-cfg), group-feature, member (group), recipient-address-list, sender-address, domain-name, event-severity,quiet-time, minimum-quiet-time, dashboard-rule, and triggered-count parameters. Deprecated the port-loss parameter(use loss-of-sync).

• In the brocade-security module, added the tls-mode parameter. Edited the fingerprint parameter.• In the brocade-zone module, edited the transaction-token parameter.• In the brocade-extension-tunnel module, edited the distribution-value parameter.

FOS-90x-REST-API-RM101; 23 June 2020

• Updated the Standards and Related References.• Updated the FOS REST API Version History.• In the brocade-operation-license module, added the license-payload parameter.• In the brocade-license module, added the license-payload parameter and updated the active-firmware-version and

target-firmware-version parameters.• In the brocade-maps module, updated the dashboard-rule parameter description.

FOS-90x-REST-API-RM100; 30 April 2020

• Updated the Deprecated and Obsolete Resources.• Added the following new Operations modules:


Broadcom


– brocade-operation-device-management– brocade-operation-extension– brocade-operation-fabric– brocade-operation-firmwaredownload– brocade-operation-license– brocade-operation-lldp– brocade-operation-pcie-health– brocade-operation-supportlink– brocade-operation-zone

• In the brocade-operation-show-status module, added the firmware download status and EULA text parameters.• In the brocade-operation-supportsave module, added the firmware download status, serial-mode, and EULA text

parameters.• Added the following new modules to the Fibre Channel features:

– brocade-fabric-traffic-controller– brocade-fibrechannel-routing– brocade-ficon– brocade-supportlink

• In the brocade-access-gateway module, added the preferred-f-ports parameter to the n-port-map list.• In the brocade-chassis module, added the license-id, serial-number, fcr-enabled, and fcr-supported parameters.

Deprecated the following parameters: part-number (use brocade-fru/wwn/part-number instead), vendor-serial-number(use brocade-fru/wwn/vendor-serial-number instead), vendor-part-number (use brocade-fru/wwn/vendor-part-numberinstead), and vendor-revision-number (use brocade-fru/wwn/vendor-revision-number instead).

• In the brocade-fabric module, added the access-gateway parameters. Deprecated the following parameter: path-count(use the path-count parameter from the /brocadefibrechannel/topology-domain list instead).

• In the brocade-fdmi module, added the vsa-end-to-end-version parameter to the port list.• In the brocade-fibrechannel-configuration module, added the fabric-lock-timeout parameter to the zone-configuration

container, the chassis-config-settings container, and the principal-selection-enabled and principal-priority parameters tothe fabric container.

• In the brocade-fibrechannel-diagnostics module, added the remote-switch-wwn and remote-port-index parameters tothe 'brocade-fibrechannel-diagnostics' container; added the start-time and estimate-time parameters to the electrical-loopback-test, optical-loopback-test, and link-traffic- test containers; and added the failure-report-local-errors andfailure-report-remote-errors containers to the failure-report container.

• In the brocade-fibrechannel-switch module, added the the in-order-delivery-enabled, dynamic-load-sharing, advanced-performance-tuning-policy, lacp-system-priority, and lacp-system-macaddress parameters to the fibrechannel-switchcontainer and added the topology-domain and topology-route containers.

• In the brocade-fru module, added the temperature-sensor-supported parameter to the power-supply list and added thehistory-log, sensor, and wwn lists.

• In the brocade-interface/fibrechannel module, added new parameters to the brocade-interface/fibrechannel container.• In the brocade-license module, added the end-user-license-agreement and ports-on-demand-license-info containers.• In the brocade-logging module, added the supportftp, audit-log, and error-log lists.• In the brocade-maps module, added the marginal-sfp-health, trusted-fos-cert-health, quiet-time, f-port-fpi-profile, and e-

port-fpi-profile parameters; added the credit-stall-dashboard, oversubscription-dashboard, fpi-profile, and dashboard-history lists.

• In the brocade-security module, added the auth-token-present parameter, the https-tlsv13-cipher parameter, thekeypair-tag parameter, the ca-certificate parameter, the sshutil-known-host list, and the security-certificate-extensionlist.

• In the brocade-zone module, added the zone-type-string parameter and the fabric-lock container.• Added the following new modules to the Extension features:


Broadcom


– brocade-extension– brocade-interface/portchannel

• In the brocade-interface/extension-ip-interface module, added new parameters to the brocade-interface/extension-ip-interface container and the name parameter was modified to support configuration and management of LAN IPinterfaces.

• In the brocade-extension-ip-route module, updated the name parameter to support LAN IP routes for hybrid APPmode.

• In the brocade-extension-tunnel module, added the local-hcl-in-progress, remote-hcl-in-progress, fc-hastatus, ip-ha-status, and last-error to the extension-tunnel-statistics list. This API call was also modified to add the circuit-qos-statistics and wan-statistics lists.

• In the brocade-interface/gigabitethernet module, added the protocol, auto-negotiation-enabled, portchannel-name,portchannel-member-timeout, lldp-profile, lldp-enabled-state, and extension-vlans parameters to the gigabitethernetlist.

• In Sample Use Cases, added Creating a New Zone Using REST and Adding Additional Zone Members to an ExistingZone.


Broadcom