53-1003248-01 31 July 2014 Brocade Virtual ADX XML API Programmer’s Guide Supporting Brocade Virtual ADX version 03.1.
© 2014 Brocade Communications Systems, Inc. All Rights Reserved. Brocade, the B-wing symbol, Brocade Assurance, ADX, AnyIO, DCX, Fabric OS, FastIron, HyperEdge, ICX, MLX, MyBrocade, NetIron, OpenScript, VCS, VDX, and Vyatta are registered trademarks, and The Effortless Network and the On-Demand Data Center are trademarks of Brocade Communications Systems, Inc., in the United States and in other countries. Other brands and product names mentioned may be trademarks of others.
Contents Preface Document conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii Text formatting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii Command syntax conventions . . . . . . . . . . . . . . . . . . . . . . . . . . viii Notes, cautions, and warnings . . . . . . . . . . . . . . . . . . . . . . . . . . viii Brocade resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 4 Network API Reference Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .173 Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .173 Network Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .173 Routing Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .209 Data structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Appendix A Error Messages List of Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .731 Appendix B API Examples Example: Adding and binding a real server and a VIP . . . . . . . . . .813 Perl example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .813 Java Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .819 C# example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
vi Brocade Virtual ADX XML API Programmer’s Guide 53-1003248-01
Preface Document conventions This section describes text formatting conventions and important notice formats that may be used in this document. Text formatting The following text formatting conventions may be used in the flow of the text to highlight specific words or phrases.
Command syntax conventions Convention Description bold text Identifies command names, keywords, and command options. italic text Identifies variables. [] Syntax components displayed within square brackets are optional. { x | y |z } A choice of required parameters is enclosed in curly braces separated byvertical bars. You must select one. x|y A vertical bar separates mutually exclusive elements. <> Nonprinting characters, for example, passwords, are enclosed in angle brackets. ...
Brocade resources To get up-to-the-minute information, go to http://my.brocade.com to register at no cost for a user ID and password. Release notes are available at http://my.brocade.com. White papers, online demonstrations, and data sheets are available through the Brocade website at: http://www.brocade.com/products-solutions/products/index.page Select Application Delivery Switches on this page to navigate to the relevant product information.
Document feedback • For questions regarding service levels and response times, contact your OEM/Solution Provider. Document feedback Quality is our first concern at Brocade and we have made every effort to ensure the accuracy and completeness of this document. However, if you find an error or an omission, or you think that a topic needs further development, we want to hear from you. You can provide feedback in two ways: • Through the online feedback form in the HTML documents posted on http://www.
Chapter 1 WSDL Programming In this chapter • Programmatic interface to Brocade Virtual ADX : XML APIs . . . . . . . . . . . . . . • Purpose of the WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . • XML SOAP interface overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . • WSDL location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . • Accessing the client API using SOAP . . . . .
1 Purpose of the WSDL The following diagram is a pictorial description of the XML API framework. FIGURE 1 XML API Framework Purpose of the WSDL Simple Object Access Protocol Web Service Definition Language (Application Programming Interface) XML SOAP interface overview An XML SOAP interface for Brocade Virtual ADX application delivery controllers gives application administrators a programmatic way to access and manage ADX platforms through published APIs.
WSDL location 1 Users have access to documented input and output characteristics for each XML SOAP method, the data types, and their values in a platform-independent way. The platform independence is achieved through use of XML (SOAP over HTTP) as the medium for information exchange. One major advantage of the XML-API is significant improvement in latency for accessing information from your ADX devices.
1 Creating client-specific APIs from client stubs 4. Bind the real server to the virtual server. 5. Save the configuration. Each request is authenticated independently. Refer to “Example: Adding and binding a real server and a VIP” for examples in Perl, Java, and C#. Unbinding a real server from a VIP 1. Unbind a previously added real server from the virtual server. 2. Remove the real server and the virtual server. 3. Save the configuration.
Creating client-specific APIs from client stubs 1 The following output results from the execution of the "getChassisInfo.pl" script: C:\>getChassisInfo.pl Chassis Model Chassis Serial : SI-1216-4-PREM : E2SA02F038 The contents of the “getChassisInfo.pl” script are as follows: use SOAP::Lite; my $soap = SOAP::Lite -> uri('urn:webserviceapi') -> proxy('http://username:password@10.24.140.
1 Enabling a web service on a Brocade Virtual ADX Response resp = call.invoke(url, ""); if (resp.generatedFault ( )) { Fault fault = resp.getFault ( ); System.out.println ("\nOuch, the call failed: "); System.out.println (" Fault Code = " + fault.getFaultCode ( )); System.out.println (" Fault String = " + fault.getFaultString ( )); } else { Parameter result = resp.getReturnValue ( ); System.out.print(result.getValue ( )); System.out.
Chapter 2 Using the XML API In this chapter • API operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 • API naming conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 • Request and response XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
2 API naming conventions TABLE 1 API operations Basic API operations Description Example getAll These APIs are used to obtain the configuration and statistics of more getAllIPSubnetVlans than one object. The Brocade Virtual ADX device has a maximum number of objects that can be returned on the buffer. The resultant number of objects could be less then the total number of objects available on the Brocade Virtual ADX device.
Chapter 3 System API Reference In this chapter • Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 • Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 • Data structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 • Enumerations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
3 Methods getActiveTransitions Description Retrieves the number of active transitions. Parameters None Return value Table 2 contains the return value of the method. TABLE 2 Return value Name Type Description active unsignedInt Number of active transitions. . Error messages List of Error Messages getARP Description Retrieves the Address Resolution Protocol (ARP) information. Parameters Table 3 contains the parameters required for the method.
Methods 3 getAsmState Description Retrieves the state of the Application Switch Module (ASM) module. Parameters Table 5 contains the parameters required for the method. TABLE 5 Parameters Name Type Presence module unsignedInt Mandatory Rules Description Specifies the ASM module number. Return value Table 6 contains the return value of the method. TABLE 6 Return value Name Type Description state AsmState Specifies the ASM state.
3 Methods Return value Table 8 contains the return value of the method. TABLE 8 Return value Name Type Description genericInfo ResponseInformation Generic information modCpuUtil cpuUtil[ ] Returns the available and used memory space in the management and barrel processors. Error messages List of Error Messages getDNSName Description Retrieves the Domain Name System (DNS) name. Return value Table 9 contains the return value of the method.
Methods 3 getHostName Description Retrieves the hostname. Return value Table 11 contains the return value of the method. TABLE 11 Return value Name Type Description genericInfo ResponseInformation Generic information name string Returns the hostname of the device. Error messages List of Error Messages getRAM Description Retrieves the RAM information. Return value Table 12 contains the return value of the method.
3 Methods getSIFeatureStatus Description Retrieves the status of a feature or features on an ADX device. Parameters TABLE 14 Parameters . Name Type Presence featureList featureEnum[ ] Mandatory Rules Description Specifies one or more ADX feature names. Return value TABLE 15 Return value Name Type Description featureList FeatureStatus[ ] Specifies the status of one or more ADX features.
Methods 3 Return value Table 17 contains the return value of the method. TABLE 17 Return value Name Type Description config string Identifies the configuration information for the system. Error messages List of Error Messages getSystemClock Description Retrieves the details of the system clock. Return value Table 18 contains the return value of the method. TABLE 18 Return value Name Type Description clock SystemClock Specifies the clock detail.
3 Methods Parameters Table 20 contains the parameters required for the method. TABLE 20 Parameters Name Type fileName string startLineNumber unsignedInt numLines unsignedInt Presence Rules Description Identifies the file name. Identifies the number of lines in a file. Return value Table 21 contains the return value of the method.
Methods 3 Parameters Table 23 contains the parameters required for the method. TABLE 23 Parameters Name Type Presence cmds string[] Optional Rules Description Identifies the commands executed through the CLI. Return value Table 24 contains the return value of the method. TABLE 24 Return value Name Type Description genericInfo ResponseInformation Generic information result string Returns the corresponding output of the commands executed through the CLI.
3 Methods Error messages List of Error Messages setModuleThresholdTemperatureConfig Description Sets the threshold temperature. Parameters Table 27 contains the parameters required for the method. TABLE 27 Parameters Name Type Presence temperatureConfig ModuleThresholdTemperatureConfiguration Rules Description Error messages List of Error Messages setReloadConfig Description Sets the reload configuration. Parameters Table 28 contains the parameters required for the method.
Methods 3 System - High Availability Description High Availability refers to a system or component that is continuously operational for a long time without failing. The following APIs configure High Availability system functions on the Brocade Virtual ADX. addHABackupPort Description Adds a backup port in the hot standby mode. Parameters Table 30 contains the parameters required for the method.
3 Methods Parameters Table 32 contains the parameters required for the method. TABLE 32 Parameters Name Type Presence attribute haNodeAttributeEnum[ ] Optional Rules Description Identifies the configuration information for the backup server. Error messages List of Error Messages createVipGroup Description Creates the VIP group and add it to VRID configuration. Parameters Table 33 contains the parameters required for the method.
Methods 3 Parameters Table 35 contains the parameters required for the method. TABLE 35 Parameters Name Type Presence routerPort HARouterPort[ ] Optional Rules Description Identifies the physical Ethernet port to be deleted from the router port list of the HA node. Error messages List of Error Messages deleteVipGroup Description Delete a VIP group. Parameters Table 36 contains the parameters required for the method.
3 Methods Error messages List of Error Messages getHABackupNodeConfiguration Description Retrieves the backup server configuration information. Return value Table 39 contains the return value of the method. TABLE 39 Return value Name Type Description backupNodeConfig HABackupNodeConfiguration Identifies the configuration information for the backup server.
Methods 3 getHaNodeStatus Description Retrieves the High Availability (HA) status of the device. Return value Table 42 contains the return value of the method.
3 Methods Parameters Table 44 contains the parameters required for the method. TABLE 44 Parameters Name Type Presence vip Server Optional Rules Description Identifies the name and IP address of the virtual server for which the high availability status is obtained. Return value Table 45 contains the return value of the method.
Methods 3 setHABackupNodeConfiguration Description Sets the backup port configuration. Parameters Table 48 contains the parameters required for the method. TABLE 48 Parameters Name Type Presence backupNodeConfig HABackupNodeConfiguration Optional Rules Description Identifies the configuration information for the backup server. Error messages List of Error Messages updateVipGroup Description Update any configuration associated with VIP groups.
3 Methods • • • • • TFTP server management USB operations System defaults Banner Messages AAA configuration addRadiusServersWithConfiguration Description This method adds one or more RADIUS servers. Parameters Table 50 contains the parameters required for the method. TABLE 50 Name Parameters Type serverList RadiusServerConfiguration[ ] Presence Rules Description Mandatory Maximum 8 RADIUS servers allowed. Specifies one or more RADIUS servers information.
Methods 3 Parameters Table 52 contains the parameters required for the method. TABLE 52 Parameters Name Type Presence commStrList SnmpServerCommStrConfig[ ] Mandatory Rules Description Specifies one or more SNMP community strings. Error messages List of Error Messages addSnmpGroups Description This method adds one or more SNMP groups. Parameters Table 53 contains the parameters required for the method.
3 Methods Parameters Table 55 contains the parameters required for the method. TABLE 55 Name Parameters Type Presence userList Snmpv3UserAuthSecurity[ ] Rules Mandatory Description Specifies one or more SNMPv3 users configuration information. Error messages List of Error Messages addSnmpViews Description This method adds one or more SNMP views with configuration information. Parameters Table 56 contains the parameters required for the method.
Methods 3 addTelnetClients Description This method adds one or more Telnet clients. Restricting Telnet access to the specific Clients. Parameters Table 58 contains the parameters required for the method. TABLE 58 Parameters Name Type Presence Rules Description clientList TelnetClient[ ] Mandatory Maximum of 64 Telnet clients allowed. Specifies the configuration information for one or more Telnet clients.
3 Methods Parameters Table 60 contains the parameters required for the method. TABLE 60 Parameters Name Type Presence paramList bannerMessageTypeEnum [ ] Mandatory Rules Description Specifies one or more banner message type parameters. Error messages List of Error Messages clearConfigSyncConfig Clear config-sync sender and receiver configuration. Parameters None. Return values None.
Methods 3 Parameters Table 62 contains the parameters required for the method. TABLE 62 Parameters Name Type Presence paramList snmpServerGlobalConfigParametersEnum[ ] Mandatory Rules Description Specifies one or more SNMP server configuration parameters. Error messages List of Error Messages clearSnmpStats Description This method clears the SNMP statistics. Return values None. Error messages List of Error Messages.
3 Methods Parameters Table 64 contains the parameters required for the method. TABLE 64 Parameters Name Type Presence paramList tacacsServerGlobalConfigParametersEnum[ ] Mandatory Rules Description Specifies one or more TACACS configuration parameters. Error messages List of Error Messages clearTelnetServerGlobalConfiguration Description This method clears one or more Telnet server configuration parameters. Return values Table 65 contains the return values of the method.
Methods 3 Parameters TABLE 66 Parameters Parameters Type Presence Rules Description operationType configSyncOperationEnum Mandatory Config-sync operation type to be initiated. isForced boolean Optional Skips the peer compatibility checks, when value of this parameter is set to TRUE. Return values None. Error messages List of Error Messages createDirectories Description This method creates new directories on the USB drive or code flash.
3 Methods Error messages List of Error Messages deleteRadiusServers Description This method deletes one or more RADIUS servers. Parameters Table 69 contains the parameters required for the method. TABLE 69 Parameters Name Type Presence Rules Description ips string[ ] Mandatory Maximum 8 RADIUS servers allowed. Specifies one or more RADIUS server IP addresses for deletion Error messages List of Error Messages deleteSnmpClients Description This method deletes one or more SNMP IPv4 clients.
Methods 3 Error messages List of Error Messages deleteSnmpGroups Description This method deletes one or more SNMP groups. Return values Table 72 contains the return values of the method. TABLE 72 Return values Name Type Description groupList SnmpGroupConfig[ ] Specifies one or more SNMP group names for deletion. Error messages List of Error Messages deleteSnmpTrapReceivers Removes one or more configured SNMP trap receivers. Parameters Table 73 contains the parameters required for the method.
3 Methods deleteSnmpViews Description This method deletes one or more SNMP views with configuration information. Parameters Table 75 contains the parameters required for the method. TABLE 75 Parameters Name Type Presence Rules Description viewNames SnmpViewConfig[ ] Mandatory Maximum of only 8 SNMP views can be deleted. The parameter “viewType” is optional. Specifies one or more SNMP view names for deletion.
Methods 3 Error messages List of Error Messages disableSnmpAccessOnPorts Description This method disables one or more Ethernet ports for SNMP access. Parameters Table 78 contains the parameters required for the method. TABLE 78 Parameters Name Type Presence Rules Description ports PortList Mandatory Only Ethernet port numbers are allowed. Specifies one or more Ethernet port numbers.
3 Methods Error messages List of Error Messages enableSnmpTraps Description This method enables one or more SNMP traps. Parameters Table 81 contains the parameters required for the method. TABLE 81 Parameters Name Type Presence trapList snmpTrapsEnum[ ] Mandatory Rules Description Specifies one or more SNMP traps. Error messages List of Error Messages generateCryptoRandomNumberSeed() Description This method creates a seed for generating a random number.
Methods 3 Parameters Table 82 contains the parameters required for the method. TABLE 82 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional Sets the start index for retrieving the files and/or directories. When both startIndex and numRetrieved parameters are not present, then all the possible files and/or directories are returned. numRetrieved unsignedInt Optional Specifies the number of files and/or directories to be retrieved.
3 Methods Return values Table 85 contains the return values of the method. TABLE 85 Return values Name Type Description genericInfo ResponseInformation Generic information. This provides the information - total entries available and the time at which the values are retrieved. serverList RadiusServerConfiguration[ ] Retrieves all the configured RADIUS servers. Error messages List of Error Messages getAllSnmpClients Description This method retrieves all the configured SNMP clients.
Methods 3 getAllSnmpCommunityStrings Description This method retrieves all the configured SNMP community strings. Parameters Table 88 contains the parameters required for the method. TABLE 88 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional Sets the start index for retrieving the configured SNMP clients. When both startIndex and numRetrieved parameters are not present, then all the possible configured SNMP clients will be returned.
3 Methods Parameters Table 90 contains the parameters required for the method. TABLE 90 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional Sets the start index for retrieving the SNMP groups. When both startIndex and numRetrieved parameters are not present, then all the possible SNMP groups will be returned. numRetrieved unsignedInt Optional Specifies the number of SNMP groups to be retrieved. The maximum value allowed is 64.
Methods 3 Return values Table 93 contains the return values of the method. TABLE 93 Name Return values Type Description genericInfo ResponseInformation This provides the total entries available and the time at which the values are retrieved. serverList Retrieves all the configured TACACS servers. TacacsServerConfiguration[ ] Error messages List of Error Messages getAllSnmpTrapReceivers Description This method retrieves all the configured SNMP trap receivers.
3 Methods getAllSnmpv3Users Description This method retrieves all the configured SNMPv3 users. Parameters Table 96 contains the parameters required for the method. TABLE 96 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional Sets the start index for retrieving the SNMPv3 users. When both the startIndex and the numRetrieved parameters are not present, then all the possible SNMPv3 users will be returned.
Methods TABLE 98 3 Parameters Name Type Presence Rules Description numRetrieved unsignedInt Optional Specifies the number of SNMP views to be retrieved. The maximum value allowed is 64. When both startIndex and numRetrieved parameters are not present, then all possible SNMP views will be returned. Filter SnmpViewFilter Optional Filter criteria. Return values Table 99 contains the return values of the method.
3 Methods Return values Table 101 contains the return values of the method. TABLE 101 Return values Name Type Description genericInfo ResponseInformation Generic information. This provides the information - total entries available and the time at which the values are retrieved. connectionList SshServerConnection[ ] Retrieves all the established SSH connections information.
Methods 3 getAAAConfiguration Description This method retrieves the AAA configuration. Return values Table 104 contains the return values of the method. TABLE 104 Return values Name Type Description authenticationConfig AuthenticationConfiguration Retrieves the Authentication configuration. authorizationConfig AuthorizationConfiguration Retrieves the Authorization configuration. accountingConfig AccountingConfiguration Retrieves the Accounting configuration.
3 Methods Return values TABLE 106 Return values Parameters Type Description config ConfigSyncConfiguration Config-sync configuration. Error messages List of Error Messages getConfigSyncStatus Get config-sync status. Parameters TABLE 107 . Parameters Name Type Presence initiateRetrieval boolean Optional Rules Description Retrieving the config-sync status is an asynchronous action, as communication happens between sender and receiver.
Methods 3 Parameters Table 109 contains the parameters required for the method. TABLE 109 Parameters Name Type Presence location driveLocationEnum directoryPath string Rules Optional Description Specifies the relative directory path. For example, specifying a directory path under USB0. Return values Table 110 contains the return values of the method.
3 Methods Return values Table 112 contains the return values of the method. TABLE 112 Return values Name Type Description config RadiusServerGlobalConfiguration Retrieves the existing RADIUS server configuration. Error messages List of Error Messages getRadiusServersConfiguration Description This method retrieves one or more configured RADIUS servers. Parameters Table 113 contains the parameters required for the method.
Methods 3 Return values Table 116 contains the return values of the method. TABLE 116 Return values Name Type Description statusList SnmpAccessPortStatus[ ] Retrieves the SNMP access status of one or more Ethernet ports. Error messages List of Error Messages getSnmpClients Description This method retrieves the configured SNMP clients. Parameters Table 117 contains the parameters required for the method.
3 Methods Return values Table 120 contains the return values of the method. TABLE 120 Name Parameters Type Description commStrList SnmpServerCommStrConfig[ ] Retrieves one or more configured SNMP community strings. Error messages List of Error Messages getSnmpGroups Description This method retrieves the configured SNMP groups. Parameters Table 121 contains the parameters required for the method.
Methods 3 getSnmpStats Description This method retrieves the SNMP statistics. Return values Table 124 contains the return values of the method. TABLE 124 Return values Name Type Description statistics SnmpStats Retrieves the SNMP statistics information. Error messages List of Error Messages. getSnmpTrapReceivers Description This method retrieves the configured SNMP trap receivers. Parameters Table 125 contains the parameters required for the method.
3 Methods Parameters Table 127 contains the parameters required for the method. TABLE 127 Parameters Name Type Presence trapList snmpTrapsEnum[ ] Mandatory Rules Description Specifies one or more SNMP traps. Return values Table 128 contains the return values of the method. TABLE 128 Return values Name Type Description statusList SnmpTrapStatus[ ] Contains the SNMP traps status information.
Methods 3 Parameters Table 131 contains the parameters required for the method. TABLE 131 Parameters Name Type Presence viewNames string[ ] Mandatory Rules Description Specifies one or more configured SNMP view names. Return values Table 132 contains the return values of the method. TABLE 132 Return values Name Type Description viewList SnmpViewConfig[ ] Retrieves one or more SNMP views configuration information.
3 Methods Return values Table 135 contains the return values of the method. TABLE 135 Return values Name Type Description config SshServerGlobalConfiguration Retrieves the existing SSH Server configuration. Parameters None. Error messages List of Error Messages getSystemDefaultValues Description This method retrieves all the system default configuration information. Return values Table 136 contains the return values of the method.
Methods 3 Return values Table 138 contains the return values of the method. TABLE 138 Name Return values Type Description config TacacsServerGlobalConfiguration Retrieves the existing TACACS server configuration. Error messages List of Error Messages getTacacsServersConfiguration Description This method retrieves one or more configured TACACS servers. Parameters Table 139 contains the parameters required for the method.
3 Methods Return values Table 142 contains the return values of the method. TABLE 142 Return values Name Type Description clientList TelnetClient[ ] Retrieves one or more configured Telnet clients information. Error messages List of Error Messages getTelnetServerGlobalConfiguration Description This method retrieves the existing Telnet server configuration. Return values Table 143 contains the return values of the method.
Methods 3 Parameters Table 145 contains the parameters required for the method. TABLE 145 Parameters Name Type Presence Rules Description location driveLocationEnum Mandatory Specifies the drive information such as code flash, USB0, or USB1. fileName string Mandatory Specifies the old or current file name. newFileName string Mandatory Specifies the new file name. Error messages List of Error Messages setAAAConfiguration Description This method sets the AAA configuration.
3 Methods Error messages List of Error Messages setConfigSyncConfig Sets config-sync sender or receiver configuration. Parameters Table 148 contains the parameters required for the method. TABLE 148 Parameters Parameters Type Presence config ConfigSyncConfiguration Mandatory Rules Description Config-sync configuration. Return values None. Error messages List of Error Messages setRadiusServerGlobalConfiguration Description This method sets the RADIUS server global configuration.
Methods 3 Parameters Table 150 contains the parameters required for the method. TABLE 150 Parameters Name Type Presence Rules Description serverList RadiusServerConfiguration[ ] Mandatory Allowed parameters for set are “authenticationPort”, “accountingPort”, “serverRole”, “key” and “isEncryption”. Maximum 8 RADIUS servers allowed. Specifies one or more RADIUS servers for updation.
3 Methods setTacacsServerGlobalConfiguration Description This method sets the TACACS server global configuration. Parameters Table 153 contains the parameters required for the method. TABLE 153 Parameters Name Type Presence config TacacsServerGlobalConfiguration Mandatory Rules Description Specifies the TACACS server configuration. Error messages List of Error Messages setTacacsServersConfiguration Description This method sets one or more existing TACACS configuration.
Methods 3 Error messages List of Error Messages setVlanOnTftp Description This method enables the access restriction of TFTP on a VLAN. Return values Table 156 contains the return values of the method. TABLE 156 Return values Name Type Description vlan unsignedInt Specifies a VLAN ID from which TFTP is accessible. Error messages List of Error Messages updateAAAConfiguration Description This method updates the AAA configuration.
3 Methods Parameters Table 158 contains the parameters required for the method. TABLE 158 Parameters Name Type Presence Rules message BannerMessage Mandatory Description Specifies the banner message. Error messages List of Error Messages updateRadiusServerGlobalConfiguration Description This method updates the existing RADIUS server global configuration. Parameters Table 159 contains the parameters required for the method.
Methods 3 Parameters Table 161 contains the parameters required for the method. TABLE 161 Parameters Name Type Presence config SnmpServerGlobalConfiguration Mandatory Rules Description Specifies the SNMP server configuration. Error messages List of Error Messages updateSshServerGlobalConfiguration Description This method updates the existing SSH server configuration. Parameters Table 162 contains the parameters required for the method.
3 Methods Parameters Table 164 contains the parameters required for the method. TABLE 164 Parameters Name Type Presence Rules config TelnetServerGlobalConfiguration Mandatory Description Specifies the Telnet server configuration. Error messages List of Error Messages Role Based Management Description The Role Based Management (RBM) APIs allows user to create different administrative domains and enable user-based access privileges for XML APIs.
Methods 3 Parameters Table 166 contains the parameters required for the method. TABLE 166 Parameters Name Type Presence Rules Description usernames string[ ] Mandatory Identifies the usernames. roleTemplateNames string Mandatory Identifies the role template names. Return values Not applicable. Error messages List of Error Messages createContext Description Creates one or more contexts on the system. This request takes array of contexts as input.
3 Methods Error messages List of Error Messages createUser Description Creates one or more users with the given user specific information such as username, type of user, and password etc. If the operation fails in the middle, it returns an appropriate error message and terminates the operation, rollback is not supported. Parameters Table 169 contains the parameters required for the method.
Methods 3 Return values Not applicable. Error messages List of Error Messages deleteRoleTemplate Description Deletes one or more role templates on the system. Parameters Table 171 contains the parameters required for the method. TABLE 171 Parameters Name Type Presence roleTemplateNames string[ ] Optional Rules Description Identifies the names of the role template. Return values Not applicable.
3 Methods Parameters Table 173 contains the parameters required for the method. TABLE 173 Parameters Name Type Presence enablePasswordAging boolean Optional Rules Description Boolean to identify if password aging is required. Return values None. Error messages List of Error Messages getAllContexts Description Retrieves all the contexts configured on the system. Total number of contexts added as part of the response header field "totalEntriesAvailable".
Methods 3 getAllRoleTemplates Description Retrieves all the role templates configured on the system. Total number of templates filed added as part of the response header (field “total Entries Available”). Returns all the role templates configured on the device, if ‘startIndex’ and ‘numRetrieved’ values are zero. Parameters Table 176 contains the parameters required for the method.
3 Methods TABLE 178 Parameters Name Type Presence Rules numRetrieved unsignedInt Optional Any positive integer value 1 through 1024. Specifies the number of contexts to retrieve. Maximum value allowed is 32. filter UserFilter Filter type (user type or context) Identifies the filtering criteria based on which the users will be retrieved. Optional Description Return values Table 179 contains the return values of the method.
Methods 3 Parameters Table 182 contains the parameters required for the method. TABLE 182 Parameters Name Type Presence roleTemplateName string Optional Rules Description Identifies the name of the role template. Return values Table 183 contains the return values of the method. TABLE 183 Return values Name Type Description genericInfo ResponseInformation Identifies the generic information about the role template.
3 Methods Return values Table 186 contains the return values of the method TABLE 186 Return values Name Type Description status boolean Status of user password aging. Error messages List of Error Messages updateRoleTemplate Description Updates one or more existing role templates on the system with the given template parameters. This operation performs the full update. If the update fails in the middle, there is no rollback mechanism to revert the changes.
Methods 3 Error messages List of Error Messages Config Template basic operations Description Config Template basic operations provides a set of operations to add, execute, validate, and upload the Config Templates in the following template storage areas as expressed by an enumeration.
3 Methods TABLE 190 addInputToTemplateFile return values Name Type Description overallRe sult templateResultTypeEnum The overall result of the operation. result TemplateSummaryFilter[ ] Returns a collection of messages about the template operation results. Error messages List of Error Messages addTemplate Description Creates a new template with directly-provided content. Parameters Table 191 contains the parameters for this method.
Methods 3 deleteTemplate Description Deletes a template file from an ADX template storage area. Parameters Table 192 contains the parameters for this method. TABLE 192 deleteTemplate parameters Parameter Type Presence Rules Description name string Mandatory Must match the DOS 8.3 filename format. The file name of the template. area templateStorageAreaEnum Mandatory "ALL_AREAS" and "PRE_DEFINED_ARE A" are not allowed. The storage area where the template is found. Return values None.
3 Methods TABLE 193 executeTemplateContent parameters (Continued) Parameter Type Presence Rules Description saveRunningConfig boolean Optional If true, the resulting running configuration is saved after the template execution is completed, but only if no errors have occurred. Save the running configuration to the startup configuration on the Brocade Virtual ADX.
Methods TABLE 194 3 executeTemplateFile parameters (Continued) Parameter Type Presence Rules Description saveRunningConfig boolean Optional If true, the resulting running configuration is saved after the template execution is completed, but only if no errors have occurred. Save the running configuration to the startup configuration on the Brocade Virtual ADX.
3 Methods TABLE 195 getAllTemplateSummary parameters (Continued) Parameter Type Presence Rules Description numRetrieved unsignedInt Optional Specifies the number of templates to be retrieved. When both startIndex and numRetrieved parameters are not present, then all possible templates will be returned. filter TemplateSummaryFilter Optional Filter criteria. Return value Table 196 contains the return values for this method.
Methods TABLE 197 3 getTemplate parameters Parameter Type Presence Rules Description startByteIndex unsignedInt Optional Retrieves the template content from the specified startByte index position. numberOfBytes unsignedInt Optional Retrieves the specified number of bytes from the template content. Return value Table 198 contains the return value for this method.
3 Methods getTemplateValidationStatus Description Retrieves the template validation operation status and list of errors or warnings, if any. Parameters None. Return values Table 200 contains the return values for this method. TABLE 200 Return values Name Type Description status templateOperationStatusEnum overallResult templateResultTypeEnum The overall result of the operation. Result TemplateOperationResult[ ] Returns a collection of messages about the validation results.
Methods 3 Error messages List of Error Messages getUploadTemplateStatus Description Retrieves the status of the template TFTP upload operation. Parameters Table 203 contains the parameters for this method. TABLE 203 Parameters Parameter Type Presence token unsignedInt Mandatory Rules Description An integer identifier for a particular upload operation. Return values Table 204 contains the return values for this method.
3 Methods TABLE 205 Parameters Parameter Type Presence Rules Description ipAddress string Mandatory The IP address of the TFTP server. sourceFile string Mandatory The template file to be copied from the TFTP server. Return value Table 206 contains the return value for this method. TABLE 206 Return value Name Type Description token unsignedInt An random integer identifier for this particular upload operation.
Data structures 3 Data structures AccountingConfiguration This structure is a high-level description for Accounting configuration on the Brocade Virtual ADX. TABLE 208 Attributes Parameters Type Presence Rules Description execPrivilegeConfig ExecPrivilegeLevelConfig Mandatory This parameter takes only the values: NONE, RADIUS and TACACS+.
3 Data structures AclID This structure is a high-level description of Access List configuration. TABLE 209 Attributes Parameters Type Presence Rules Description number unsignedInt Optional Either "number" or "name" must be present. Both cannot be present. Value from 1 to 99 for a standard ACL Value from 100 to 199 for an extended ACL. Specifies the ACL ID. ipVersion ipVersionEnum This parameter value is ignored when parameter “number” is present with a value.
Data structures 3 AsmState This structure is the high-level description of the ASM module state with BPs. TABLE 211 Attributes Name Type Required Rules Description asmName string Optional The ASM slot name. asmState asmStateEnum Optional The state of the ASMs. bpNameState bpStateEnum[ ] Optional The BPs name with states. AuthenticationConfiguration This structure is a high-level description for Authentication configuration on the Brocade Virtual ADX.
3 Data structures BannerMessage This structure is a high-level description for configuring the banner messages on Brocade Virtual ADX. TABLE 214 Attributes Parameters Type Presence Rules Description messageOftheDay string Mandatory Maximum 2548 characters is allowed. The string can be from 1 – 2548 characters in length. This parameter specifies an ASCII string message to be displayed on a User’s terminal whenever a Telnet CLI session is established.
Data structures 3 BpNameAndState This structure is the high-level description of BP name with state. TABLE 217 Attributes Name Type Required Rules Description bpNumber unsignedInt Optional The name of the BP. bpState bpStateEnum Optional The state of the ASMs. ConfigSyncConfiguration This structure is the high-level description of config-sync configuration.
3 Data structures TABLE 220 Attributes Parameters Type Presence Rules Description timeElapsedSinceLastConfigSync string Optional Time elapsed since last config sync with peer timeElapsedSinceLastConfigChange string Optional Time elapsed since last config change ConnectedUserStats This structure is the high-level description of connection statistics to and from the Brocade Virtual ADX device.
Data structures 3 This structure is the high-level description of the context filter. TABLE 224 Attributes Name Type Presence Rules Description field contextFilterFieldEnum Mandatory Filter field name context name. operator filterOperatorEnum Mandatory Filter operator type. value string Optional Ignored when “operator” value is “RANGE”. Value of the field for filtering. startValue string Optional This parameter is mandatory and considered only when “operator” value is “RANGE”.
3 Data structures TABLE 227 Attributes Name Type Required Rules Description last1SecAvg load Yes The average load on the device for the last one second. last5SecAvg load Yes The average load on the device for the last five seconds. last1MinAvg load Yes The average load on the device for the last one minute. last5MinAvg load Yes The average load on the device for the last five minutes.
Data structures TABLE 229 3 Attributes Parameters Type Presence Rules Description userPrivilegeLevel privilegeLevelEnum Mandatory This parameter specifies whether the authorization or accounting needs to be performed for the commands available at: - Super User level (All commands) - Port configuration level (port-config and read-only commands). - Read Only level (read-only commands).
3 Data structures FileInfo This structure is a high-level description for directory and file information. TABLE 233 Attributes arameter Type Presence Rules Description Location driveLocationEnum Mandatory directoryPath string Optional Either “directoryPath” or “filename” is Mandatory. Both “directoryPath” and “filename” can exist together. Specifies a relative directory path filename string Optional Either “directoryPath” or “filename” is Mandatory.
Data structures TABLE 235 3 Attributes Parameters Type Presence Rules Description startValue string Optional This parameter is mandatory and considered only when “operator” value is “RANGE”. Start value in a range. endValue string Optional This parameter is mandatory and considered only when “operator” value is “RANGE”. End value in a range. flash This structure is the high-level description of the flash memory.
3 Data structures TABLE 237 Attributes (Continued) Name Type Required Rules Description backupTimer unsignedInt Optional The valid values are between 5 and 100. Specifies how long the VirtualADX, when it is the backup Brocade Virtual ADX, will wait for a Hello message or synchronization data from the active Brocade Virtual ADX before assuming the active Brocade Virtual ADX is no longer available. The unit is 100 milliseconds.
Data structures TABLE 238 3 Attributes Name Type Required partnerMacAddress string Optional The chassis MAC address on the other Brocade Virtual ADX switch, indicating layer 2 connectivity between the Brocade Virtual ADX switches. partnerPortCount unsignedInt Optional The number of physical ports on the other Brocade Virtual ADX switch. numActivates unsignedInt Optional The number of times this Brocade Virtual ADX switch has changed from standby to active.
3 Data structures HAbackupPort This structure is the high-level description of of any HA ethernet port. TABLE 239 Attributes Name Type Required Rules Description slot unsignedInt Optional The slot number. port unsignedInt Optional Ethernet port number. portString string vlanID unsignedInt Optional Identifies the VLAN ID of the VLAN to which the port belongs. isTagged boolean Optional Specifies whether the port is tagged or untagged.
Data structures TABLE 240 3 Attributes Name Type Required Rules Description enableVrrp boolean Enables Virtual Router Redundancy Protocol (VRRP). enableVrrpExtended boolean Enables VRRP Extended (VRRP-E). HaNodeStatus This structure is a high-level description of the high availability status of a unit. TABLE 241 Attributes Name Type Required Rules Description partnerMacAddress string Yes The chassis MAC address of the SLB partner.
3 Data structures TABLE 243 Attributes Name Type Required portString string vlanID unsignedInt Rules Description Interface port string. For example: Ethernet “1” or “1/1” etc. Loopback “lb1” or “lb2” etc. Virtual “ve1” or “ve2” etc. Management “mgmt1” only. • • • • Identifies the VLAN ID of the VLAN to which the port belongs. HAStatusSummary This structure is the high-level description of the HA status summary.
Data structures 3 HAVipGroupConfiguration This structure is the high-level description of a backup node statistics.
3 Data structures image This structure is the high-level description of any primary or secondary image. TABLE 249 Attributes Name Type Required Rules Description version string Yes The version of the primary or secondary code. size unsignedInt Yes The size of the primary or secondary code. label string Yes The name of the image. builtOn string Yes The timestamp showing when the image was built. InterfaceID This structure is a high-level description of interface.
Data structures 3 load This structure is the high-level description of any load on the device. TABLE 251 Attributes Name Type Required Rules Description percentLoad Float Yes The percentage of load on the device. secondsSince Long Yes The number of seconds since the average or peak load on the device. LoginConfiguration This structure is a high-level description for login authentication configuration.
3 Data structures memStore This structure is the high-level description of the RAM. TABLE 254 Attributes Name Type Required Rules Description name string Yes The name of the management and barrel processors. totalKBytes unsignedLong Yes The total size of the RAM (in bytes). usedKBytes unsignedLong Yes The amount of used space of the RAM (in bytes). freeKBytes unsignedLong Yes The amount of available free space of the RAM (in bytes).
Data structures 3 networkInterface This structure is a high-level description of a network interface. TABLE 257 Attributes Parameters Type Presence Rules Description type interfaceNameEnum Optional Interface type. id string Optional Interface ID. IP string Optional The IP address of the interface. PortList This structure is a high-level description of Port list information.
3 Data structures TABLE 259 Attributes Parameters Type Presence Rules Description accountingPort unsignedInt Optional This parameter’S valid value ranges between 0 and 65535. If the parameter value is empty, then the default port number 1646 is considered. This parameter is the accounting UDP port number. serverRole radiusServerRoleEnum Optional If the parameter is not specified, then the value DEFAULT is considered. This parameter Identifies the RADIUS server role.
Data structures TABLE 260 3 Attributes Parameters Type Presence Rules Description retransmitCount unsignedInt Optional This parameter’s valid value ranges between 0 and 5. The default value is 3. This parameter specifies the maximum number of retransmission attempts. timeout unsignedInt Optional This parameter’s valid value ranges between 1 and 15. The default value is 3 seconds.
3 Data structures TABLE 262 Attributes Parameters Type Presence Rules Description startValue string Optional This parameter is mandatory and considered only when “operator” value is “RANGE”. Start value in a range. endValue string Optional This parameter is mandatory and considered only when “operator” value is “RANGE”. End value in a range. ReloadConfiguration This structure is the high-level description of system reload configuration.
Data structures 3 RoleTemplate This structure is the high-level description of the role template. TABLE 266 Attributes Name Type Presence Rules templatename string Mandatory Maximum 32 characters Role template name. globalNonContextConfigRole roleEnum Optional The global non-context configurations. contexts Contexts[ ] Optional Context name and role. defaultContext string[ ] Optional Default context name.
3 Data structures RoleTemplateFilter This structure is the high-level description of the role template filter. TABLE 267 Attributes Name Type Presence Rules simpleFilter RoleTemplateSimpleFilter Mandatory Description Filter field name. RoleTemplateSimpleFilter This structure is the high-level description of the role template filter. TABLE 268 Attributes Name Type Presence Rules Description field roleTemplateFilterFieldEnum Mandatory Filter field name.
Data structures 3 SnmpAccessPortStatus This structure is a high-level description of SNMP access status of Ethernet ports. TABLE 271 Attributes Parame Type ters Presence Rules Description port InterfaceID Mandatory Ethernet port number. status twoWayToggleEnum Mandatory Specifies whether ENABLED or DISABLED. SnmpClient This structure is a high-level description of SNMP IPv4/IPv6 client.
3 Data structures SnmpCommunityFilter This structure is a filter which consist of a simple SNMP community filter and can also add other complex types later. TABLE 275 Attributes Parameters Type Presence simpleFilter SnmpCommunitySimpleFilter Optional Rules Description Specifies the SNMP Community filter data. SnmpCommunitySimpleFilter This structure is a high-level description of filter for SNMP community string.
Data structures 3 SnmpGroupFilter This structure is a filter which consists of simple and can add other complex types later. TABLE 278 Attributes Parameters Type Presence simpleFilter SnmpGroupSimpleFilter Optional Rules Description SnmpGroupSimpleFilter This structure is a high-level description of filter for SNMP groups. TABLE 279 Attributes Parameters Type Presence Rules Description field snmpGroupFilterFieldEnum Mandatory Filter field name.
3 Data structures TABLE 280 Attributes Parameters Type Presence Rules Description tooBigs unsignedInt Mandatory Specifies the number of SNMP packets with too big size received. noSuchNames unsignedInt Mandatory Specifies the number of SNMP packets with no such name errors received. badValues unsignedInt Mandatory Specifies the number of SNMP packets with bad values received. readOnlys unsignedInt Mandatory Specifies the number of SNMP packets with read only permission received.
Data structures TABLE 281 3 Attributes Parameters Type Presence Rules Description getResponses unsignedInt Mandatory Specifies the number of SNMP packets with Get responses sent. traps unsignedInt Mandatory Specifies the number of Traps sent. SnmpServerAuthenConfiguration This structure is a high-level description for SNMP server authentication configuration.
3 Data structures SnmpServerGlobalConfiguration This structure is a high-level description of SNMP server configuration. TABLE 284 Attitudes Parameters Type Presence Rules Description contactInfo string Optional Maximum of 64 characters. Identification of the contact person for this managed node. locationInfo string Optional Maximum of 128 characters. The physical location of this node, up to 128 alphanumeric characters.
Data structures 3 SnmpTrapReceiverConfig This structure is a high-level description of SNMP engine id along with associated informations. TABLE 287 Attributes Parameters Type Presence hostIPAddress string Mandatory version snmpSecurityModelEnum Optional If this parameter is empty, then version “V1” will be used. Specifies the SNMP version or security model. userAuthSecurity Snmpv3UserAuthSecurity Optional This parameter is mandatory when snmpVersion is V3.
3 Data structures TABLE 288 Attributes Parameters Type Presence Rules Description startValue string Optional This parameter is mandatory and considered only when “operator” value is “RANGE”. Start value in a range. endValue string Optional This parameter is mandatory and considered only when “operator” value is “RANGE”. End value in a range. SnmpTrapStatus This structure is a high-level description of SNMP traps status information.
Data structures 3 Snmpv3UserAuthenticationPrivacyParam This structure is a high-level description of SNMP user authentication and privacy parameters. TABLE 291 Attributes Parameters Type Presence Rules Description authType snmpv3UserAuthenticationTypeEnum Mandatory This parameter is mandatory when privacyEncryptio nType or isEncrypted is specified. Authentication method type for the user. authPassword string Mandatory 8 to 16 characters for MD5 and 8 to 20 chars for SHA.
3 Data structures Snmpv3UserAuthSecurity This structure is a high-level description of SNMPv3 user with security level information. TABLE 292 Attributes Parameters Type Presence Rules Description securityLevel snmpv3UserOrGroupSecurityLevelEnum Mandatory SNMPv3 user security level. userName string Mandatory SNMPv3 user name. Snmpv3UserConfig This structure is a high-level description of SNMP user configuration.
Data structures 3 Snmpv3UserSimpleFilter This structure is a high-level description of filter for SNMPv3 user filter information. TABLE 295 Attributes Parameters Type Presence Rules Description field snmpv3UserFilterFieldEnum Mandatory Filter field name. operator filterOperatorEnum Mandatory Filter operator type. value string Optional Ignored when “operator” value is “RANGE”. Value of the field for filtering.
3 Data structures SnmpViewSimpleFilter This structure is a high-level description of filter for SNMP view filter information. TABLE 298 Attributes Parameters Type Presence Rules Description field snmpViewFilterFieldEnum Mandatory Filter field name. operator filterOperatorEnum Mandatory Filter operator type. value string Optional Ignored when “operator” value is “RANGE”. Value of the field for filtering.
Data structures TABLE 300 3 Attributes Name Type Required Rules Description pollingInterval unsignedInt Optional Specifies the Polling interval in seconds. roundTripDelay string Optional Specifies the Round trip delay in milliseconds. dispersion string Optional Specifies the Dispersion in seconds. SntpAssociationFilter This structure is a high-level description of filter for SNTP association.
3 Data structures TABLE 303 Attributes Name Type Required Rules Description precision string Optional Specifies the precision. referenceTime string Optional Specifies the reference time in milliseconds. clockOffset string Optional Specifies the clock offset in milliseconds. rootDelay string Optional Specifies the root delay in milli seconds. rootDispersion string Optional Specifies the root dispersion in milliseconds.
Data structures 3 SshConnectionSimpleFilter This structure is a high-level description of filter for SSH connection filter information. TABLE 306 Attributes Parameters Type Presence Rules Description Field sshConnectionFilterFieldEnum Mandatory Filter field name. Operator filterOperatorEnum Mandatory Filter operator type. Value string Optional Ignored when “operator” value is “RANGE”. Value of the field for filtering.
3 Data structures SshServerGlobalConfiguration This structure is a high-level description of SSH server configuration information. TABLE 308 126 Attributes Parameters Type Presence Rules Description enableSsh twoWayToggleEnum Optional Enabling SSH is an asynchronous operation and takes sometime in case of set/update API. Specifies whether the SSH server is enabled or disabled. authenticationRetries unsignedInt Optional This parameter’s valid value ranges between 1 and 5.
Data structures TABLE 308 3 Attributes Parameters Type Presence Rules portNumber unsignedInt Optional Specifies the SSH port This number. The default parameter’s SSH port number is 22. valid value ranges between 1 and 65535. Default port 22. enableScp twoWayToggleEnum Optional ipv4AccessGroup AclID Optional If specified, either the accessList number or name must be present, but not both. Specifies the IPv4 access list.
3 Data structures SymPriorityMapEntry This structure is the high-level description of Symmetric Priority Map entry. TABLE 309 Attributes Parameters Type Presence Rules Description senderValue unsignedInt Mandatory Valid value range is from 1 to 255. Sender value. receiverValue unsignedInt Mandatory Valid value range is from 1 to 255. Receiver Value. SymPriorityMapEntryFilter This structure is the high-level description of filter for Symmetric Priority Map entries.
Data structures 3 SystemClock This structure is the high-level description of the clock detail. TABLE 312 Attributes Name Type Required time string Optional timeZoneGmt string Optional date string Optional timeSource string Optional Rules Description The time in hh:mm:ss format. timeZoneGmt and timeZoneUS are mutually exclusive. The GMT time zone. Date in format of day:month:date:year. For example, Sun Jul 03, 2011.
3 Data structures SysStartTime This structure is a high-level description for System started time information. TABLE 315 Attributes Parameter Type Presence Rules Description hours unsignedInt Mandatory Specifies the hour. minutes unsignedInt Mandatory Specifies the minute. seconds unsignedInt Mandatory Specifies the seconds. timeZone string Mandatory Specifies the time zone. weekDay string Mandatory Specifies the day of the week. month string Mandatory Specifies the month.
Data structures 3 TacacsServerConfiguration This structure is a high-level description for identifying the TACACS server to the Brocade Virtual ADX. TABLE 318 Attributes Parameters Type Presence Rules Description hostIP string Optional Only IPv4 address is allowed. This parameter specifies the IP address of the TACACS or TACACS+ server. authenticationPort unsignedInt Optional This parameter’S valid value ranges between 0 and 65535. The default port number is 49.
3 Data structures TacacsServerGlobalConfiguration This structure is a high-level description of TACACS server configuration information. TABLE 320 132 Attributes Parameters Type Presence Rules Description key string Optional The key can be from 1 – 32 characters in length and cannot include any space characters. This parameter specifies the default access string value that the Brocade Virtual ADX sends to the TACACS or TACACS+ server when trying to authenticate user access.
Data structures 3 TacacsServerSimpleFilter This structure is a high-level description of filter for TACACS server filter information. TABLE 321 Attributes Parameters Type Presence Rules Description field tacacsServerFilterFieldEnum Mandatory Filter field name. operator filterOperatorEnum Mandatory Filter operator type. value string Optional Ignored when “operator” value is “RANGE”. Value of the field for filtering.
3 Data structures TelnetClientSimpleFilter This structure is a high-level description of filter for Telnet client filter information. TABLE 324 Attributes Parameters Type Presence Rules Description Field telnetClientFilterFieldEnum Mandatory Filter field name. operator filterOperatorEnum Mandatory Filter operator type. Value string Optional Ignored when “operator” value is “RANGE”. Value of the field for filtering.
Data structures TABLE 325 3 Attributes Parameters Type Presence Rules suppressRejectMessage twoWayToggleEnum Optional Flag to indicate whether connection reject message is to be suppressed. enableAuthentication boolean Optional Flag to indicate whether the telnet authentication is enabled or disabled. password string Optional encryptPassword twoWayToggleBoolEnum Optional sourceInterface InterfaceID Optional Supported only in router mode. Specifies the source interface.
3 Data structures TABLE 326 TemplateOperationResult attributes Name Type Presence Rules message string Mandatory detail string Description The text of the error, warning, or message TemplateSimpleSummaryFilter This structure is a used in filtering operations for Config Template Summary queries. TABLE 327 TemplateSimpleSummaryFilter attributes Name Type Presence Rules Description field templateSummaryFilterFieldEnum Mandatory Template summary filter field.
Data structures TABLE 328 3 TemplateSummary attributes (Continued) Name Type Presence Rules Description area templateStorageAreaEnum Mandatory The storage area where the Template file resides. Possible values are: • PRE_DEFINED_AREA • USER_DEFINED_AREA • READY_TO_USE_AREA isXmlValid boolean Mandatory TRUE if the template file parsing is success else FALSE. TemplateSummaryFilter This structure is a used in filtering operations for Config Template Summary queries.
3 Data structures TABLE 331 138 TemplateVariable attributes (Continued) Name Type Presence Rules Description screenPositionIndex unsignedInt Optional 0 means undefined If non-zero, this is a hint for user-interface clients about where on the screen this variable's input field should be placed. shortPrompt string Optional 64 characters maximum A hint for user-interface clients about how this variable's input field should be prompted.
Data structures 3 TemplateVariableGroup This structure is a high-level description of the configuration template variables. TABLE 332 TemplateSummary attributes Name Type Presence groupName string title string list boolean screenPositio nIndex unsignedInt variableList TemplateVariable[ ] Rules Description The group name. TimeAt This structure is the high-level description of the clock details.
3 Data structures TABLE 335 Attributes (Continued) Name Type Presence Rules Description passwordExpireTime string Optional 1-365 days. Password expiry time in days. context Contexts[ ] Optional globalNonContextConfigRole roleEnum Optional Manager, None, or viewer. Global non-context configurations. defaultContext string Optional Maximum 32 characters. Default context name. roleTemplate string Optional Maximum 32 characters. Name of the role template. Contexts name and role.
Enumerations 3 Enumerations aaaConsoleLoginEnum This structure is a high-level description of AAA console login configuration parameter enumerated list. TABLE 339 Attributes Parameters Description AAA_CONSOLE_LOGIN Console login AAA configuration. aaaSecurityMethodEnum This structure is a high-level description of security methods enumerated list. TABLE 340 Attributes Parameters Description NONE Do not use any authentication method. The device automatically permits access.
3 Enumerations actionTypeEnum These are the enumerations for the action to be taken after module temperature reaches a particular threshold. TABLE 343 Attributes Parameters Description SHUTDOWN Shuts down the module. WARNING Displays a warning to the user. asmStateEnum This structure is a high-level description of ASM state enumerated list.
Enumerations 3 authorizationConfigParametersEnum This structure is a high-level description of Authorization configuration parameters enumerated list. TABLE 346 Attributes Parameters Description EXEC_MODE_AUTHORIZATION_METHOD Exec mode authorization method EXEC_COMMANDS_PRIV_AUTHORIZATION Exec commands priv authorization arpTypeEnum This structure is a high-level description of ARP type enumerated list.
3 Enumerations TABLE 349 Attributes Parameters Description BAD_BP_IMAGE_TYPE Bad BP image type BAD_BP_IMAGE_CHECKSUM Bad BP image checksum IMAGE_LOADED Image loaded MAILBOX_ESTABLISHED Mailbox established BP_ACCESS_TIMEOUT BP access timeout BP_APP_TIMEOUT BP application timeout BP_APP_READY BP application ready BP_APP_RUNNING BP application running UNDETERMINED_BP_BRINGUP_STATE Undetermined BP bring up state cardTypeEnum These are the enumerations for Brocade Virtual ADX switch flash
Enumerations 3 configSyncOperationEnum The enumerations for types of Config-sync operations. TABLE 352 Attributes Parameters Description FULL_SYNC Full synchronization of configuration and files.
3 Enumerations TABLE 354 Attributes Parameters Description FAILED Config-sync status retrieval is failed. NONE No config-sync status is present. configSyncStatusEnum The enumerations for different status of Config-sync. TABLE 355 Attributes Parameters Description IN_SYNC Both peers devices are in complete sync. OUT_OF_SYNC Peer devices are out of sync. IN_PROGRESS Config sync is in progress. NOT_RETRIEVED Status is not retrieved.
Enumerations 3 copyOperationsTypeEnum These are the enumerations for copy operations type enumerated list.
3 Enumerations featureEnum This structure is a high-level description of ADX features enumerated list.
Enumerations 3 fileNameOnFlashEnum This structure is a high-level description of file names on code flash enumerated list. TABLE 363 Attributes Parameters Description STARTUP_CONFIG Startup configuration. PRIMARY Primary code image. PRIMARY_SIGNATURE Primary image's digital signature. SECONDARY Secondary code image. SECONDARY_SIGNATURE Secondary image's digital signature. ALL_DATA All files in code flash excluding images.
3 Enumerations haModeEnum These are the enumerations for and ADX high availability mode enumerated list. TABLE 367 Attributes Parameters Description HOT_STANDBY Hot standby mode. SYMMETRIC_SLB Symmetric SLB mode. SYMMETRIC_ACTIVE Symmetric active mode. NOT_CONFIGURED Not configured. haNodeAttributeEnum These are the enumerations of high backup node configuration attributes enumerated list. TABLE 368 150 Attributes Parameters Description BACKUP_GROUPID The backup group ID.
Enumerations TABLE 368 3 Attributes Parameters Description ENABLE_VRRP Enables VRRP in the Brocade Virtual ADX switch. ENABLE_VRRP_EXTENDED Enables VRRP extended in the Brocade Virtual ADX switch. haSlbStateEnum These are the enumerations for and SLB state enumerated list. TABLE 369 Attributes Parameters Description SLB_SYNC_COMPLETE All the synchronization requests from the local Brocade Virtual ADX switch have been sent to the peer Brocade Virtual ADX switch.
3 Enumerations haVipTypeEnum These are the enumerations of the HA VIP type enumerated list. TABLE 372 Attributes Parameters Description OWNER VIP owner. NON_OWNER Non-owner for symmetric VIP state. NOT_APPLICABLE Not applicable. interfaceTypeEnum This structure is a high-level description of interface type enumerated list. TABLE 373 Attributes Parameters Description ETHERNET Valid only in Router mode. GROUP_VIRTUAL Valid only in Router mode. VIRTUAL Valid only in Router mode.
Enumerations 3 ipVersionEnum This structure is a high-level description of IP versions enumerated list. TABLE 376 Attributes Parameters Description IPV4 IPv4 version. IPV6 IPv6 version. moduleNameEnum This structure is a high-level description of module name enumerated list.
3 Enumerations portTaggedModeEnum This structure is a high-level description of port mode enumerated list. TABLE 380 Attributes Parameters Description NONE DUAL_MODE Specifies the Dual-mode of the VLAN port. TAGGED Specifies the Tagged mode of the VLAN port. UNTAGGED Specifies the Untagged mode of the VLAN port. STATIC UPLINK EXCLUDE privilegeLevelEnum This structure is a high-level description of user privilege level enumerated list.
Enumerations 3 radiusServerGlobalConfigParametersEnum This structure is a high-level description of RADIUS server configuration parameters enumerated list. TABLE 383 Attributes Parameters Description KEY Default access string (maximum 32 characters). DEAD_TIME Server dead time in seconds. RETRANSMIT_COUNT Number of retries before giving up (maximum 5 times). TIMEOUT Server time out in seconds (maximum 15 seconds). SOURCE_INTERFACE Specify interface for source address in RADIUS packets.
3 Enumerations roleTemplateFilterFieldEnum This type of data will be a role template filter enumerated list. TABLE 386 Attributes Parameters Description TEMPLATE_NAME The name for the template. CONTEXT_NAME The context name. IN_USE The flag to identify whether the role template is being used. GLOBAL_CONFIG_ROLE Global configuration role. DEFAULT_CONTEXT The default context. sessionTypeEnum These are the enumerations for session types.
Enumerations 3 snmpCommunityStrAccessEnum This structure is a high-level description of SNMP community string access types enumerated list. TABLE 390 Attributes Parameters Description READ_ONLY Read-only access. READ_WRITE Write access. snmpGroupFilterFieldEnum This structure is the high-level description of SNMP group filter field enumerated list. TABLE 391 Attributes Parameters Description GROUP_NAME SNMP group name. SNMP_SECURITY_MODEL SNMP security model.
3 Enumerations snmpServerGlobalConfigParametersEnum This structure is a high-level description of SNMP server configuration parameters enumerated list. TABLE 394 Attributes Parameters Description CONTACT_INFORMATION Identification of the contact person for this managed node. LOCATION_INFORMATION The physical location of this node, up to 128 alphanumeric characters. ENGINE_ID Specifies the SNMPv3 server Engine ID. TRAP_SOURCE Specifies the source interface for traps.
Enumerations TABLE 396 3 Attributes Parameters Description L4_GSLB_HEALTH_CHECK_IP_UP L4 GSLB health check IP_UP L4_GSLB_REMOTE_CONTROLLER_UP L4 GSLB remote GSLB SI down GSLB_REMOTE_CONTROLLER_DOWN L4 GSLB remote GSLB SI up L4_GSLB_REMOTE_DOWN L4 GSLB remote SI down L4_GSLB_REMOTE_UP L4 GSLB remote SI up L4_HTTP_MATCH_LIST L4 HTTP match list L4_MAX_SESSION_LIMIT L4 maximum session limit L4_PORT_DOWN L4 port down L4_PORT_UP L4 port up L4_SERVER_DOWN L4 server down L4_SERVER_MAX_CONN
3 Enumerations snmpv3UserAuthenticationTypeEnum This structure is the high-level description of SNMP v3 user authentication type enumerated list. TABLE 397 Attributes Parameters Description MD5 HMAC MD5 algorithm for authentication. SHA HMAC SHA algorithm for authentication. NONE No authentication. snmpv3UserFilterFieldEnum This structure is a high-level description of SNMPv3 user filter field enumerated list. TABLE 398 Attributes Parameters Description USER_NAME Name of the user.
Enumerations 3 snmpViewFilterFieldEnum This structure is a high-level description of SNMP view filter field enumerated list. TABLE 401 Attributes Parameters Description VIEW_NAME Name of the SNMP view. MIB_SUBTREE_OID MIB subtree. VIEW_TYPE Identifies whether the specified mibSubtreeName is included or excluded in the view. snmpViewTypeEnum This structure is a high-level description of SNMP view type enumerated list. TABLE 402 Attributes Parameters Description VIEW_INCLUDED View included.
3 Enumerations sourceIPTypeEnum This structure is a high-level description of source IP type enumerated list. TABLE 405 Attributes Parameters Description SOURCE_IP Source IP address SOURCE_NAT_IP Source NAT IP address SOURCE_STANDBY_IP Source standby IP address sshConnectionFilterFieldEnum This structure is a high-level description of SSH connection filter field enumerated list. TABLE 406 Attributes Parameters Description CONNECTION_NUMBER Specifies the SSH connection number.
Enumerations 3 symPriorityMapEntryFilterFieldEnum The enumerations for fields of symmetric priority map entry for filtering. TABLE 408 Attributes Parameters Description SENDER_VALUE Sender priority value. RECEIVER_VALUE Receiver priority value. systemParameterEnum This structure is a high-level description of system parameters enumerated list.
3 Enumerations TABLE 409 164 Attributes Parameters Description ISIS_SPF_INTERVAL ISIS SPF interval IP_MAX_RIP IP MAX RIP IP_MAX_SAP IP MAX SAP IP_ARP IP ARP IP_STATIC_ARP IP Static ARP IP_CACHE IP CACHE IP_FILTER_PORT IP filter port IP_FILTER_SYS IP filter system IP_QOS_SESSION IP QOS session L3_VLAN L3 VLAN L4_REAL_SERVER L4 real server L4_VIRTUAL_SERVER L4 virtual server L4_SERVER_PORT L4 server port L4_MULTI_BINDING L4 multi binding TCP_BUFFER TCP buffer MAC MAC IP_
Enumerations TABLE 409 3 Attributes Parameters Description SSL_KEYS SSL keys MAXIMUM_L4_INTERNAL_CAM_ENTRIES Maximum L4 internal cam entries MAXIMUM_L4_EXTERNAL_CAM_ENTRIES Maximum L4 external cam entries TCS_HASH_TABLE_SIZE TCS hash table size MAX_DRAM_SIZE Maximum DRAM size MAX_USB_FILESYSTEM_SIZE Maximum USB file system size switchStateEnum This structure is a high-level description of switch state enumerated list.
3 Enumerations TABLE 412 Attributes Parameters Description SOURCE_INTERFACE Specify interface for source address in TACACS packets. Supported only in router mode. VLAN Specifies the VLAN information. tacacsServerRoleEnum This structure is a high-level description of TACACS server use enumerated list. TABLE 413 Attributes Parameters Description ACCOUNTING_ONLY Use server for accounting only (TACACS+ only). AUTHENTICATION_ONLY Use server for authentication only (TACACS+ only).
Enumerations TABLE 416 3 Attributes Parameters Description IDLE_TIMEOUT Telnet idle timeout. SUPRESS_REJECT_MESSAGE Flag to indicate whether connection reject message is to be suppressed. AUTHENTICATION Enable/Disable telnet authentication. PASSWORD Telnet password. SOURCE_INTERFACE Specifies the source interface. Supported only in router mode. VLAN Specifies the VLAN information. Supported in router mode. IPV4_ACCESS_GROUP IPV4 access list. IPV6_ACCESS_GROUP IPv6 access list.
3 Enumerations templateResultTypeEnum This enum is a high-level description of the type of result message returned from a Config Template operation. TABLE 419 templateResultTypeEnum Parameters Description ERROR The message is about an error which caused the operation to fail. WARNING The message is about an warning which may or may not be of concern. MESSAGE The message is informative but not indicating a problem. OK The operation is ok, no problem occurred.
Enumerations TABLE 422 3 templateSummaryFilterFieldEnum Parameters Description NONE Template upload operation status is not available. BUSY Template upload operation is in busy state. IN_PROGRESS Template upload operation is in progress. COMPLETED Template upload operation has completed. FAILED Template upload operation has failed. templateVariableDataTypeEnum This enumeration is a high-level description of the supported data types for the Config Template variables.
3 Enumerations TABLE 423 templateVariableDataTypeEnum (Continued) Parameters PREDICTOR PORT_OR_PROTOCOL Description An enumerated type of predictor; supported values include: dynamic-weighted enhanced-weighted least-conn response-time round-robin weighted weighted-round-robin weighted-round-robin-static • • • • • • • • Either a known and supported port name or a valid protocol number.
Enumerations 3 unitDescriptionTypeEnum This structure is a high-level description of system parameters unit description enumerated list TABLE 426 Attributes Parameters Description HOP_COUNT Hop count SECONDS Seconds MILLI_SECONDS Milliseconds MINUTES Minutes COUNT Count BYTES Bytes PRIORITY Priority userFilterFieldEnum This type of data will be a user filter field enumerated list. TABLE 427 Attributes Parameters Description USER_NAME The user name.
3 Enumerations vlanPortAssignmentFilterFieldEnum This type of data will be an user type enumerated list. TABLE 429 172 Attributes Parameters Description VLAN_ID VLAN ID.
Chapter 4 Network API Reference In this chapter • Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . • Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . • Data structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . • Enumerations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
4 Methods Return values Not applicable. Error messages List of Error Messages addSourceIPs Description Adds the source IP addresses. (Source IP or Source NAT or Source Standby NAT.) Parameters Table 431 contains the parameters required for the method. TABLE 431 Parameters Name Type Presence ipList SourceIP[] Optional Rules Description The list of IP addresses to be configured. Return values Not applicable.
Methods 4 addVlansToVlanGroup Description Add VLANs to a VLAN group configured on the device. Parameters Table 433 contains the parameters required by the method. TABLE 433 Parameters Name Type Presence vlanGroupID string Optional VlanIDs string[] Rules Description Identifies the starting index. Identifies the VLAN IDs. Return values Not applicable. Error messages List of Error Messages clearIPRoute Description Clears the IP route.
4 Methods Parameters Table 435 contains the parameters required by the method. TABLE 435 Parameters Name Type Presence ipSubnetVlans IPSubnetVlan[] Mandatory Rules Description Identifies the IP subnet VLAN information. Return values Not applicable. Error messages List of Error Messages createMacEntry Description Creates a MAC entry. Parameters Table 436 contains the parameters required by the method.
Methods 4 createVlan Description Creates a port VLAN for the given VLAN ID. Parameters Table 438 contains the parameters required by the method. TABLE 438 Parameters Name Type Presence vlanList PortVlan[] Mandatory Rules Description Identifies the VLAN information. Return values Not applicable. Error messages List of Error Messages createVlanGroup Description Creates a VLAN group. Parameters Table 439 contains the parameters required by the method.
4 Methods Return values Not applicable. Error messages List of Error Messages deleteIPsFromInterface Description Deletes the configured IP addresses from an interface. (This works only in Router mode.) Parameters Table 441 contains the parameters required for the method. TABLE 441 Parameters Name Type Presence Rules Description id InterfaceID Mandatory The identifier of the interface. ipAddresses string[] Mandatory The list of IP addresses to be removed. Return values Not applicable.
Methods 4 Parameters Table 443 contains the parameters required by the method. TABLE 443 Parameters Name Type Presence interfaceID InterfaceID Mandatory Rules Description Interface ID. Return values Not applicable. Error messages List of Error Messages deleteMacEntries Description Deletes a MAC entry. Parameters Table 444 contains the parameters required by the method.
4 Methods Return values Not applicable. Error messages List of Error Messages deleteStaticRoute Description Clears a specific route. Parameters Table 446 contains the parameters required by the method. TABLE 446 Parameters Name Type Presence routeInfo SourceIPFilter[] Mandatory Rules Description Identifies the data structure containing the static route information. Return values Not applicable.
Methods 4 deleteVlanGroups Description Deletes the given VLAN group ID. Parameters Table 448 contains the parameters required by the method. TABLE 448 Parameters Name Type Presence vlanGroupIDs string[] Mandatory Rules Description Identifies the VLAN group ID. Return values Not applicable. Error messages List of Error Messages deleteVlans Description Deletes the specified VLAN. Parameters Table 449 contains the parameters required by the method.
4 Methods Error messages List of Error Messages disableInterfaces Description Disables interfaces. Parameters Table 450 contains the parameters required by the method. TABLE 450 Parameters Name Type Presence Rules Description idList InterfaceID[] Mandatory The Ethernet and Management interfaces are supported in switch mode only. Identifies the list interfaces for enabling. Return values Not applicable.
Methods 4 Parameters Table 451 contains the parameters required by the method. TABLE 451 Parameters Name Type Presence Rules Description vlanGroups InterfaceID[] Mandatory The Ethernet and Management interfaces are supported in switch mode only. Identifies the list of interfaces for enabling. Return values Not applicable. Error messages List of Error Messages getAllInterfaceIDs Description Retrieves all of the interfaces IDs.
4 Methods Parameters Table 454 contains the parameters required for the method. TABLE 454 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional When both the startIndex and numRetrieved are not present, then the available number of interface statistics information is retrieved. The start index used to retrieve the summary of interface statistics.
Methods 4 Parameters Table 456 contains the parameters required for the method. TABLE 456 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional When both the startIndex and numRetrieved are absent, then only the available IP summary information is retrieved. The start index used to retrieve the summary of IP addresses configured in the interfaces.
4 Methods Return values Table 459 contains the return values of the method. TABLE 459 Return values Name Type Description genericInfo ResponseInformaton Identifies the generic information about the IP forward cache. ipFwdCacheInfo IPFwdCacheInfo[] Identifies the data structure containing the IP forward cache information. Error messages List of Error Messages getAllIPInterfaces Description Retrieves all of the IP interface information.
Methods 4 Parameters Table 462 contains the parameters required by the method. TABLE 462 Parameters Name Type Presence Rules Description versionFlag ipVersionEnum startIndex unsignedInt Optional Identifies the starting index. numRetrieved unsignedInt Optional Identifies number of sessions to be retrieved. The maximum value allowed is 32. filterInfo IPRouteSummaryFilter Optional Specifies the filter criteria. Return values Table 463 contains the return values of the method.
4 Methods Error messages List of Error Messages getAllMacEntries Description Retrieves all of the MAC entries available in the device. Parameters Table 466 contains the parameters required by the method. TABLE 466 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional Identifies the starting index. numRetrieved unsignedInt Optional Identifies the number of sessions to be retrieved. The maximum value allowed is 10.
Methods 4 Parameters Table 468 contains the parameters required for the method. TABLE 468 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional When both the startIndex and the numRetrieved parameters are not present, then the available number of IP addresses are retrieved. The start index for retreiving the configured IP addresses.
4 Methods Return values Table 471 contains the return values of the method. TABLE 471 Return values Name Type Description genericInfo ResponseInformation Generic information. staticArpList ArpObject[] Identifies the data structure containing the static ARP information. Error messages List of Error Messages getAllStaticRoutes Description Retrieves all of the static route information associated with the device. Parameters Table 472 contains the parameters required by the method.
Methods 4 Parameters Table 474 contains the parameters required for the method. TABLE 474 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional When both “startIndex” and “numRetrieved” are not present, then only the possible number of TCP MSS information is retrieved. Start index for retreiving the TCP MSS configured.
4 Methods Return values Table 477 contains the return values. TABLE 477 Return values Name Type Description genericInfo ResponseInformation Identifies the generic information about all of the VLAN groups associated with the device. vlanGroupList VlanGroup[] Identifies the structure containing the VLAN group summary. Error messages List of Error Messages getAllVlans Description Retrieves all of the VLAN information configured on the device.
Methods 4 Return values Table 480 contains the return values of the method. TABLE 480 Return values Name Type Description genericI nfo ResponseInformation arpStats ArpStatistics Identifies the data structure containing the ARP statistics information. Error messages List of Error Messages getArpSummary Description Retrieves all of the ARP cache information. Parameters Table 481 contains the parameters required for the method.
4 Methods Parameters TABLE 483 Name Parameters Type Presence neighbor String[] IP Rules Description Mandatory Neighbor IP addresses. Return values TABLE 484 . Return values Name Type Description neighborList BgpNeighborConfig[] BGP neighbor configuration information. Error messages List of Error Messages getEthernetStatistics Description Retrieves the Ethernet statistics for a particular port. Parameters Table 485 contains the parameters required by the method.
Methods 4 Return values Table 487 contains the return values of the method. TABLE 487 Return values Name Type Description status twoWayToggleEnum The flow control status. Error messages List of Error Messages getIcmpStatisticsSummary Description Retrieves the Internet Control Message Protocol (ICMP) statistics. Parameters Not applicable. Return values Table 488 contains the return values of the method.
4 Methods Return values Table 490 contains the return values of the method. TABLE 490 Return values Name Type Description configList InterfaceConfig[] The interface configuration. Error messages List of Error Messages getInterfaceDetails Description Retrieves the detailed information of configured interfaces. Parameters Table 491 contains the parameters required for the method.
Methods 4 Parameters Table 493 contains the parameters required for the method. TABLE 493 Parameters Name Type Presence Rules Description idList InterfaceID[ ] Mandatory Ethernet and Management interfaces are supported in switch mode only. The list of interface IDs. Return values Table 494 contains the return values of the method. TABLE 494 Return values Name Type Description briefList InterfaceBrief[] The brief information of the configured interfaces.
4 Methods getIPInterface Description Retrieves the IP interface information for the specified details. Parameters Table 497 contains the parameters required by the method. TABLE 497 Parameters Name Type Presence Rules Description Port InterfaceID Mandatory Identifies the Ethernet port information. ipAddress string Mandatory Identifies the IP address of the device. Return values Table 498 contains the return values of the method.
Methods 4 Error messages List of Error Messages getIPStatisticsSummary Description Retrieves the IP statistics. Parameters Not applicable. Return values Table 501 contains the return values of the method. TABLE 501 Return values Name Type Description genericInfo ResponseInformation Identifies the generic information about the IP statistics. v4Statistics V4IcmpStatistics Identifies the data structure containing the IP statistics information.
4 Methods getIPTrafficStatistics Description Retrieves all of the IP traffic statistics. Parameters Not applicable. Return values Table 504 contains the return values of the method. TABLE 504 Name Return values Type Description genericInfo ResponseInformation Identifies the generic information about the IP traffic. ipTraffic IPTrafficSummary Identifies the data structure containing the IP traffic statistics information.
Methods 4 Return values Table 507 contains the return values of the method. TABLE 507 Return values Name Type Description ipv4Mtu unsignedInt Global IPv4 Maximum Transmission Unit. ipv6Mtu unsignedInt Global IPv6 Maximum Transmission Unit. Error messages List of Error Messages. getStaticArpEntry Description Retrieves the static ARP information for the specified details. Parameters Table 508 contains the parameters required by the method.
4 Methods Parameters Table 510 contains the parameters required by the method. TABLE 510 Parameters Name Type Presence routeInfo SourceIPFilter Mandatory Rules Description Identifies the destination IP address. Return values Table 511 contains the return values of the method. TABLE 511 Return values Name Type Description genericInfo ResponseInformation Identifies the generic information about the static route.
Methods 4 getTcpStatisticsSummary Description Retrieves the Transmission Control Protocol (TCP) statistics. Parameters Not applicable. Return values Table 513 contains the return values of the method. TABLE 513 Return values Name Type Description genericInfo ResponseInformation Identifies the generic information about TCP. v4statistics V4TcpStatistics Identifies the data structure containing the TCP statistics information.
4 Methods Parameters Table 515 contains the parameters required by the method. TABLE 515 Parameters Name Type Presence vlanID string Mandatory Rules Description Identifies the VLAN ID. Return values Table 516 contains the return values of the method. TABLE 516 Name Return values Type Description genericInfo ResponseInformation Identifies the generic information about a VLAN. vlanInfo PortVlan Identifies the data structure containing the VLAN summary.
Methods 4 Parameters Table 519 contains the parameters required by the method. TABLE 519 Parameters Name Type Presence Rules Description vlanGroupID string Mandatory Identifies the VLAN group ID. vlanIDs string[ ] Mandatory Identifies the VLAN IDs. Return values Not applicable. Error messages List of Error Messages setInterfaceConfig Description Sets the interface configurations details. Parameters Table 520 contains the parameters required for the method.
4 Methods Parameters Table 521 contains the parameters required for the method. TABLE 521 Parameters Name Type Presence Rules Description ipv4Mtu unsignedInt Optional The valid value range is from 576 to 1500 bytes. At least IPv4 or IPv6 MTI must be present. Global IPv4 maximum transmission unit. ipv6Mtu unsignedInt Optional Valid value range is from 1280 to 9216 bytes. At least IPv4 or IPv6 MTI must be present. Global IPv6 maximum transmission unit. Return values Not applicable.
Methods 4 Parameters Table 523 contains the parameters required by the method. TABLE 523 Parameters Name Type Presence ipSubnetVlans IPSubnetVlan[] Optional Rules Description Identifies the IP subnet VLAN. Return values Not applicable. Error messages List of Error Messages updateMacEntry Description Updates the given MAC entry. Parameters Table 524 contains the parameters required by the method.
4 Methods Error messages List of Error Messages updateStp Description Updates the STP information for the given VLAN. Parameters Table 526 contains the parameters required by the method. TABLE 526 Parameters Name Type Presence stpInfo StpOtherInfo[ ] Mandatory Rules Description Identifies the STP information. Return values Not applicable. Error messages List of Error Messages updateVlan Description Updates the VLAN information as specified in the request.
Methods 4 Parameters Table 528 contains the parameters required by the method. TABLE 528 Parameters Name Type Presence vlanGroups VlanGroup[] Mandatory Rules Description Identifies the VLAN group information. Return values Not applicable. Error messages List of Error Messages Routing Protocols Description Brocade ADX supports the following protocols: • • • • • IP OSPF RIP VRRP VRRPE By default, IP routing is enabled on Layer 3 Switches.
4 Methods clearAllBGPLocalRoutes Description Clears all of the BGP4 or BGP4+ local route information. Parameters Table 530 contains the parameters required by the method. TABLE 530 Parameters Parameters Type Presence version bgpVersionEnum Mandatory Rules Description The BGP4 or BGP4+ version. Return values None Error messages List of Error Messages clearAllBGPNeighbors Description Clears all BGP4 or BGP4+ neighbor information.
Methods 4 Return values None Error messages List of Error Messages createBgpInstance Description Creates the BGP instances. Parameters None. Return values None. Error messages List of Error Messages createOspfInstance Description Creates the OSPF instance. Parameters Table 533 contains the parameters required by the method. TABLE 533 Parameters Parameters Type Presence version ipVersionEnum Mandatory Rules Description The IPv4 or IPv6 version. Return values None.
4 Methods Parameters Table 534 contains the parameters required by the method. TABLE 534 Parameters Parameters Type Presence version bgpVersionEnum Mandatory Rules Description The BGP4 or BGP4+ version. Return values None. Error messages List of Error Messages deleteBgpInstance Description Deletes the BGP instance. Parameters None Return values None Error messages List of Error Messages deleteBgpNeighborConfig Description Clears the BGP neighbor configuration.
Methods 4 deleteOspfArea Description Deletes the OSPF area. Parameters Table 536 contains the parameters required by the method. TABLE 536 Parameters Parameters Type Presence Rules Description area OspfAreaID [] Mandatory 10 The Area ID. Return values None. Error messages List of Error Messages deleteOspfGlobalConfig Description Deletes the OSPF global configuration. Parameters Table 537 contains the parameters required by the method.
4 Methods Parameters Table 538 contains the parameters required by the method. TABLE 538 Parameters Parameters Type Presence Rules version ipVersionEnum Mandatory Description The IPv4 or IPv6 version. Return values None. Error messages List of Error Messages deleteOspfInterfaceConfig Description Deletes the OSPF interface configuration. Parameters Table 539 contains the parameters required by the method.
Methods 4 Error messages List of Error Messages getAllBgpNeighborsSummary Description Retrieves all of the BGP neighbors summary information. Parameters Table 541 contains the return values of the method. TABLE 541 Parameters Parameters Type Presence Rules Description version bgpVersionEnum Mandatory The BGP4 or BGP4+ version. startIndex unsignedInt Optional The start index. numRetrieved unsignedInt Optional The number of records to be retrieved. Maximum number allowed is 16.
4 Methods Return values Table 544 contains the return values of the method. TABLE 544 Return values Parameters Type Description genericInfo ResponseInformation Generic information. routeList BgpRouteInfo[] Retrieves BGP4 or BGP4+ route table parameters. Error messages List of Error Messages getAllIPv6CacheSummary Description This API retrieves all of the IPv6 cache summaries. Parameters Table 545 contains the parameters required by the method.
Methods 4 Parameters Table 547 contains the parameters required by the method. TABLE 547 Parameters Parameters Type Presence startIndex unsignedInt Optional Starting index. numRetrieved unsignedInt Optional Number of sessions to be retrieved. Maximum value allowed is 10. filter IPv6InterfaceFilter Optional Filter criteria. Rules Description Return values Table 548 contains the return values of the method.
4 Methods getAllOspfAreas Description Retrieves all of the OSPF area information. Parameters Table 551 contains the parameters required by the method. TABLE 551 Parameters Parameters Type Presence Rules Description version ipVersionEnum Optional The IPv4 or IPv6 version. startIndex unsignedInt Optional The start index. numRetrieved unsignedInt Optional The number of records to be retrieved. Maximum number allowed is 10. filter OspfAreaSummaryFilter Optional The filter criteria.
Methods 4 Return values Table 554 contains the return values of the method. TABLE 554 Return values Parameters Type Description genericInfo ResponseInformation Generic information. borderRoutersList OspfBorderRoutersInfo[] Retrieves the OSPF border router parameters. Error messages List of Error Messages getAllOspfInterfaces Description Retrieves all of the OSPF interfaces. Parameters Table 555 contains the parameters required by the method.
4 Methods Parameters Table 557 contains the parameters required by the method. TABLE 557 Parameters Parameters Type Presence Rules Description startIndex unsignedInt Optional Start index. numRetrieved unsignedInt Optional Number of records to be retrieved. Maximum number allowed is 10. filter OspfDatabaseSummaryFilter Optional Filter criteria. Return values Table 558 contains the return values of the method.
Methods 4 Error messages List of Error Messages getAllOspfNeighbors Description Retrieves all of the OSPF neighbors. Parameters Table 561 contains the parameters required by the method. TABLE 561 Parameters Parameters Type Presence Rules Description version ipVersionEnum Optional The IPv4 or IPv6 version. startIndex unsignedInt Optional The start index. numRetrieved unsignedInt Optional The number of records to be retrieved. Maximum number allowed is 10.
4 Methods Return values Table 564 contains the return values of the method. TABLE 564 Return values Parameters Type Description genericInfo ResponseInformation Generic information. routeList OspfRouteInfo Retrieves the OSPF IPv4 or IPv6 route parameters. Error messages List of Error Messages getBgpDetails Description Retrieves the BGP4 or BGP4+ configuration details. Parameters Table 565 contains the parameters required by the method.
Methods 4 Return values TABLE 568 Return values Parameters Type Description bgpNetworkL ist BgpAdvertiseNetworkConfig Error messages List of Error Messages getBgpGlobalConfig Description Retrieves the BGP global configuration. Parameters Table 569 contains the parameters required by the method. TABLE 569 Parameters Parameters Type Presence version bgpVersionEnum Optional Rules Description The BGP4 or BGP4+ version.
4 Methods Return values Table 572 contains the return values of the method. TABLE 572 Return values Parameters Type Description config BgpNeighborDetails Error messages List of Error Messages getIPv6InterfaceDetails Description This API retrieves IPv6 interface information for a specific interface provided as input. It supports Ethernet, Loopback and Virtual interfaces. Parameters Table 573 contains the parameters required by the method.
Methods 4 Return values Table 575 contains the return values of the method. TABLE 575 Return values Parameters Type Description trafficSummary IPv6TrafficSummary Data structure containing the IPv6 traffic information. Error messages List of Error Messages getOspfConfig Description Retrieves all of the OSPF configuration details. Parameters None. Return values Table 576 contains the return values of the method.
4 Methods getOspfGlobalConfig Description Retrieves the OSPF global configuration. Parameters Table 578 contains the parameters required by the method. TABLE 578 Parameters Parameters Type Presence version ipVersionEnum Optional Rules Description The IPv4 or IPv6 version. Return values Table 579 contains the return values of the method. TABLE 579 Return values Parameters Type Description config OspfGlobalConfig Retrieves the OSPF global configuration.
Methods 4 Parameters None. Return values Table 582 contains the return values of the method. TABLE 582 Return values Parameters Type Description memory OspfMemory Retrieves the OSPF memory parameters. Error messages List of Error Messages getOspfTrap Description Retrieves the OSPF trap details. Parameters None. Return values Table 583 contains the return values of the method. TABLE 583 Return values Parameters Type Description trap OspfTrapConfigInfo Retrieves the OSPF trap parameters.
4 Methods Return values Table 585 contains the return values for the method. TABLE 585 Return values Name Type Description globalTcpMss GlobalTcpMss Global TCP MSS configuration. mssList TcpMss[] List of TCP MSS values for pass-through IP addresses. Error messages List of Error Messages setBgpAdvertiseNetworkConfig Description Sets the BGP advertise network configuration. Parameters Table 586 contains the parameters required by the method.
Methods 4 setBgpNeighborConfig Description Sets the BGP neighbor configuration. Parameters Table 588 contains the parameters required by the method. TABLE 588 Parameters Parameters Type Presence neighborList BgpNeighborConfig[] Mandatory Rules Description Sets the BGP neighbor configuration. Return values None Error messages List of Error Messages setOspfGlobalConfig Description Sets the OSPF global configuration. Parameters Table 589 contains the parameters required by the method.
4 Methods Parameters Table 590 contains the parameters required by the method. TABLE 590 Parameters Parameters Type Presence config OspfInterfaceConfig[] Mandatory Rules Description Sets the OSPF interface configuration. Return values None. Error messages List of Error Messages updateBgpAdvertiseNetworkConfig Description Updates the BGP advertise network configuration. Parameters Table 591 contains the parameters required by the method.
Methods 4 Error messages List of Error Messages updateBgpNeighborConfig Description Updates the BGP neighbor configuration. Parameters Table 593 contains the parameters required by the method. TABLE 593 Parameters Parameters Type Presence Rules neighborList BgpNeighborConfig[] Mandatory Description Updates the BGP neighbor configuration. Return values None Error messages List of Error Messages updateGlobalTcpMss Description Updates the global TCP maximum segment sizes.
4 Data structures Parameters Table 595 contains the parameters required by the method. TABLE 595 Parameters Parameters Type Presence Rules Description version ipVersionEnum Mandatory IPv4 or IPv6 version config OspfGlobalConfig Optional Update the OSPF global configuration Return values None. Error messages List of Error Messages updateOspfInterfaceConfig Description Updates the OSPF interface configuration. Parameters Table 596 contains the parameters required by the method.
Data structures 4 ActiveStpTimer This structure is a high-level description of an active Spanning Tree Protocol (STP) timer. TABLE 598 Attributes Name Type Presence Rules Description messageAge unsignedInt Optional The number of seconds the port has been waiting for a hello message from the root bridge. forwardDelay unsignedInt Optional The number of seconds that have passed since the last topology change and consequent re-convergence.
4 Data structures ArpCache This structure is a high-level description of an Address Resolution Protocol (ARP) cache. TABLE 601 Attributes Name Type Presence Rules Description routeNumber unsignedInt Optional ID of the entry. ipAddress string Optional The IP address of the device. macAddress string Optional The MAC address of the device.
Data structures TABLE 603 4 Attributes Name Type Presence Rules Description invalidSourceCount unsignedLong Optional Invalid source count. pendingDropCount unsignedLong Optional Pending drop count. ArpSummary This structure is a high-level description of an ARP summary. TABLE 604 Attributes Name Type Presence Rules Description totalReceived unsignedInt Optional Total number of packets received. requestReceived unsignedInt Optional Number of the requests received.
4 Data structures TABLE 606 Attributes Members Type Presence interface InterfaceID Optional The interface through which the router is connected to the neighbor. routeMap string Optional The route map name. Rules Description BgpAdvertiseNetwork This structure is a high-level description of BGP advertise network information. TABLE 607 Attributes Members Type Presence Rules Description address string Optional IP address.
Data structures 4 BgpGlobalConfig This structure is the high level description of BGP global configuration for BGP4 and BGP4+. TABLE 610 Attributes Members Type Presence Rules Description version bgpVersionEnum Mandatory The BGP4 or BGP4+ version. ProtocolState boolean Optional Enable/Disable BGP4 or BGP4+. Originatedefault boolean Optional Enable/Disable default originate. localASNumber unsignedInt Optional Local AS number.
4 Data structures TABLE 612 Attributes Members Type Presence Rules Description passwordType bgpPasswordTypeEnum Optional Password string Optional Max 80 Chars Simple encryption keepAlive unsignedInt Optional 1-65535 Keep alive Interval holdTime unsignedInt Optional 1-65535 Hold Interval weight unsignedInt Optional default is 0 Weight MaximumASPath unsignedInt Optional 0-300 Maximum AS Path allowASin unsignedInt Optional Allow AS number localAS unsignedInt Optional
Data structures TABLE 613 4 Attributes Members Type Presence time string Optional The amount of time this session has been in the current state. keepAliveTime unsignedInt Optional The keep alive time. holdTime unsignedInt Optional The hold time.
4 Data structures BgpNeighborInfo This structure is a holder of BGP neighbor information. TABLE 614 Attributes Members Type Presence Rules Description bgp4neighborsList Bgp4Neighbor[] Optional The BGP4 neighbor. bgp4PlusneighborsList Bgp4PlusNeighbor[] Optional The BGP4+ neighbor. BgpNeighborSummaryFilter This structure is a holder of BGP neighbor filter information.
Data structures TABLE 617 4 Attributes Members Type Presence Rules Description prefixLength unsignedInt Optional Prefix length routeMap string Optional Route map name BgpRoute his structure is a holder of BGP route. TABLE 618 Attributes Members Type Presence Rules Description networkIP string Optional IPv6 address.
4 Data structures BgpRouteSummarySimpleFilter This structure is a high-level description of BGP route simple filter information. TABLE 621 Attributes Parameters Type Presence field bgpRouteSummaryFilterFieldEnum operator filterOperatorEnum value string startValue string endValue string Rules Description BgpSessionStatistics This structure is a description of statistics for a BGP session.
Data structures TABLE 622 4 Attributes Members Type Presence Rules Description sendQueue unsignedInt optional The number of sequence numbers in the send queue. receiveQueue unsignedInt optional The number of sequence numbers in the receive queue. windowChange unsignedInt optional The number of times the window has changed. EthernetCounters This structure is a high-level description of Ethernet counters.
4 Data structures TABLE 623 Attributes (Continued) Name Type Presence Rules Description inErrors unsignedInt Optional The total number of packets received that contained one of the following errors: • CRC error – Applies to regularly sized packets between 64 bytes and the maximum allowable frame size. • Oversize – Applies to packets longer than the maximum allowable frame size but with a valid CRC.
Data structures TABLE 623 4 Attributes (Continued) Name Type Presence Rules Description inPacketsPerSecond unsignedInt Optional The number of packets received per second. outPacketsPerSecond unsignedInt Optional The number of packets sent per second. inUtilization Float Optional The percentage of the port’s bandwidth used by received traffic. outUtilization Float Optional The percentage of the port’s bandwidth used by sent traffic.
4 Data structures GlobalIPInfo This structure is the high-level description of global IP information. TABLE 626 Attributes Parameters Type Presence Rules Description timeToLive unsignedInt Optional Valid value range is from 64 to 9216. Make sure that the IP MTU of the interfaces is always greater than the MSS value. This parameter is used to define the Global TCP MSS IPv4 value for all SYN-ACK packets generated by a Virtual ADX.
Data structures TABLE 627 4 Attributes (Continued) Name Type Presence Rules Description changeCount unsignedInt Optional The number of times the topology has changed since this device was reloaded. bridgeAddress string Optional Spanning tree address of the device or VLAN. GlobalTcpMss This structure is the high-level description of global TCP Mss IPv4/IPv6 confguration.
4 Data structures GlobalTcpMss This structure is the high-level description of global TCP Mss IPv4/IPv6 confguration. TABLE 630 Attributes Parameters Type Presence Rules Description mssV4 unsignedInt Optional Valid value range is from 64 to 9216. Make sure that the IP MTU of the interfaces is always greater than the MSS value. This parameter is used to define the Global TCP MSS IPv4 value for all SYN-ACK packets generated by a Virtual ADX.
Data structures TABLE 632 4 Attributes (Continued) Name Type Presence Rules Description redirect unsignedLong Optional The number of redirect messages sent or received by the device. echo unsignedLong Optional The number of echo messages sent or received by the device. echoReply unsignedLong Optional The number of echo reply messages sent or received by the device. timeStamp unsignedLong Optional The number of Timestamp messages sent or received by the device.
4 Data structures TABLE 634 250 Attributes Members Type Presence Rules Description parameterProblem unsignedLong Mandato ry The number of Parameter Problem messages sent or received by the router. echoRequest unsignedLong Mandato ry The number of Echo Request messages sent or received by the router. echoReply unsignedLong Mandato ry The number of Echo Reply messages sent or received by the router.
Data structures TABLE 634 4 Attributes Members Type Presence Rules Description badLen unsignedLong Optional Available for ICMP received related values The number of Bad Length messages received by the router. reflect unsignedLong Optional Available for ICMP received related values The number of reflect messages received by the router.
4 Data structures TABLE 635 252 Attributes (Continued) Name Type Presence Rules Description configuredGigabitMode portSpeedGigabitModeEnum Optional actualAutoNegotiateState twoWayToggleEnum actualSpeed portSpeedEnum Optional The actual port speed. actualDuplex portDuplexTypeEnum Optional The actual duplex type. actualGigabitMode portSpeedGigabitModeEnum Optional The actual gigabit mode. configuredTrunkState twoWayToggleEnum Optional Configures the trunk state.
Data structures TABLE 635 4 Attributes (Continued) Name Type Presence Rules Description isStpEnabled boolean Optional Enables or disables STP. priorityLevel unsignedInt Optional The priority level. flowControlState twoWayToggleEnum Optional The flow control state. mirrorState twoWayToggleEnum Optional The mirror state. monitorState pvstMethodEnum Optional The monitor state. mtu unsignedInt Optional The maximum transmission unit.
4 Data structures TABLE 636 Attributes (Continued) Name Type Presence Rules Description priorityLevel unsignedInt Optional The priority level. macAddress string Optional The MAC address. InterfaceConfig This structure is the high-level description of the interface configuration. TABLE 637 254 Attributes Name Type Presence Rules Description id InterfaceID Mandatory In Switch mode only “ETHERNET” and “MANAGEMENT” interface types are supported. The interface ID.
Data structures TABLE 637 4 Attributes (Continued) Name Type Presence Rules Description duplex portDuplexTypeEnum Optional Valid only when the interface type is ETHERNET. This parameter is mandatory when the “isAutoNegotiation” parameter is either not present or set to “FALSE”. This parameter is mandatory when the “speed” parameter is present. When the “speed” parameter is “1_GIGABIT”, this parameter value is not considered.
4 Data structures TABLE 637 Attributes (Continued) Name Type Presence Rules Description mtu unsignedInt Optional The valid value range is from 576 to 9216 bytes. This parameter is valid in Router mode only and invalid when the interface type is ETHERNET or MANAGEMENT. Sets the Maximum Transmission Unit for this interface. isRouteOnly boolean Optional This parameter is valid in Router mode only and when the interface type is ETHERNET.
Data structures 4 InterfaceID This structure is a high-level description of the IP interface identifier. TABLE 639 Attributes Name Type Presence Rules Description portString string Optional When this parameter is present as part of the request message, the parameters “portString”, “slot”, and “port” must not be present. The interface port string. For example, Ethernet “1” or “1/1”; Loopback “lb1” or “lb2”.
4 Data structures TABLE 640 Attributes (Continued) Name Type Presence Rules Description giantPacketCount unsignedInt Optional The count of giant packets. dmaReceivedPacketCount unsignedInt Optional The count of DMA received packets. InterfaceIPAddress This structure contains the high-level description of an IP address in an interface. TABLE 641 258 Attributes Name Type Presence Rules Description ip string Mandatory subnetMask string Optional Valid only for IPv4 addresses.
Data structures TABLE 641 4 Attributes Name Type Presence Rules Description isPassiveOspf boolean Optional This is valid only for IPv4 addresses. When this parameter is present, both "isSecondary" and "ignoreOspf" must not be present. This option disables the adjacency formation with OSPF neighbors. useLinkLocal boolean Optional Valid only for IPv6 addresses and when "subnetMaskLengt h" is absent. Use the link-local address. isAnycast boolean Optional Valid only for IPv6 addresses.
4 Data structures InterfaceStatistics This structure is the high-level description of the summary information of interface statistics. TABLE 643 Attributes Name Type Presence Rules Description loadInterval unsignedInt Optional The value is in seconds. The load interval for finding bit rate and packet rate and their utilization. bitRate unsignedInt Optional The value is in bits per second. The received or transmitted bit rate.
Data structures 4 InterfaceStatisticsSummaryFilter This structure is the high-level description of the filter for interfaces statistics summary. TABLE 645 Attributes Name Type Presence simpleFilter InterfaceStatisticsSummarySimpleFilter Optional Rules Description Simple filter description. InterfaceStatisticsSummarySimpleFilter This structure is the high-level description of the simple filter for interfaces statistics summary.
4 Data structures TABLE 647 Attributes (Continued) Name Type Presence Rules Description adminStatus twoWayToggleEnum Optional The default value is "ENABLED". The status of the port. runtimeStatus protocolStatusEnum Optional Valid only as part of the response message. Ignored when the present in the request message. The runtime status of the port. InterfaceSummaryFilter This structure is the high-level description of a filter for the interfaces summary.
Data structures 4 IPFwdCacheInfo This structure is a high-level description of IP forward cache information. TABLE 651 Attributes Name Type Presence Rules Description ipAddress string Optional The IP address of the destination. nextHop string Optional The IP address of the next-hop router to the destination. macAddress string Optional The MAC address of the destination. hostType string Optional The type of host entry.
4 Data structures IPInterfaceInfo This structure is a high-level description of IP interface information. TABLE 654 Attributes Name Type Presence Rules Description interfaceName string Optional The type and the slot and port number of the interface. portState string Optional Port state. ipMask string Optional The subnet mask. ipAddress string Optional The IP address of the interface. configStatus string Optional The IP address has been configured on the interface.
Data structures 4 IPRouteInfo This structure is a high-level description of IP route information. TABLE 656 Attributes Name Type Presence Rules Description destination string Optional The destination network of the route. networkMask string Optional The network mask of the destination address. gateway string Optional The next-hop router. port string Optional The port through which this router sends packets to reach the route's destination.
4 Data structures IPsec This structure is a high-level description of OSPF internet protocol security information.
Data structures TABLE 661 4 Attributes Name Type Presence Rules Description startValue string Mandatory This parameter is mandatory and considered only when the "operator" value is "RANGE". Start value in a range. endValue string Mandatory This parameter is mandatory and considered only when the "operator" value is "RANGE". End value in a range. IPStatistics This structure is a high-level description of IP statistics.
4 Data structures IPSubnetVlan This structure is a high-level description of the IP subnet VLAN. TABLE 663 Attributes Name Type Presence Rules Description ipAddress string Optional IP address. ipMask string Optional IP mask. vlanID string Optional VLAN ID vlanName string Optional VLAN name. ports InterfaceID[] Optional Port information. enableDynamicPort boolean Optional Enable or disable port. routeInfo VlanRoutingInterface Optional Routing interface details.
Data structures 4 IPv6CacheSimpleFilter This structure is the high-level description of an IPv6 cache simple filter. TABLE 666 Attributes Members Type Presence Rules Description field bgpNeighborSummaryFilterFieldEnum Mandatory Filter field name. operator bgpNeighborSummaryFilterFieldEnum Mandatory Filter operator type. value string Optional Ignored when the “operator” value is “RANGE”. The value of the field for filtering.
4 Data structures IPv6CacheSummary This structure is the high-level summary of an IPv6 Cache. TABLE 668 Attributes Members Type Presence Rules Description ipString string Mandatory Maximum string length 64 The host IPv6 address. nextHop string Mandatory Maximum string length 64 The next hop, which can be one of the following: • Direct – The next hop is directly connected to the router. • Local – The next hop is originated on this router.
Data structures TABLE 670 4 Attributes Members Type Presence maxTransmissionUnit unsignedInt neighborDiscovery NeighborDiscovery aclList AccessListSummary[] globalUnicastAddress IPv6GlobalAddress[] joinedGroupAddress string[] ripEnabled boolean ospfEnabled boolean isisEnabled boolean stateLess boolean stateFull boolean encapsulation string vlanIndex unsignedInt vlanType unsignedInt Rules Description IPv6InterfaceFilter This structure is the high-level description of an IPv
4 Data structures IPv6InterfaceSummary This structure is the high-level description of and IPv6 interface. TABLE 673 Attributes Members Type Presence Rules Description interface string Mandatory Maximum string length 64 The interface type, and the port number or number of the interface. status string Mandatory Maximum string length 64 The status of the interface. The entry in the Status field will be either “up/up” or “down/down”.
Data structures TABLE 675 4 Attributes Members Type Presence Rules Description startValue string Optional This parameter is Optional and considered only when “operator” value is “RANGE”. Start value in a range. endValue string Optional This parameter is Optional and considered only when “operator” value is “RANGE”. End value in a range. IPv6NeighborSummary This structure is the high-level description of an IPv6 neigbor.
4 Data structures TABLE 677 274 Attributes Members Type Presence Rules Description badVersion unsignedLong Mandatory The number of IPv6 packets dropped by the router because the version number is not 6. badScope unsignedLong Mandatory The number of IPv6 packets dropped by the router because of a bad address scope. badOptions unsignedLong Mandatory The number of IPv6 packets dropped by the router because of bad options.
Data structures 4 IPv6TrafficSummary This structure is the high-level description of IPv6 Traffic summary. TABLE 678 Attributes Members Type Presence Rules Description ipv6Statistics IPv6Statistics Mandatory IPv6 statistics. recvIcmpStatistics Icmpv6Statistics Mandatory ICMP received statistics. sentIcmpStatistics Icmpv6Statistics Mandatory ICMP sent statistics. sentErrors SentErrors Mandatory ICMP sent errors. tcpStatistics TcpStatistics Mandatory TCP statistics.
4 Data structures TABLE 681 Attributes Name Type Presence Rules Description macType macInfoTypeEnum Type of MAC entry. dmaFlag string DMA Flags (if any) programmed in Layer 2 tables. MacEntryFilter This structure is a high-level description of MAC entry filter. TABLE 682 Attributes Name Type simpleFilter MacSimpleFilter Presence Rules Description MacSimpleFilter This structure is a high-level description of MAC simple filter information.
Data structures TABLE 684 4 Attributes Members Type Presence Rules Description advReachableTime unsignedInt Mandatory Neighbor discovery advertised reachable time. retransmitIntervalTime unsignedInt Mandatory Neighbor discovery retransmit interval. advRetransmitIntervalTime unsignedInt Mandatory Neighbor discovery advertised retransmit. routerAdvertismentInterval unsignedInt Mandatory Neighbor discovery router advertisements.
4 Data structures TABLE 686 Attributes Members Type Presence Rules Description summary string Optional Summary is enabled or disabled areaRange OspfAreaRange Optional Address range OspfAreaID This structure is a holder of an OSPF area array.
Data structures 4 OspfAreaSummarySimpleFilter This structure is a high-level description of OSPF area simple filter information. TABLE 691 Attributes Parameters Type Presence Rules Description field ospfAreaSummaryFilterFieldEnum Mandatory Filter field name. operator filterOperatorEnum Mandatory Filter operator type. value string Optional Ignored when the "operator" value is "RANGE". The value of the field for filtering.
4 Data structures OspfBRSummarySimpleFilter This structure is a high-level description of OSPF interface filter information. TABLE 694 Attributes Parameters Type Presence Rules Description field ospfBRSummaryFilterFieldEnum Mandatory Filter field name. operator filterOperatorEnum Mandatory Filter operator type. value string Optional Ignored when the "operator" value is "RANGE". The value of the field for filtering.
Data structures TABLE 695 4 Attributes Members Type Presence Rules Description area OspfInterfaceConfigInfo[] Optional The range is from 0 through 2147483647 Area details Interface OspfVirtualLinkConfigInfo[] Optional Max number of interface supported Interface details virtualLink OspfVirtualLinkConfigInfo[] Optional Virtual link details redistribution OspfRedistributionConfigInfo[] Optional Redistribution details OspfDatabase This structure is a high-level description of OSPF IPv
4 Data structures OspfDatabaseSummarySimpleFilter This structure is a high-level description of OSPF database simple filter information. TABLE 698 Attributes Parameters Type Presence Rules Description field ospfNeighborDetailSummaryFilterFieldEnum Mandatory Filter field name. operator filterOperatorEnum Mandatory Filter operator type. value string Optional Ignored when the "operator" value is "RANGE". The value of the field for filtering.
Data structures TABLE 699 4 Attributes Members Type Presence logStatusChange boolean Optional keyRolloverInterval unsignedInt Optional Rules Description Enable/disable OSPFv3 logging events 0-14400,default Rollover interval is 300 OspfInterfaceConfig This structure is a high-level description of OSPF interface configurations for IPv4 and IPv6.
4 Data structures TABLE 700 Attributes Members Type Presence Rules Description retransmitInterval unsignedInt Optional The range is from 0 through 3600 sec, the default is 5 seconds Interval between retransmission of LSA transmitDelay unsignedInt Optional The range is from 0 through 3600 sec, the default is 1 second Interval between link state updates ipv6InterfaceConfig OspfIPv6InterfaceConfig Optional IPv6 interface details OspfInterfaceConfigInfo This structure is a high-level desc
Data structures TABLE 702 4 Attributes Parameters Type Presence Rules Description startValue string Mandatory This parameter is mandatory and considered only when the "operator" value is "RANGE". Start value in a range. endValue string Mandatory This parameter is mandatory and considered only when the "operator" value is "RANGE". End value in a range. OspfInterfaceSummaryFilter This structure is a high-level description of OSPF interface filter information.
4 Data structures TABLE 705 286 Attributes Members Type Presence Rules Description ip string Optional The IP address of the interface areaID string Optional Area ID state string Optional OSPF state pri unsignedInt Optional Priority cost unsignedInt Optional Cost options unsignedInt Optional - unused - opaque - summary dont_propagate - nssao multicast - externalso tos OSPF options type string Optional o Broadcast o NBMA o Point to Point o Virtual Link o Point to Multipoi
Data structures 4 OspfIPv4Neighbor This structure is a high-level description of OSPF IPv4 Neighbor information. TABLE 706 Attributes Members Type Presence Rules Description versionFlag ipVersionEnum Mandatory IP version port InterfaceID Optional Port through which neighbor is connected. address string Optional IP address of the router priority unsignedInt Optional OSPF priority of the neighbor.
4 Data structures TABLE 707 Attributes Members Type Presence Rules Description pathType ospfPathTypeEnum Optional Path type advRouter string Optional Router that advertise the route. linkState string Optional Link state from which route is calculated. destType ospfDestTypeEnum Optional Destination type routeState ospfRouteStateEnum Optional Route state tag unsignedInt Optional External route tag flags unsignedInt Optional State information for route entry.
Data structures TABLE 708 4 Attributes Members Type Presence Rules Description arpIndex unsignedInt Optional The index position in the ARP table of the ARP entry for this path's IP address. state string Optional State information of the path. OspfIPv4Route This structure is a high-level description of an OSPF IPv4 route information.
4 Data structures TABLE 710 Attributes Members Type ipSec Ipsec interface InterfaceID areaScopedLsa unsignedInt areaLsaCheckSum unsignedInt spfExecuted unsignedInt spfUpdated unsignedInt spfNodeCount unsignedInt router unsignedInt network unsignedInt hopCount unsignedInt Presence Rules Description OspfIPv6Interface This structure is a high-level description of OSPF IPv6 interface information.
Data structures 4 OspfIPv6Neighbor This structure is a high-level description of OSPF IPv6 neighbor information. TABLE 713 Attributes Members Type Presence versionFlag ipVersionEnum Mandatory IP version routerID string Optional IPv4 address of neighbor. priority unsignedInt Optional OSPFv3 priority of the neighbor. state string Optional dr string Optional The router ID (IPv4 address) of the Designated router.
4 Data structures TABLE 714 Attributes Members Type Presence Rules Description areaID unsignedInt Optional External1 External2 The number of external routes. type1Cost unsignedInt Optional Type1 cost type2Cost unsignedInt Optional Type2 cost nextHop string Optional Next Hop. outgoingInterface InterfaceDetails Optional Outgoing interface pathType ospfPathTypeEn um OspfInterfaceInfo This structure is a high-level description of OSPF interface information.
Data structures TABLE 717 4 Attributes Members Type Presence Rules Description ospf6LsaHdr OspfMemorySize Optional The type of memory used by OSPFv3. ospf6RmapCompiled OspfMemorySize Optional The type of memory used by OSPFv3. ospf6Other OspfMemorySize Optional The type of memory used by OSPFv3. threadMaster OspfMemorySize Optional The type of memory used by OSPFv3. ospf6Area OspfMemorySize Optional The type of memory used by OSPFv3.
4 Data structures OspfNeighborDetailSummaryFilter This structure is a high-level description of OSPF neighbor detail filter information. TABLE 719 Attributes Parameters Type Presence Rules simpleFilter OspfNeighborDetailSummarySimpleFilter Mandatory Description Filter field name. OspfNeighborDetailSummarySimpleFilter This structure is a high-level description of OSPF neighbor detail filter information.
Data structures 4 OspfNeighborSummarySimpleFilter This structure is a high-level description of OSPF neighbor filter information. TABLE 723 Attributes Parameters Type Presence Rules Description field ospfNeighborSummaryFilterFieldEnum Mandatory Filter field name. operator filterOperatorEnum Mandatory Filter operator type. value string Optional Ignored when the "operator" value is "RANGE". The value of the field for filtering.
4 Data structures OspfRouteInfo This structure is a holder of OSPF route information. TABLE 726 Attributes Members Type Presence Rules Description ipv4route OspfIPv4Route [] Optional 10 IPv4 route ipv6routeCount OspfIPv6RouteCo unt Optional 10 IPv6 route ipv6route OspfIPv6Route [] Optional 10 IPv6 route OspfRouteSummaryFilter This structure is a high-level description of OSPF route filter information.
Data structures 4 OspfTrapConfigInfo This structure is a high-level description of OSPF trap configurations. TABLE 729 Attributes Members Type Presence Rules Description interfaceStateChange string Optional Signifies a non-virtual OSPF interface state change. virtualInterfaceStateChange string Optional Signifies a virtual OSPF interface state change. neighborStateChange string Optional Signifies a non- virtual OSPF neighbor state change.
4 Data structures TABLE 730 Attributes Members Type Presence Rules Description authenticationKey string Optional Authentication key of the virtual link md5AuthenticationKey string Optional Md5 authentication key of the virtual link md5AuthenticationKeyID unsignedInt Optional Md5 authentication key ID of the virtual link deadInterval unsignedInt Optional Dead interval of the virtual link helloInterval unsignedInt Optional Hello interval of the virtual link retransmitInterval uns
Data structures 4 PvstInfo This structure is the high-level description of Pvst information. TABLE 733 Attributes Members Type Presence port string method unsignedInt Rules Description ResponseInformation This structure is the high-level description of response information. TABLE 734 Attributes Members Type Presence timeRetrievedAt string totalEntriesAvailable unsignedInt Rules Description RequestHeader This structure is a high-level description of request header.
4 Data structures TABLE 736 Attributes (Continued) Name Type Presence Rules Description badAddressFamily unsignedLong Optional The number of RIP packets dropped because the value in the Address Family Identifier field of the packet's header was invalid. badRequestFormat unsignedLong Optional The number of RIP request packets this router dropped because the format was bad. badMetrics unsignedLong Optional This information is used by Brocade customer support.
Data structures 4 SourceIP This structure is the high-level description of SourceIP configuration. TABLE 738 Attributes Name Type Presence Rules Description sourceIPType sourceIPTypeEnum Optional In Router mode, the only valid value is SOURCE_NAT_IP. This parameter is optional, and when absent, SOURCE_NAT_IP is the default value. In Switch mode, this parameter is mandatory. The type of source IP (Source IP or Source NAT IP or Source Standby IP).
4 Data structures SourceIPSimpleFilter This structure is the high-level description of a simple filter for Source IP. TABLE 740 Attributes Name Type Presence Rules Description Field sourceIPFilterFieldEnum Mandatory Simple filter description. Operator filterOperatorEnum Mandatory Filter operator type. Value string Optional Ignored when the "operator" value is "RANGE". The value of the field for filtering.
Data structures 4 Stp This is a high-level description of STP. TABLE 742 Attributes Name Type Presence Rules Description enableStp boolean Mandatory enableRstp boolean Enable or disable RSTP. enable8021w boolean Enable Rapid Spanning Tree IEEE 802.1w. enabledSingle boolean Enable single spanning tree. forwardDelay unsignedInt Optional 4 to 30 seconds. Default 15 sec The period of time a bridge will wait before beginning to forward data packets.
4 Data structures TABLE 743 Attributes (Continued) Name Type Presence Rules Description designatedBridge string Optional The MAC address of the designated bridge to which this port is connected. The designated bridge is the device that connects the network segment on the port to the root bridge. designatedPort string Optional The port number sent from the designated bridge.
Data structures 4 StpOtherInfo This is a high-level description of an STP summary. TABLE 745 Attributes Name Type Presence Rules Description enableStpParam Boolean Enables STP. stpInfo Stp The data structure containing the STP information. ports InterfaceID[ ] The interface number. stpTypr stpTypeEnum The STP type. vLanID String The VLAN ID. enableDualMode twoWayToggleEnum Enable or disable dual mode. autoEnable twoWayToggleEnum The value set by the system software.
4 Data structures TABLE 747 306 Attributes (Continued) Name Type Presence Rules Description subnetMaskLength unsignedInt Optional Either the subnetMask or the subnetMaskLength attribute must be present. Both cannot be present together. The IP subnet mask length. useLinkLocal boolean Optional Valid only for IPv6 address and when "subnetMaskLengt h" is not present, otherwise will be ignored. Use link-local address.
Data structures 4 SwitchIPConfig This structure is the high-level description of TCP maximum segment size configuration. TABLE 748 Attributes Name Type Presence enableIpv6AutoConfig boolean ipv6ReachableTime unsignedInt Rules Description TcpMss This structure is the high-level description of TCP maximum segment size configuration. TABLE 749 Attributes Name Type Presence Rules Description Mss unsignedInt Mandatory The valid value range is from 64 to 9176 bytes.
4 Data structures TABLE 750 Attributes Name Type Presence Rules Description outSegments unsignedLong Optional The number of TCP segments sent by the device. retransmission unsignedLong Optional The number of segments that this device retransmitted because the retransmission timer for the segment had expired before the device at the other end of the connection acknowledged receipt of the segment.
Data structures TABLE 752 4 Attributes Name Type sentTimestampReplyMessages unsignedInt sentAddressMaskRequestMessages unsignedInt sentAddressMaskReplyMessages unsignedInt sentIrdpAdvertisementMessages unsignedInt sentIrdpSolicitationMessages unsignedInt receivedMessages unsignedInt receivedNumberErrors unsignedInt receivedUnreachableMessages unsignedInt receivedTimeExceededMessages unsignedInt receivedParameterProblemMessages unsignedInt receivedSourceQuenchMessages unsignedInt
4 Data structures TABLE 753 Attributes Name Type Presence Rules Description unknownProtocolPac kets unsignedInt The number of packets dropped by the device because the value in the Protocol field of the packet header is unrecognized by this device. sentPackets unsignedInt The total number of IP packets originated and sent by the device. reassembledPackets unsignedInt The total number of fragmented IP packets that this device re-assembled.
Data structures TABLE 754 4 Attributes Name Type Presence Rules Description totalOutSegments unsignedInt Displays the number of TCP segments sent by the device. totalInSegments unsignedInt Displays the number of TCP segments received by the device. V4UdpStatistics This structure is a high-level description of IPv4-based UDP statistics.
4 Data structures TABLE 756 312 Attributes Name Type Presence Rules Description sentTimestampMessages unsignedInt The number of Timestamp messages sent by the device. sentTimestampReplyMessages unsignedInt The number of Timestamp Reply messages sent by the device. sentAddressMaskRequestMessages unsignedInt The number of Address mask Request messages sent by the device. sentAddressMaskReplyMessages unsignedInt The number of Address mask Replies messages sent by the device.
Data structures 4 V6IpStatistics This structure is a high-level description of IPv6-based IP statistics. TABLE 757 Attributes Name Type receivedPackets unsignedInt The total number of IP packets received by the device. forwardedPackets unsignedInt Displays the total number of IP packets received by the device and forwarded to other devices. fragmentedPackets unsignedInt The total number of IP packets fragmented by this device to accommodate the MTU of this device or of another device.
4 Data structures V6IcmpStatistics This structure is a high-level description of IPv6-based TCP statistics.
Data structures TABLE 758 4 Attributes Name Type neighborAdvertisementMessagesSent unsignedInt redirectMessagesSent unsignedInt ErrorMessagesSent unsignedInt cantSendMessagesSent unsignedInt tooFrequentMessagesSent unsignedInt unreachableErrorMessagesSent unsignedInt adminErrorMessagesSent unsignedInt addressErrorMessagesSent unsignedInt beyondScopeErrorMessagesSent unsignedInt noPortErrorMessagesSent unsignedInt packetTooBigErrorMessagesSent unsignedInt timeExceededTransitErrorM
4 Data structures TABLE 759 Attributes Name Type Presence Rules Description totalPassiveOpenConnections unsignedInt Displays the number of TCP connections opened by this device in response to connection requests (TCP SYNs) received from other devices. totalPassivResetConnetions unsignedInt Displays the number of TCP connections this device reset because the device at the other end of the connection sent a TCP RESET message.
Data structures TABLE 761 4 Attributes Members Type Presence Rules Description interfaceRetransmitPacket string Optional Signifies than an OSPF packet has been retransmitted on a non- virtual interface. virtualInterfaceRetransmitPacket string Optional Signifies than an OSPF packet has been retransmitted on a virtual interface. originateLsa string Optional Signifies that a new LSA has been originated by this router.
4 Data structures VlanFilter This structure is a high-level description of a VLAN filter. TABLE 764 Name Attributes Type Presence simpleFilter VlanSimpleFilter Rules Description Mandatory VLAN filter field name. VlanGroup This structure is a high-level description of a VLAN group. TABLE 765 Attributes Name Type Presence Rules Description vlanGroupID unsignedInt Mandatory VLAN group ID. vlanIDs string Mandatory VLAN IDs to group.
Data structures 4 VlanSimpleFilter This structure is a high-level description of a simple VLAN filter. TABLE 768 Attributes Name Type Presence Rules Description field vlanFilterFieldEnum Mandatory Filter field name. operator filterOperatorEnum Mandatory Filter operator type. value string Optional Ignored when the "operator" value is "RANGE". The value of the field for filtering.
4 Data structures VRIDDetails This structure is a high-level description of VRID details.
Data structures TABLE 771 4 Attributes Members Type Presence Rules Description Priority unsignedInt Optional 3-254 Master/Backup priority helloInterval unsignedInt Optional 1-84 sec/ 60-3600 sec Master/ backup router’s hello message interval deadInterval unsignedInt Optional 1-84 sec Backup router’s hello message interval advertiseBack twoWayToggleEnum Optional Enable a backup to send Hello messages backupPreempt twoWayToggleEnum Optional Enable/disable preemption on a Backup
4 Data structures TABLE 774 Attributes Members Type Presence Rules Description VRID unsignedInt Optional VRID state vrrpStateEnum Optional Init/Master/Backup mode vrrpRouterTypeEnum Optional OWNER or BACKUP maskBit unsignedInt priority unsignedInt Optional 3-254 Master/Backup priority helloInterval unsignedInt Optional 1-84 sec/60-36 00 sec Master/ backup router’s hello message interval deadInterval unsignedInt Optional 1-84 sec Backup router’s dead interval advertiseBac
Data structures 4 VrrpInterfaceSummarySimpleFilter This structure is a high-level description of a VRRP interface summary simple filter. TABLE 777 Attributes Parameters Type Presence Rules Description field vrrpInterfaceSummaryFilterFieldEnum Mandatory Filter field name. operator filterOperatorEnum Mandatory Filter operator type. value string Optional Ignored when the “operator” value is “RANGE”. The value of the field for filtering.
4 Enumerations TABLE 779 Attributes Parameters Type Presence Rules Description value string Optional Ignored when the “operator” value is “RANGE”. The value of the field for filtering. startValue string Mandatory This parameter is mandatory and considered only when “operator” value is “RANGE”. Start value in a range. endValue string Mandatory This parameter is mandatory and considered only when “operator” value is “RANGE”. End value in a range.
Enumerations 4 bgpNeighborSummaryFilterFieldEnum This type of data describes the enumerations for the BGP neigbor summary filter field. TABLE 782 Attributes Members Description ACTIVATE The state LOCAL_AS The Local AS REMOTE_AS The Remote AS WEIGHT The weight NEIGHBOR_ADDRESS The neighbor address bgpPasswordTypeEnum This type of data describes the enumerations for the BGP password type.
4 Enumerations bgpSessionStateEnum This type of data describes the enumerations for the BGP session state. TABLE 786 Attributes Parameters Description IDLE The BGP4 process is waiting to be started. ADMND The neighbor has been administratively shut down CONNECT The BGP4 is waiting for the connection process for the TCP neighbor session to be completed. ACTIVE The BGP4 is waiting for a TCP connection from the neighbor OPEN_SENT The BGP4 is waiting for an Open message from the neighbor.
Enumerations 4 filterOperatorEnum This type of data describes the enumerations for a filter operator. TABLE 790 Attributes Parameters Description CONTAINS Applicable only on string type fields. LESS_THAN Applicable only on Integer type fields. GREATER_THAN Applicable only on integer type fields. EQUAL_TO Applicable only on Integer or boolean or enumeration type fields. NOT_EQUAL MASK Applicable only on IP or subnet mask or MAC address fields.
4 Enumerations TABLE 793 Attributes Parameters Description PORT Identifier for the “interfaceStatisticsSummary->id->port” parameter. INTERFACE_NAME Identifier for the “interfaceStatisticsSummary->interfaceName” parameter. STATUS Identifier for the “interfaceStatisticsSummary->status” parameter. RECEIVED_PACKETS Identifier for the “interfaceStatisticsSummary->receivedPackets” parameter. TRANSMITTED_PACKETS Identifier for the “interfaceStatisticsSummary->transmittedPackets” parameter.
Enumerations TABLE 795 4 Attributes Parameters Description GATEWAY The IP address of the next hop router. VLAN The VLAN ID. ipInterfaceFilterEnum This type of data describes the enumerations for the IP interface filter.
4 Enumerations ipRouteTypeEnum This type of data describes the enumerations for the IP route type.
Enumerations TABLE 801 4 Attributes Members Description GLOBAL_ADDRESS Global unicast address LINK_ADDRESS ipv6NeighborFilterEnum This type of data describes the enumerations for the IPv6 neighbor filter. TABLE 802 Attributes Members Description IPV6_ADDRESS The host IPv6 address. LINK_ADDRESS The link address. VLAN The VLAN associated with the neighbor. IS_ROUTER The Router mode.
4 Enumerations macEntryFilterFieldEnum This type of data describes the enumerations for a MAC entry field. TABLE 805 Attributes Parameters Description PORT The name or number of the port through which the router sends packets to reach the router’s destination. VLAN_ID The VLAN identifier. MAC_ADDRESS The MAC address of the device. macInfoTypeEnum This type of data describes the enumerations for a MAC type. TABLE 806 Attributes Parameters Description DYNAMIC The dynamic MAC address.
Enumerations 4 ospfAreaTypeEnum This type of data describes the enumerations for the OSPF area type. TABLE 809 Attributes Parameters Description NORMAL Normal Area STUB Stubby Area NSSA Not so stubby Area ospfBRSummaryFilterFieldEnum This type of data describes the enumerations for OSPF BR summary filter field.
4 Enumerations ospfEncryptionEnum This type of data describes the enumerations for the OSPF destination type. TABLE 813 Attributes Parameters Description ENCRYPT ENCRYPT_64 NO_ENCRYPT NONE ospfGlobalEnum This type of data describes the OSPF global enumerations.
Enumerations 4 ospfInterfaceAreaTypeEnum This type of data describes the enumerations for the OSPF interface area type. TABLE 815 Attributes Members Description BROADCAST Broadcast area NBMA NBMA area POINTTOPOINT point to point link VIRTUAL virtual link POINTTOMULTIPOINT point to multipoint link ospfInterfaceStateEnum This type of data describes the enumerations for the OSPF interface state.
4 Enumerations ospfKeyRolloverStateEnum This type of data describes the enumerations for the OSPF key rollover state. TABLE 818 Attributes Members Description NOT_ACTIVE Key roll over is inactive ACTIVE_PHASE1 Roll over is in its first interval ACTIVE_PHASE2 Roll over is in its second interval ospfLogEnum This type of data describes the enumerations for the OSPF log.
Enumerations 4 ospfMetricTypeEnum This type of data describes the enumerations for the OSPF metric type. TABLE 821 Attributes Members Description TYPE1 The Type1 external route TYPE2 The Type2 external route ospfNeighborDetailSummaryFilterFieldEnum This type of data describes the enumerations for OSPF neighbor detail summary filter field.
4 Enumerations TABLE 824 Attributes Members Description PORT The name or number of the port through which the router sends packets to reach the router’s destination. NEIGHBOR_ADDRESS Neighbor address ospfPathTypeEnum This type of data describes the enumerations for the OSPF path type. TABLE 825 Attributes Members Description INTER Routes that pass into another area. INTRA Routes within the local area. EXTERNAL1 Type 1 external routes. EXTERNAL2 type 2 external routes.
Enumerations 4 ospfRouteTypeEnum This type of data describes the enumerations for the OSPF route type. TABLE 828 Attributes Parameters Description ALL All OSPF route types OSPF Route type is OSPF STATIC Route type is static RIP Route type is RIP CONNECTED Route type is connected BGP Route type is BGP ospfRouteSummaryFilterFieldEnum This type of data describes the enumerations for the OSPF route summary filter field.
4 Enumerations portRangeEnum This type of data describes the enumerations for port ranges. TABLE 832 Attributes Parameters Description LOWER Lower port range HIGHER Higher port range portSpeedEnum This type of data describes the enumerations for port speeds. TABLE 833 Attributes Parameters Description 10_MEGABIT The port speed is 10 Mbps 100_MEGABIT The port speed is 100 Mbps. 1_GIGABIT The port speed is 1000 Mbps. 10_GIGABIT The port speed is 10000 Mbps.
Enumerations 4 portStpStateEnum These are the enumerations for port STP states. TABLE 836 Attributes Parameters Description DISABLED The port is not participating in STP. This can occur when the port is disconnected or STP is disabled on the port. BLOCKING STP has blocked traffic on this port to prevent a loop. The device or VLAN can reach the root bridge using another port, whose state is FORWARDING.
4 Enumerations protocolStatusEnum This type of data describes the enumerations for protocol status. TABLE 838 Attributes Parameters Description UP The status of the line protocol is up. DOWN The status of the line protocol is down. routeCostEnum This type of data describes the enumerations for the route cost. TABLE 839 Attributes Parameters Description BGP_MEDIUM The BGP medium IGP The IGP routerDisplayTypeEnum This type of data describes the enumerations for the router display type.
Enumerations 4 sourceIPFilterFieldEnum This type of data describes the enumerations for the fields in the source IP filter field configuration. TABLE 842 Attributes Parameters Description SOURCE_IP_TYPE The identifier for “sourceIP->sourceIPType” parameter. IP The identifier for “sourceIP->ip” parameter. SUBNET_MASK The identifier for “sourceIP->subnetMask” parameter. SUBNET_MASK_LENGTH The identifier for “sourceIP->subnetMaskLength” parameter.
4 Enumerations staticRouteTypeEnum This type of data describes the enumerations for a static route type. TABLE 845 Attributes Parameters Description STANDARD The static route consists of the destination network address and network mask, and the IP address of the next-hop gateway. You can configure multiple standard static routes with the same metric for load sharing or with different metrics to provide a primary route and backup routes.
Enumerations TABLE 847 4 Attributes Parameters Description TIME_WAIT Waiting for enough time to pass to be sure the remote TCP received the acknowledgment of its connection termination request. CLOSED There is no connection state. twoWayToggleEnum This type of data describes the enumerations for the two way toggle. TABLE 848 Attributes Members Description ENABLED Enabled DISABLED Disabled pvstMethodEnum This type of data describes the enumerations for the PVST method.
4 Enumerations TABLE 851 Attributes Members Description PRIORITY The Priority value HELLO_INTERVAL The Hello Interval DEAD_INTERVAL The dead interval ADVERTISE_BACKUP The backup advertisement TRUNK_PRIORITY The trunk priority BACKUP_PREEMPT The backup pre-empt vrrpAuthenticationTypeEnum This type of data describes the enumerations for the VRRP authentication type.
Enumerations 4 vrrpSummaryFilterFieldEnum This type of data describes the enumerations for the VRRP summary filter field.
4 348 Enumerations Brocade Virtual ADX XML API Programmer’s Guide 53-1003248-01
Chapter 5 Server Load Balancing API Reference In this chapter • Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . • Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . • Data structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . • Enumerations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5 Methods clearVirtualServerAttribute Description Clears the attributes setting for a virtual server. Sets the attributes to their default values. Parameters Table 2 contains the parameters required for the method. TABLE 2 Parameters Name Type Presence Rules Description virtualServer Server[] Mandatory Identifies the virtual server for which attribute is to be cleared and set to default. attribute virtualServerAttributeEnum[] Mandatory The virtual server attribute.
Methods 5 Return values Not applicable. Error messages List of Error Messages createVirtualServerPort Description Creates a virtual server port. Parameters Table 5 contains the parameters required for the method. TABLE 5 Parameters Name Type Presence vipPort ServerPort Optional Rules Description Identifies the virtual server port that is to be created. Return values Not applicable.
5 Methods Parameters Table 7 contains the parameters required for the method. TABLE 7 Parameters Name Type Presence configurationInfo VirtualServerPortConfiguration[ ] Mandatory Rules Description Configuration information Error messages List of Error Messages createVirtualServers Description Creates one or more virtual server. Parameters Table 8 contains the parameters required for the method.
Methods 5 Parameters Not applicable. Error messages List of Error Messages. deleteAllVirtualServerPorts Description Deletes all ports on a virtual server. Parameters Not applicable. Return values Not applicable. Error messages List of Error Messages deleteAllVirtualServers Description Deletes all virtual servers that exist on the Brocade Virtual ADX. Use this API very carefully. Parameters Not applicable. Error messages List of Error Messages deleteVirtualServer Description Deletes a virtual server.
5 Methods Error messages List of Error Messages deleteVirtualServerKeepAliveConns Description Deletes all the persistent connection going through a virtual server for one or all ports. Parameters Table 11 contains the parameters required for the method. TABLE 11 Parameters Name Type Presence Rules Description virtualServer Server Optional If this field is empty then it applies to all virtual servers. Identifies the virtual server for which persistence connection is to be deleted.
Methods 5 deleteVirtualServerPorts Description Deletes one or more virtual server port. Parameters Table 13 contains the parameters required for the method. TABLE 13 Parameters Name Type Presence Rules Description virtualServer Server Mandatory Identifies the virtual server from which port(s) is/ are to be deleted. port L4Port[ ] Mandatory Identifies the virtual server port (s) that are being deleted.
5 Methods disableDSROnVirtualServerPort Description Disables Direct Server Return (DSR) on a virtual server. Parameters Table 15 contains the parameters required for the method. TABLE 15 Parameters Name Type Presence vipPort ServerPort Optional Rules Description Identifies the virtual server port on which DSR is being disabled. Return values Not applicable. Error messages List of Error Messages disableSSLOnVipPort Description Disables Secure Socket Layer (SSL) on a virtual server port.
Methods 5 Parameters Table 17 contains the parameters required for the method. TABLE 17 Parameters Name Type Presence vipPort ServerPort Optional Rules Description Identifies the virtual server port on which sticky connections are being disabled. Return values Not applicable. Error messages List of Error Messages disableVirtualServer Description Disables a virtual server. Parameters Table 18 contains the parameters required for the method.
5 Methods Error messages List of Error Messages disableVirtualServerPorts Description Disables one or more virtual server ports. Parameters Table 20 contains the parameters required for the method. TABLE 20 Parameters Name Type Presence virtualServer Server Mandatory port L4Port[ ] Optional Rules Description Identifies the virtual server to which the port being disabled belongs. All of the ports belonging to the virtual server will be disabled, if the port is empty.
Methods 5 Error messages List of Error Messages enableDSROnVirtualServerPort Description Enables DSR on a virtual server. Parameters Table 22 contains the parameters required for the method. TABLE 22 Parameters Name Type Presence vipPort ServerPort Optional Rules Description Identifies the virtual server port on which DSR is being enabled. Return values Not applicable. Error messages List of Error Messages enableSSLOnVipPort Description Enables SSL on a virtual server port.
5 Methods Parameters Table 24 contains the parameters required for the method. TABLE 24 Parameters Name Type Presence vipPort ServerPort Optional Rules Description Identifies the virtual server port on which sticky connections are being enabled. Return values Not applicable. Error messages List of Error Messages enableVirtualServer Description Enables a virtual server. Parameters Table 25 contains the parameters required for the method.
Methods 5 Error messages List of Error Messages enableVirtualServerPorts Description Enables one or more virtual server port. Parameters Table 27 contains the parameters required for the method. TABLE 27 Parameters Name Type Presence virtualServer Server Mandatory port L4Port[ ] Optional Rules Description Identifies the virtual server to which the port being enabled belongs. If this field is empty then action will be applied to all of the configured ports.
5 Methods Parameters Table 29 contains the parameters required for the method. TABLE 29 Parameters Name Type Presence keyFileName string Optional sslCsr SSLCSRInfo Rules Description Identifies the SSL key file name. SSL Certificate Signing Request (CSR) information Return values Table 30 contains the return values of the method.
Methods 5 getAllSSLCertificateNames Description Retrieves the names of all certificates on an SSL virtual server port. Parameters Table 33 contains the parameters required for the method. TABLE 33 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional Sets the starting index for labeling the number of SSL certificates in an ordered list. numRetrieved unsignedInt Optional Specifies all the configured SSL certificate names.
5 Methods getAllVirtualServerConnStats Description Retrieves the connection statistics for all virtual servers. Parameters Table 37 contains the parameters required for the method. TABLE 37 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional Sets the starting index used to label the number of virtual servers in an ordered list. numRetrieved unsignedInt Optional The number of elements expected in the result by the request. Maximum value allowed is 8.
Methods 5 Return values Table 40 contains the return values of the method. TABLE 40 Return values Name Type Description genericInfo ResponseInformation Generic information MonitoringInfo VirtualServerMonitoringInfo[] Error messages List of Error Messages getAllVirtualServerPorts Description Retrieves the names of all configured virtual server ports. Parameters Table 41 contains the parameters required for the method.
5 Methods Parameters Table 43 contains the parameters required for the method. TABLE 43 Parameters Name Type Presence Rules Description realServerPort ServerPort Mandatory Identifies the real server ports whose bindings are to be obtained. startIndex unsignedInt Optional Sets the starting index used to label the number of virtual server ports in an ordered list. numRetrieved unsignedInt Optional The number of elements expected in the result by the request. Maximum value allowed is 8.
Methods TABLE 45 5 Parameters Name Type Presence Rules Description numRetrieved unsignedInt Optional The number of elements expected in the result by the request. Maximum value allowed is 8. filter VirtualServerPortSummaryFilter Optional The filtering criteria that must be applied to the result. Return values Table 46 contains the return values of the method.
5 Methods Return values Table 48 contains the return values of the method. TABLE 48 Return values Name Type Description genericInfo ResponseInformation Generic information ports VirtualServerPortSummaryInfo [] Port information Error messages List of Error Messages getAllVirtualServers Description Retrieves the names of all configured virtual servers. Parameters Table 49 contains the parameters required for the method.
Methods 5 Parameters Table 51 contains the parameters required for the method. TABLE 51 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional Sets the starting index used to label the number of virtual servers in an ordered list. numRetrieved unsignedInt Optional The number of elements expected in the result by the request. Maximum value allowed is 8. filter VirtualServerStatusFilter Optional The filtering criteria that must be applied to the result.
5 Methods Return values Table 54 contains the return values of the method. TABLE 54 Return values Name Type genericInfo ResponseInformation virtualServerSummary VirtualServerSummary[ ] Description The list of virtual servers along with a summary of information. Error messages List of Error Messages getAllVirtualServersWithPorts Description Retrieves the names of all the configured virtual server with all the port details. Parameters Table 55 contains the parameters required for the method.
Methods 5 Return values Table 57 contains the return values of the method. TABLE 57 Return values Name Type Description genericInfo ResponseInformation Generic information. l3CheckInfo L3HealthCheckInfo The retrieved global health check information. Error messages List of Error Messages getPredictorOnVirtualServer Description Retrieves the predictor from a virtual server. Parameters Table 58 contains the parameters required for the method.
5 Methods Return values Table 60 contains the return values of the method. TABLE 60 Return values Name Type Description genericInfo ResponseInformation Generic information slbGlobalConfig GlobalSlbConfiguration Specifies the global SLB configuration. Error messages List of Error Messages getSSLCertificateInfo Description Retrieves the SSL certificate information. Parameters Table 61 contains the parameters required for the method.
Methods 5 getSSLCertificatesOnVip Description Retrieves certificates on a SSL virtual server port. Parameters Table 63 contains the parameters required for the method. TABLE 63 Parameters Name Type Presence Rules Description vipPort ServerPort Optional Identifies the virtual server from which the SSL certificates are being obtained. startIndex unsignedInt Optional Sets the starting index for labeling the number of SSL certificates on the virtual server in an ordered list.
5 Methods getVirtualServerConfiguration Description Retrieves the configuration information of a virtual server. Parameters Table 66 contains the parameters required for the method. TABLE 66 Parameters Name Type Presence vip Server Optional Rules Description Identifies the virtual server from which the configuration is being obtained. Return values Table 67 contains the return values of the method.
Methods 5 getVirtualServerMonitoringDetails Description Retrieves the status information for one or more virtual server. Parameters Table 70 contains the parameters required for the method. TABLE 70 Parameters Name Type Presence virtualServer Server Mandatory Rules Description Sets the starting index used to label the number of virtual servers in an ordered list. Return values Table 71 contains the return values of the method.
5 Methods Error messages List of Error Messages getVirtualServerPortConnStats Description Retrieves the connection statistics for a virtual server port. Parameters Table 74 contains the parameters required for the method. TABLE 74 Parameters Name Type Presence vipPort ServerPort Mandatory Rules Description Virtual server name, IP and port. Return values Table 75 contains the return values of the method.
Methods 5 Error messages List of Error Messages getVirtualServerPortStatus Description Retrieves the status information of a virtual server port. Parameters Table 78 contains the parameters required for the method. TABLE 78 Parameters Name Type Presence vipPort ServerPort Optional Rules Description Name and IP of virtual server and port. Return values Table 79 contains the return values of the method.
5 Methods Error messages List of Error Messages removeRealServersFromGroup Description Removes real servers from a group. Parameters Table 82 contains the parameters required for the method. TABLE 82 Parameters Name Type serverGro upList RealServerGroup Presence Rules Description Real server group list Error messages List of Error Messages setGlobalL3Check Description Sets the global L3 health check information Parameters Table 83 contains the parameters required for the method.
Methods 5 Error messages List of Error Messages. setVirtualServersConfiguration Description Sets the configuration information for a virtual server. Parameters Table 85 contains the parameters required for the method. TABLE 85 Parameters Name Type Presence virtualServerConfig VirtualServerConfiguration[] Optional Rules Description Identifies the configuration information of the virtual server.
5 Methods Parameters Table 87 contains the parameters required for the method. TABLE 87 Parameters Name Type Presence Rules Description vipPort ServerPort Optional Identifies the virtual server port from which CSW policy is being unbound. cswPolicyName string Optional Identifies the name of the CSW policy being unbound. Error messages List of Error Messages updateSlbGlobalConfiguration Description Updates the global SLB configuration.
Methods 5 bindRealServerGroupToVip This method unbinds a real server group from a virtual server (VIP). Parameters Table 90 contains the parameters required for the method. TABLE 90 Parameters Name Type Presence serverGroupBindList RealServerGroupBind[ ] Rules Description Return values None Error messages List of Error Messages bindRealServerPortsToVipPort Description Binds one or more real server port to a virtual server port.
5 Methods Return values Not applicable. Error messages List of Error Messages. createBulkRealServers This method creates bulk real servers with a given common configuration Parameters Table 93 contains the parameters required for the method TABLE 93 Parameters Name Type Presence Rules Description realServer Server[] Optional The real server config RealServerBulkConfig Optional The common configuration for the bulk real server Error messages List of Error Messages.
Methods 5 Parameters Table 95 contains the parameters required for the method. TABLE 95 Parameters Name Type Presence Rules Description rs Server Optional The real server from which the predictors are being cleared. predInfo PredictorConfiguration Optional Identifies the predictor information. Return values Not applicable. Error messages List of Error Messages. clearGlobalL3Check Description Removes all flags indicating when and where L3 health checks are to be run.
5 Methods clearRealServerPortKeepAliveConnections Description Deletes all the persistent connections going to a real server for all or particular ports as required. Parameters Table 97 contains the parameters required for the method. TABLE 97 Parameters Name Type Presence realServer Server Optional realServerPort L4Port[ ] Optional Rules Description Identifies the real server for which persistence connection is to be deleted.
Methods 5 Parameters Table 99 contains the parameters required for the method. TABLE 99 Parameters Name Type Presence rsPort ServerPort Optional Rules Description Identifies the port for which the server ID is being cleared. Return values Not applicable. Error messages List of Error Messages. clearURLHealthCheckOnRealServerPort Description Clears the URL health check from a real server port. Parameters Table 100 contains the parameters required for the method.
5 Methods Return values Not applicable. Error messages List of Error Messages. createRealServer Description Creates a real server. Parameters Table 102 contains the parameters required for the method. TABLE 102 Parameters Name Type Presence rs Server Optional Rules Description Identifies the name or IP address of the real server that is to be created. Return values Not applicable. Error messages List of Error Messages. createRealServerPort Description Creates a real server port.
Methods 5 Parameters Table 104 contains the parameters required for the method. TABLE 104 Parameters Name Type Presence portConfig RealServerPortConfiguration[ ] Mandatory Rules Description Configuration information for the port. Error messages List of Error Messages createRealServerWithConfiguration Description Creates a real server with a given configuration. Parameters Table 105 contains the parameters required for the method.
5 Methods deleteAllRealServers Description Deletes all the real servers in the ADX device. Use this API very carefully. Error messages List of Error Messages deleteAllRealServersFromVipPort Description Deletes all real servers bound to a virtual server port. Parameters Table 107 contains the parameters required for the method.
Methods 5 Parameters Table 108 contains the parameters required for the method. TABLE 108 Parameters Name Type Presence rs Server Optional Rules Description Identifies the real server being deleted. Return values Not applicable. Error messages List of Error Messages. deleteRealServerPort Description Deletes a real server port. Parameters Table 109 contains the parameters required for the method.
5 Methods deleteRealServers Description Deletes one or more real server. Parameters Table 111 contains the parameters required for the method. TABLE 111 Parameters Name Type Presence realServer Server[ ] Mandatory Rules Description Identifies the real servers being deleted. Error messages List of Error Messages deleteRealServerGroups Deletes real server groups.
Methods 5 Parameters Table 113 contains the parameters required for the method. TABLE 113 Parameters Name Type Presence Rules port ServerPort[ ] Mandatory Description Identifies the virtual server port from which the bound real servers are being deleted. Error messages List of Error Messages disableAllRealServersOnVipPort Description Disables all real server ports bound to a virtual server port. Parameters Table 114 contains the parameters required for the method.
5 Methods disableRealServer Description Disables a real server. Parameters Table 116 contains the parameters required for the method. TABLE 116 Parameters Name Type Presence rs Server Optional Rules Description Identifies the real server being disabled. Return values Not applicable. Error messages List of Error Messages. disableRealServerPort Description Disables a real server port. Parameters Table 117 contains the parameters required for the method.
Methods 5 Parameters Table 118 contains the parameters required for the method. TABLE 118 Parameters Name Type Presence Rules Description realServer Server Mandatory Identifies the real server to which the port that is being disabled belongs to. realServerPort L4Port[ ] Mandatory Identifies the real server ports that are being disabled. Error messages List of Error Messages disableRealServers Description Disables one or more real servers.
5 Methods enableAllRealServersOnVipPorts Description Enables all the real server ports that are bound to one or more virtual server port. Parameters Table 121 contains the parameters required for the method. TABLE 121 Parameters Name Type Presence virtualServer Server Mandatory virtualServerPort L4Port[ ] Optional Rules Description Identifies the virtual server to which the port being enabled belongs.
Methods 5 Parameters Table 123 contains the parameters required for the method. TABLE 123 Parameters Name Type Presence rsPort ServerPort Optional Rules Description Identifies the real server port being enabled. Return values Not applicable. Error messages List of Error Messages enableRealServerPorts Description Enables one or more real server ports. Parameters Table 124 contains the parameters required for the method.
5 Methods getAllRealServerBackupServerBinding Description Retrieves the backup server bound to a specific real server (primary). Parameters Table 126 contains the parameters required for the method. TABLE 126 Parameters Name Type Presence Rules Description realServer Server[] Optional If this field is empty then it applies to all real server. Identifies the specific primary server.
Methods 5 getAllRealServerIDs Description Retrieves a list of all real server IDs that exist in the Brocade Virtual ADX device. Parameters Table 128 contains the parameters required for the method. TABLE 128 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional Sets the starting index for labeling the number of real server IDs in an ordered list. numRetrieved unsignedInt Optional The number of elements expected in the result by the request.
5 Methods getAllRealServerPortConnStats Description Retrieves all the real server ports bound to real server port connection statistics. Parameters Table 131 contains the parameters required for the method. TABLE 131 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional Sets the starting index for labeling the number of virtual server ports in an ordered list. numRetrieved unsignedInt Optional The number of elements expected in the result by the request.
Methods 5 Parameters Table 133 contains the parameters required for the method. TABLE 133 Parameters Name Type Presence Rules Description serverPort ServerPort[] Mandatory If serverPort is not specified then all VIP in the Brocade Virtual ADX will be returned. Identifies the virtual server. startIndex unsignedInt Optional Sets the starting index to label the number of virtual server ports in an ordered list.
5 Methods Parameters Table 135 contains the parameters required for the method. TABLE 135 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional Sets the starting index to label the number of real servers in an ordered list. numRetrieved unsignedInt Optional Number of element expected in the result by the request. Maximum value allowed is 8. Filter ServerAndConfiguredPortListFilter Optional Filtering criteria that must be applied to the result.
Methods 5 Return values Table 138 contains the return values of the method. TABLE 138 Return values Name Type Description genericInfo ResponseInformation Generic information rsPortList L4Port[ ] Returns the list of configured real server ports. Error messages List of Error Messages getAllRealServerPortsBoundtoVirtualServerPort Description Retrieves all the real server ports that are bound to the virtual server port. Parameters Table 139 contains the parameters required for the method.
5 Methods getAllRealServerPortsOnVirtualServerPort Description Retrieves the names of all configured real server ports on a virtual server port. Parameters Table 141 contains the parameters required for the method. TABLE 141 Parameters Name Type Presence Rules Description vipPort ServerPort Optional Identifies the virtual server port. startIndex unsignedInt Optional Sets the starting index for labeling the number of real server ports in an ordered list.
Methods TABLE 143 5 Parameters Name Type Presence Rules Description numRetrieved unsignedInt Optional Number of elements expected in the result by the request. Maximum value allowed is 64. filter RealServerPortSummaryFilter Optional Filtering criteria that must be applied to the result. Return values Table 144 contains the return values of the method.
5 Methods getAllRealServersSummary Description Get the real server summary information for all real servers. Parameters Table 147 contains the parameters required for the method. TABLE 147 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional Sets the starting index for labeling the number of real servers in an ordered list. numRetrieved unsignedInt Optional The number of elements expected in the result by the request. Maximum value allowed is 8.
Methods TABLE 149 5 Parameters Name Type Presence Rules Description numRetrie ved unsignedInt Optional Number of element expected in the result by the request. Maximum value allowed is 512. filter RealServerFilter Optional Filtering criteria that must be applied to the result. Return values Table 150 contains the return values of the method.
5 Methods getRealServerConnStats Description Retrieves the connection statistics for a real server. Parameters Table 153 contains the parameters required for the method. TABLE 153 Parameters Name Type rs Server Presence Rules Description Real server Return values Table 154 contains the return values of the method.
Methods 5 getRealServerPortConfiguration Description Retrieves the configuration information of a real server port. Parameters Table 157 contains the parameters required for the method. TABLE 157 Parameters Name Type Presence rsPort ServerPort Optional Rules Description Identifies the real server port from which the configuration is being obtained. Return values Table 158 contains the return values of the method.
5 Methods getRealServerPortMonitoringDetails Description Retrieve the monitoring details of the real server port. Parameters Table 161 contains the parameters required for the method. TABLE 161 Parameters Name Type Presence realPort ServerPort Mandatory Rules Description Identifies the real server and port for which connection statistics are to be retrieved. Return values Table 162 contains the return values of the method.
Methods 5 getRealServerStatus Description Retrieves the status information for a real server. Parameters Table 165 contains the parameters required for the method. TABLE 165 Parameters Name Type Presence rs Server Optional Rules Description Identifies the real server from which the status is being obtained. Return values Table 166 contains the return values of the method.
5 Methods getRealServersOfGroup Description Retrieves the details of real server in a group. Parameters Table 169 contains the parameters required for the method. TABLE 169 Parameters Name Type serverGroupNam e string startIndex unsignedInt numRetrieved unsignedInt Presence Rules Description Real server group name Return values Table 170 contains the return values of the method.
Methods 5 Return values Table 172 contains the return values of the method. TABLE 172 Return values Name Type Description genericInfo ResponseInformation Identifies the generic information. summaryList RealServerGroupBind[ ] Real server group binding details. Error messages List of Error Messages setDynamicPredictorWeightsOnRealServer Description Sets dynamic-predictor weights on a real server. Parameters Table 173 contains the parameters required for the method.
5 Methods setRealServersConfiguration Description Sets the configuration information for real servers. Parameters Table 175 contains the parameters required for the method. TABLE 175 Parameters Name Type Presence realServerConfig RealServerConfiguration[ ] Mandatory Rules Description Identifies the configuration for real server. Error messages List of Error Messages setRealServersPortConfiguration Description Sets the port configurations for real servers.
Methods 5 setURLHealthCheckOnRealServerPort Description Sets the URL health check information on a real server port. Parameters Table 178 contains the parameters required for the method. TABLE 178 Parameters Name Type Presence Rules Description rsPort ServerPort Optional The real server port for which you are setting the health check information check URLHealthCheck Optional The new URL health check information.
5 Methods Error messages List of Error Messages unbindRealServerPortFromVipPort Description Unbinds a real server port from a virtual server port. Parameters Table 181 contains the parameters required for the method. TABLE 181 Parameters Name Type Presence Rules Description vipPort ServerPort Optional Identifies the virtual server port. rsPort ServerPort Optional Identifies the real server port being unbound.
Methods 5 Error messages List of Error Messages. Health Check Health Check XML-API provides a set of operations (methods) to configure health checks on known or custom ports of real servers. These APIs can be invoked remotely on Brocade Virtual ADX by any client. bindHealthCheckOnRealServerPorts Description Binds the health check policy to the real server ports. Parameters Table 184 contains the parameters required for the method.
5 Methods createElementHealthCheck Description Creates an element health check. Parameters Table 186 contains the parameters required for the method. TABLE 186 Parameters Name Type Presence element ElementHealthCheck Optional Rules Description Identifies the Layer 2, Layer 3 and Layer 4 configuration details. Return values Not applicable. Error messages List of Error Messages createMatchList Description Creates a match list. Parameters Table 187 contains the parameters required for the method.
Methods 5 Return values Not applicable. Error messages List of Error Messages createPortProfile Description Creates a port profile. Parameters Table 189 contains the parameters required for the method. TABLE 189 Parameters Name Type Presence profile PortProfile Optional Rules Description Identifies the port profile configuration details. Return values Not applicable. Error messages List of Error Messages deleteBooleanHealthCheck Description Deletes the boolean health check.
5 Methods Parameters Table 191 contains the parameters required for the method. TABLE 191 Parameters Name Type Presence elementName string Optional Rules Description Identifies the name of element health check to be deleted. Return values Not applicable. Error messages List of Error Messages deleteMatchList Description Deletes the match list. Parameters Table 192 contains the parameters required for the method.
Methods 5 deletePortProfile Description Deletes the port profile. Parameters Table 194 contains the parameters required for the method. TABLE 194 Parameters Name Type Presence port L4Port Optional Rules Description Identifies the name of the profile to be deleted. Return values Not applicable. Error messages List of Error Messages otherHealthCheckOperations Description The other health check operations. Parameters Table 195 contains the parameters required for the method.
5 Methods Parameters Table 196 contains the parameters required for the method. TABLE 196 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional Any positive integer value between 11024 Sets the start index for retrieving the element health checks summary. numRetrieved unsignedInt Optional Any positive integer value between 11024 Specifies the number of element health checks to be retrieved. Maximum value allowed is 16.
Methods 5 Return values Table 199 contains the return values of the method. TABLE 199 Return values Name Type Description genericInfo ResponseInformation Identifies the generic information about all match lists. MatchList MatchListsSummary[] Identifies the match list summary. Error messages List of Error Messages getAllPortPolicies Description Retrieves the summary of all port profiles. Parameters Table 200 contains the parameters required for the method.
5 Methods Parameters Table 202 contains the parameters required for the method. TABLE 202 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional Any positive integer value between 1-1024 Identifies the start index for retrieving the port profile information. numRetrieved unsignedInt Optional Any positive integer value between 1-1024 Identifies the number of port profiles to be retrieved. Maximum value allowed is 16.
Methods 5 getElementHealthCheck Description Retrieves the element health check. Parameters Table 206 contains the parameters required for the method. TABLE 206 Parameters Name Type Presence elementName string Optional Rules Description Identifies the name of element health check to be retrieved. Return values Table 207 contains the return values of the method.
5 Methods Parameters Table 209 contains the parameters required for the method. TABLE 209 Parameters Name Type Presence mListName string Optional Rules Description Identifies the name of the match list to be retrieved. Return values Table 210 contains the return value of the method. TABLE 210 Return values Name Type Description genericInfo ResponseInformation Identifies the generic information about match list. mList MatchList Identifies the match list configuration details.
Methods 5 Parameters Table 213 contains the parameters required for the method. TABLE 213 Parameters Name Type Presence port L4Port Optional Rules Description The Layer 4 port for which you are retrieving the profile. Return values Table 214 contains the return values of the method. TABLE 214 Return values Name Type Description genericInfo ResponseInformation profile PortProfile The retrieved profile information for the Layer 4 port.
5 Methods setL2L3L4HealthCheck Description Sets the Layer 2, Layer 3, and Layer 4 attributes globally. Parameters Table 217 contains the parameters required for the method. TABLE 217 Parameters Name Type Presence l2HCInfo L2L3L4HealthCheck Optional Rules Description identifies the Layer 2, Layer 3,and Layer 4 configuration details. Return values Not applicable.
Methods 5 Parameters Table 219 contains the parameters required for the method. TABLE 219 Parameters Name Type Presence element BooleanHealthCheck Optional Rules Description Identifies the boolean health check details. Return values Not applicable. Error messages List of Error Messages updateElementHealthCheck Description Updates element health check details. Parameters Table 220 contains the parameters required for the method.
5 Methods updatePortPolicy Description Updates the port policy. Parameters Table 222 contains the parameters required for the method. TABLE 222 Parameters Name Type Presence policy PortPolicy Optional Rules Description Identifies port policy configuration details. Return values Not applicable. Error messages List of Error Messages updatePortProfile Description Updates the port profile. Parameters Table 223 contains the parameters required for the method.
Methods 5 Parameters Table 224 contains the parameters required for the method. TABLE 224 Parameters Name Type Presence Rules Description vipPort ServerPort Optional Identifies the virtual server port to which the CSW policy is bound. cswPolicyName string Optional Identifies the name of the CSW policy being bound. Return values Not applicable. Error messages List of Error Messages.
5 Methods Error messages List of Error Messages clearCswKeepaliveStatistics Description Clears the CSW keepalive counters statistics. Parameters None Return values Not applicable. Error messages List of Error Messages clearCswPolicyStatistics Description Clears the CSW policy statistics. Parameters Table 226 contains the parameters required for the method. TABLE 226 Parameters Name Type Presence name string Mandatory Rules Description Identifies the name of the CSW policy.
Methods 5 createCswRequestPolicy Description Creates a CSW request policy. Parameters Table 227 contains the parameters required for the method. TABLE 227 Parameters Name Type Presence cswPolicy CswPolicy[] Mandatory Rules Description Identifies the request policy configuation details. Return values Not applicable. Error messages List of Error Messages createCswRequestRule Description Creates a CSW request rule. Parameters Table 228 contains the parameters required for the method.
5 Methods Return values Not applicable. Error messages List of Error Messages createCswResponseRule Description Creates a CSW response rule. Parameters Table 230 contains the parameters required for the method. TABLE 230 Parameters Name Type Presence rule ResponseRule[] Mandatory Rules Description Identifies the response rule configuation details. Return values Not applicable. Error messages List of Error Messages deleteCswRequestPolicy Description Deletes the CSW request policy.
Methods 5 Parameters Table 232 contains the parameters required for the method. TABLE 232 Parameters Name Type Presence Rules Description name string[] Mandatory Maximum 80 characters. Identifies the names of the CSW rules. Return values Not applicable. Error messages List of Error Messages deleteCswResponsePolicy Description Deletes the CSW response policy. Parameters Table 233 contains the parameters required for the method.
5 Methods getAllCswPolicyInfo Description Get all the CSW policy attributes. Parameters Table 235 contains the parameters required for the method. TABLE 235 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional Identifies the starting index. numRetrieved unsignedInt Optional Identifies the number of rules to be retrieved. Maximum value allowed is 8. filter CswPolicyFilter Optional Specifies the filter criteria.
Methods 5 Return values Table 238 contains the return values of the method TABLE 238 Return values Name Type Description genericInfo ResponseInformation Identifies the generic information about all CSW request policies. policiesList CswPolicySummary[] Identifies the policies summary. Error messages List of Error Messages getAllCswRequestRules Description Retrieves all the CSW request rules summary. Parameters Table 239 contains the parameters required for the method.
5 Methods Parameters Table 241 contains the parameters required for the method. TABLE 241 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional Identifies the starting index. numRetrieved unsignedInt Optional Identifies the number of policies to be retrieved. Maximum value allowed is 8. filter CswPolicyFilter Optional Specifies the filter criteria. Return values Table 242 contains the return values of the method.
Methods 5 getAllDnsDpiPoliciesStatistics Description Retrieves the DNS DPI policies statistics. Parameters Table 245 contains the parameters required for the method. TABLE 245 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional Identifies the starting index. numRetrieved unsignedInt Optional Identifies the number of rules to be retrieved. filter DnsDpiPolicyFilter Optional Specifies the filter criteria.
5 Methods Error messages List of Error Messages getCswBasicStatistics Description Retrieves the CSW basic statistics. Parameters None Return values Table 249 contains the return values of the method. TABLE 249 Return values Name Type Description genericInfo ResponseInformation Identifies the generic information about the CSW basic statistics. basicCountersStatistics CswBasicCountersStatistics Identifies the CSW basic counter statistics.
Methods 5 Parameters Table 251 contains the parameters required for the method. TABLE 251 Parameters Name Type Presence Rules Description name string[] Mandatory Maximum 80 characters. Identifies the CSW policy name. Return values Table 252 contains the return values of the method TABLE 252 Return values Name Type Description genericInfo ResponseInformation Identifies the generic information about CSW request policy.
5 Methods getCswResponsePolicy Description Retrieves the CSW response policy attributes. Parameters Table 255 contains the parameters required for the method. TABLE 255 Parameters Name Type Presence Rules Description name string[] Mandatory Maximum 80 characters. Identifies the CSW policy name.
Methods 5 Return values Table 258 contains the return values of the method TABLE 258 Return values Name Type Description genericInfo ResponseInformation Identifies the generic information about CSW response rule. rulesList ResponseRule[] Identifies the rule configuation details. This API is different from getCswRuleInfo by the data structure used for handling rule configuration details. It is the same data structure as createCswResponseRule API. This can be used to get and configure CSW rule.
5 Methods Return values Table 261 contains the return values of the method. TABLE 261 Return values Name Type Description genericInfo ResponseInformation Identifies the generic information about the CSW rule. rulesList CswRuleInfo[ ] Identifies the CSW rule configuation details. Error messages List of Error Messages setCswL7Config Description Sets the CSW Layer 7 configuration. Parameters Table 262 contains the parameters required for the method.
Methods 5 unbindAllVirtualServerPortsFromCswPolicy Description Unbinds the virtual server ports from CSW policy. Parameters Table 264 contains the parameters required for the method. TABLE 264 Parameters Name Type Presence Rules Description policyName string Mandatory N/A CSW policy name to unbind from virtual server ports. Return values Not apllicable. Error messages List of Error Messages setDnsGlobalConfig Description Sets the DNS global configuration.
5 Methods Parameters Table 266 contains the parameters required for the method. TABLE 266 Parameters Name Type Presence Rules Description vipPort Server Mandatory Identiifies the virtual port details. cswPolicyName string Mandatory Identifies the name of the policy. Return values Not apllicable. Error messages List of Error Messages updateCswRequestPolicy Description Updates the CSW request policy. Parameters Table 267 contains the parameters required for the method.
Methods 5 Error messages List of Error Messages updateCswResponsePolicy Description Updates the CSW response policy. Parameters Table 269 contains the parameters required for the method. TABLE 269 Parameters Name Type Presence cswPolicy CswPolicy[] Mandatory Rules Description Identifies the HTTP response policy configuation details. Return values Not applicable. Error messages List of Error Messages updateCswResponseRule Description Updates the CSW response rule.
5 Methods Parameters TABLE 271 Parameters Parameters Type Presence tftp TftpInfo Optional Rules Description Specify the policy list file name, TFTP server IP address, download interval, and time of the day . Return values TABLE 272 Return values Parameters Type Description token unsignedInt Token ID specific to API execution. Error messages List of Error Messages. clearGlobalPbslbSettings This API clears one or more PBSLB configuration.
Methods 5 copyPbslbEntriesFromUsb1 Copies policy entries from USB1 flash to ADX. Parameters Table 275 contains the parameters required for the method. TABLE 275 Parameters Name Type Presence fileName string Optional Rules Description Specify the policy list file name on USB1 flash. Return values None Error messages List of Error Messages. copyPbslbRunConfig Copies the policy list to a specified file on the TFTP server. Parameters Table 276 contains the parameters required for the method.
5 Methods Return values None Error messages List of Error Messages. deleteAllPbslbEntries Delete all the PBSLB policy entries specific to IPv4 or IPv6. Parameters TABLE 279 Parameters Parameters Type Presence ipVersion ipVersionEnum Mandatory Rules Description Specify IP Version type IPv4 or IPv6. Return values None Error messages List of Error Messages. deletePbslbPolicyList Deletes one or more IPv4 or IPv6 entries from the policy list.
Methods 5 Parameters TABLE 281 Parameters Parameters Type Presence startIndex unsignedInt Optional Start index numRetrieved unsignedInt Optional Number of record to be retrieved ipVersion ipVersionEnum Optional IP version type (IPv4 or IPv6) filter PbslbConfigFilter Optional Filtering criteria. Rules Description Return values TABLE 282 Return values Name Type Description genericInfo ResponseInformation Generic information. maxCount unsignedInt Maximum count.
5 Methods Parameters TABLE 284 Parameters Parameters Type Presence ipVersion ipVersionEnum Optional Rules Description Specifies IPv4 or IPv6 Return values TABLE 285 Return values Parameters Type Description genericInfo ResponseInformation Generic information. redirectCount unsignedLong Redirect counter Error messages List of Error Messages. getPbslbPolicyEntry This method displays the policy entry specific to IP address (IPv4 or IPv6).
Methods 5 Error messages List of Error Messages. getStatusOnAutoFetchEntries Retrieves the autoFetchPbslbEntries API execution status. Parameters TABLE 289 Parameters Parameters Type Presence token unsignedInt Optional Rules Description Specify the token ID for which you need to know the API execution status. Return values TABLE 290 Return values Parameters Type Description genericInfo ResponseInformation Identifies the generic information about the CSW rule.
5 Methods Parameters TABLE 293 Parameters Parameters Type Presence pbSlbConfig PbslbConfiguration Mandatory Rules Description Data structure. Return values None updateGlobalPbslbSettings Updates the PBSLB global configuration and performs a full update. Parameters TABLE 294 Parameters Parameters Type Presence pbSlbConfig PbslbConfiguration Mandatory Rules Description Data structure Return values None Error messages List of Error Messages.
Methods 5 Parameters Table 296 contains the parameters required for the method TABLE 296 Parameters Name Type Presence Rules Description list ScriptProfile[] Mandatory Maximum array size is 50 Identifies the script profile to be created Error messages List of Error Messages. addScripts This method adds the specified script contents.
5 Methods Error messages List of Error Messages bindScriptProfiles This method binds a script profile at the server ports.
Methods 5 Parameters Table 303 contains the parameters required for the method TABLE 303 Parameters Name Type Presence Rules Description list ScriptProfile[] Mandatory Maximum array size is 50 Identifies the profiles to be deleted Error messages List of Error Messages. deleteScripts This method deletes the specified script.
5 Methods Error messages List of Error Messages. getAllScriptsConfigurationSummary This method gets a summary of all the script that are available in the system Parameters Table 307 contains the parameters required for the method TABLE 307 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional Identifies the starting index numRetrieved unsignedInt Optional Identifies the number of scripts to be retrieved. Maximum value allowed is 30.
Methods 5 Return values This table contains the return values of the method. TABLE 310 Return values Name Type Description genericInfo ResponseInformation Identifies the generic information. scripts ScriptSummary[] Error messages List of Error Messages getScriptBindings This method get the bindings of the script.
5 Methods Return values This table contains the return values of the method. TABLE 314 Return values Name Type Description genericInfo ResponseInformation Identifies the generic information about the bound scripts. statistics ScriptDetails Contains the information about the scripts at the location Error messages List of Error Messages getScriptEstimatedPerformance This method gets the contents of the specified script.
Methods 5 Return values This table contains the return values of the method. TABLE 318 Return values Name Type Description list ScriptConfiguration[] Array containing the contents of the scripts Error messages List of Error Messages. unbindAllScriptBindpoints This method unbinds the specified script from all the bound server port.
5 Methods Parameters Table 321 contains the parameters required for the method TABLE 321 Parameters Name Type Presence scriptName string Mandatory bindPoints ServerPort[] Mandatory profile ScriptProfile Mandatory Rules Description Identifies the script Identifies the server ports binding of the script Maximum array size is 512 Identifies the profile to be unbound Error messages List of Error Messages. updateScriptProfiles This method updates one or more existing script profiles.
Data structures 5 Data structures BasicCswOtherCountersInfo This structure is the high-level description of basic CSW other counters. Derived from: restricting anyType TABLE 324 Attributes Name Type Presence serverRstToSyn unsignedInt Optional Number of times the server sent RST to TCP SYN. serverRstToClient unsignedInt Optional Number of times the Brocade Virtual ADX sent RST to client. urlNotFound unsignedInt Optional Number of times the URL string was not found.
5 Data structures TABLE 324 Attributes (Continued) Name Type Presence Rules Description currentHWBufferStored unsignedInt Optional Current HW buffer stored insufficientIPCBuffer unsignedInt Optional Insufficient IPC buffer BasicCswPacketCountersInfo This structure is the high-level description of basic CSW packet counters information.
Data structures TABLE 327 5 Attributes (Continued) Name Type Presence Rules Description packetsFreedBySessionTimeout unsignedInt Optional Packet freed by session timeout packetsFreedBySessionDeleted unsignedInt Optional Packet freed by session deleted BooleanHealthCheck This structure is the high-level description of boolean health check. TABLE 328 Attributes Name Type Presence Rules Description booleanCheckName string Optional Name of boolean element check.
5 Data structures CswBasicCountersStatistics This structure is the high-level description of CSW basic counters statistics. TABLE 331 Attributes Name Type Presence Rules Description proxyCounters BasicCswProxyCountersInfo Optional CSW proxy counters information. otherCounters BasicCswOtherCountersInfo Optional CSW counters information. packetCounters BasicCswPacketCountersInfo Optional CSW packet counters information.
Data structures 5 CswHttpResponseRewriteInfo This structure is the high-level description of CSW HTTP response rewrite information TABLE 334 . Attributes Name Type Presence Rules Description cookieInsertions unsignedInt Optional Cookie insertions happened. headerInsertions unsignedInt Optional Header insertion happened. cookieInsertionErrors unsignedInt Optional Cookies insertion error count. headerInsertionErrors unsignedInt Optional Header insertion error count.
5 Data structures TABLE 336 Attributes (Continued) Name Type Presence Rules Description haCounters CswKeepaliveHaCountersInfo Optional HA counters httpPipelineCounters CswKeepalivehttpPipelineInfo Optional HTTP pipeline counters CswKeepaliveHaCountersInfo This structure is the high-level description CSW keepalive HA counters statistics.
Data structures TABLE 339 5 Attributes (Continued) Name Type Presence Rules Description droppedOldRetransmit unsignedInt Optional Dropped old retransmit invalidDataInWait unsignedInt Optional Invalid data in wait inMemoryTcbError unsignedInt Optional In memory TCB error noTcbInReverse unsignedInt Optional No TCB in reverse nonConnectionTcbInAck unsignedInt Optional Non connection TCB in acknowledgement invalidTcbOnClient unsignedInt Optional Invalid TCB on client.
5 Data structures CswKeepaliveServerPacketCountersInfo This structure is the high-level description of CSW keealive server packet counters information. TABLE 341 Attributes Name Type Presence Rules Description numFinPacketsReceived unsignedInt Optional Number of fin packets received notInWaitQueue unsignedInt Optional Not in wait queue CswKeepaliveServerSessionCountersInfo This structure is the high-level description of CSW keepalive server session counters information.
Data structures 5 CswLayer7Operations This structure is the high-level description of CSW layer 7 operations. TABLE 344 Attributes Name Type Presence Rules Description maxLayer7Connections unsignedInt Optional Maximum 160,000 Maximum number of connections. dropOnMaxExceed Server Optional Dropping the requests after exceeding the maximum number of connections. dropOnUnavailable Server Optional Dropping the requests when servers are unavailable.
5 Data structures TABLE 345 Attributes Name Type Presence Rules Description policyName string Mandatory Name of the policy. policyType cswPolicyOrRuleTypeEnum Mandatory Type of the policy. isCaseSensitive boolean Optional Case in-sensitive or not. ruleActionList RuleActionMapping[ ] Optional Rules and associated actions. defaultAction CswAction[ ] Optional Default action. CswPolicyFilter This structure is the high-level description of CSW policy filter.
Data structures 5 CswPolicyRules This structure is the high-level description of CSW policy rules. TABLE 348 Attributes Name Type Presence Rules Description name string Mandatory Maximum 80 characters. Name of the rule. ruleType cswActionTypeEnum Mandatory Type of the rule. actionType string Optional Type of action. hitCount unsignedInt Optional Number of times rule hit. CswPolicySimpleFilter This structure is the high-level description of CSW policy simple filter.
5 Data structures CswPropertyList This structure is the high-level description CSW property list. TABLE 351 Attributes Name Type Presence Rules Description propertyName cswPropertyListEnum Mandatory Property type enumeration. propertyValue string Mandatory Property value. CswRewriteCountersStatistics This structure is the high-level description CSW rewrite counters statistics TABLE 352 .
Data structures 5 CswRuleInfo This structure is the high-level description of CSW rule information. TABLE 355 Attributes Name Type Presence Rules Description name string Mandatory Maximum 80 characters Name of the rule. ruleType cswPolicyOrRuleTypeEnum Mandatory Type of rule. referenceCount unsignedInt Optional Number of policies attached to this rule. subRuleCount unsignedInt Optional Sub rule count. subRules string[ ] Optional Sub rules.
5 Data structures TABLE 357 Attributes (Continued) Name Type Presence Rules Description inUse boolean Optional TRUE if policy is in use. caseInsensitive boolean Optional Case in-sensitive or not. DnsDpiPolicyFilter This structure is the high-level description of Dns port policy filter. TABLE 358 Attributes Name Type Presence simpleFilter DnsDpiPolicySimpleFilter Optional Rules Description Simple filter description.
Data structures 5 DnsDpiRuleInfo This structure is the high-level description DNS DPI rule information. TABLE 361 Attributes Name Type Presence Rules Description ruleName string Optional Name DNS DPI rule. action cswActionTypeEnum Optional Action mapped to the rule. hitCount unsignedInt Optional Hit count of DNS DPI rule. rateLimit unsignedInt Optional Rate limit. DnsGlobalOperations This structure is the high-level description DNS global operations.
5 Data structures TABLE 364 Attributes (Continued) Name Type Presence Rules Description healthCheckRetries unsignedInt Optional 1-5 Health check retries. healthCheckPort string Optional Health Check Port. contentCheck boolean Optional Content check . contentCheckName string Optional Content check name. sendASCIIString string Optional Send ASCII string. healthCheckProtocol string Optional Health check enabled or not.
Data structures 5 ElementHealthChecksSummary This structure is a high-level description of element health check summary. TABLE 367 Attributes Name Type Presence Rules Description policyName string Optional Name of the policy. type string Optional Type of element check. port string Optional Name of the port. protocol string Optional Name of the protocol. inUse boolean Optional Policy is in Use or not. enabled boolean Optional Enabled or disbled.
5 Data structures HealthCheckPolicyInfo This structure is a high-level description of health check policy information. TABLE 369 Attributes Name Type Presence Rules Description healthCheckPolicy HealthCheckPolicyTypeEnum Optional Health check policy type. policyName string Optional Name of the policy. HttpPortPolicy This structure is a high-level description of any HTTP port policy.
Data structures 5 L3HealthCheckInfo This structure is the high-level description of Layer 3 health check information. TABLE 372 Attributes Name Type Presence Rules Description enableForRealServers boolean Optional Enable Layer 3 health check for real servers. enableForRemoteServers boolean Optional Enable Layer 3 health check for remote servers. checkInterval unsignedInt Optional 30 The interval in seconds between health checks.
5 Data structures Layer7ContentBufferingOptions This structure is the high-level description of Layer 7 content buffering options. TABLE 375 Attributes Name Type Presence Rules Description windowSize unsignedInt Optional default is 8000 Windows size. preventAcktoClient boolean Optional Prevent ACK to client . LdapPortPolicy This structure is the high-level description of LDAP Port Policy.
Data structures 5 MatchListsSummary This structure is the high-level description of Match list summary. TABLE 379 Attributes Name Type Presence Rules Description name string Optional Name of match list. defaultAction upOrDownEnum Optional Default action for match list. totalMatchStringCount unsignedInt Optional Total match list strings count. MatchListSummaryFilter This structure is the high-level description of matchlist summary filter.
5 Data structures OtherHealthCheckInfo This structure is a high-level description of other health check information. TABLE 382 Attributes Name Type Presence Rules Description otherHealthCheckType OtherHealthCheckTypeEnum Optional Other health Check type. masterPort ServerPort Optional Master port details. aliasPort ServerPort Optional Alias port details. retrycount unsignedInt Optional Retry count. firewall Server Optional Firewall details.
Data structures 5 TABLE 385 Members Type Presence Rules Description failSafeGroupIDv6 unsignedInt Optional Creates fail safe group ID – IPv6. maxEntriesV4 unsignedLong Optional IPv4 - 10,000,000 Specifies the maximum number of PBSLB entries you want to configure for IPv4. maxEntriesV6 unsignedLong Optional IPv6 - 1,000,000 Specifies the maximum number of PBSLB entries you want to configure for IPv6.
5 Data structures PortConfigData This structure is the high-level description of port configuration data. TABLE 387 Attributes Name Type Presence Rules Description sourceIPOrHostName string Optional Source IP or host name. Wildcard string Optional Wild card. Operator string Optional Type of the filter operator portType string Optional Port type. PortPoliciesSummary This structure is a high-level description of port policies summary.
Data structures TABLE 389 5 Attributes (Continued) Name Type Presence Rules Description protocol string Optional The value of the protocol, which is the TCP or UDP port name or number.
5 Data structures PortPolicySummarySimpleFilter This structure is the high-level description of port policy summary simple filter. TABLE 391 Attributes Name Type Presence Rules Description field portPolicySummaryFilterFieldEnum Mandatory Name of the filter field. operator filterOperatorEnum Mandatory Type of the filter operator. value string Optional Ignored when "operator" value is "RANGE". Value of the field for filtering.
Data structures TABLE 392 5 Attributes (Continued) Name Type Presence Rules Description l4HealthCheckOnly boolean Optional Specifies whether to restrict health checks to L4 ports. sessionSync boolean Optional Enables failover for individual sessions useMasterPortHealthCheck boolean Optional If the port is an alias, specifies whether to base its health on the master port. fastBringup boolean Optional Lets the Virtual control new connections to allow the server time to ramp up.
5 Data structures PortProfileSummaryFilter This structure is the high-level description of port profile sumamry filter. Derived from: restricting anyType TABLE 394 Name Attributes Type Presence simpleFilter PortProfileSummarySimpleFilter Rules Mandatory Description Name of the filter field. PortProfileSummarySimpleFilter This structure is the high-level description of port profile summary simple filter.
Data structures 5 predictorDynamicWeightInfo This structure is the high-level description of any dynamic weighted predictor. TABLE 397 Attributes Name Type Presence Rules Description snmpRequestEntry unsignedInt Optional The SNMP request entry identifier. snmpRequestOID string Optional The SNMP request OID value in ASN.1 format. PredictorMethodConfiguration This structure is the high-level description of any predictor method configuration.
5 Data structures RealServerBulkConfig This structure defines the real server bulk configuration. TABLE 400 Attributes Name Type Presence Rules Description adminstate twoWayToggleEnum Optional Admin state isRemote boolean Optional Is remote isBackup boolean Optional Is backup RealServerConfiguration This structure is the high-level description of any real server configuration.
Data structures TABLE 401 5 Attributes (Continued) Name Type Presence maxConnection unsignedInt Optional The maximum TCP connection rate. The range is from 1 to 65535. maxTCPConnRate unsignedLong Optional The maximum TCP connection rate. maxUDPConnRate unsignedLong Optional The maximum UDP connection rate.The range is from 1 to 65535. enableDestinationNAT boolean Optional Enables the destination NAT.
5 Data structures RealServerConnStats This structure is the high-level description of a filter any real server connection status. TABLE 402 Attributes Name Type Presence Rules Description port string Optional The name or number of the Layer 4 port. currentConn unsignedInt Optional The number of client connections currently on the real server. peakConn unsignedInt Optional The highest number of connections the real server has had at the same time.
Data structures 5 RealServerGroup This structure is the high-level description of any real server group. TABLE 405 Attributes Name Type Presence Rules Description groupName string Optional Real server group name. realServers string[ ] Optional List of real servers in a group. RealServerGroupBind This structure is the high-level description of binding a real server group to a virtual server.
5 Data structures Name Type Presence Rules Description startVal ue string Optional This parameter is mandatory and considered only when "operator" value is "RANGE". Start value in a range. startVal ue string Optional This parameter is mandatory and considered only when "operator" value is "RANGE". End value in a range. RealServerGroupSummary This structure is the high-level description of any real server group summary.
Data structures TABLE 411 5 Attributes (Continued) Name Type Presence Rules Description isRemote boolean Optional Designates the real server as a remote server in the Brocade Virtual ADX. isBackup boolean Optional Designates the real server to be a backup server. enableSourceNAT boolean Optional Enables source NAT on the real server.
5 Data structures TABLE 412 496 Attributes (Continued) Name Type Presence Rules Description disablePortHealthCheck boolean Optional Disable health check for each port. enableL4CheckOnly boolean Optional Enables the layer 4 health check alone. l4BringupCheckInterval unsignedInt Optional The range is from 1 to 255. The layer 4 bringup health check interval. l7BringupCheckInterval unsignedInt Optional The range is from 1 to 255. The layer 7 bringup health check interval.
Data structures 5 RealServerPortConnStats This structure is the high-level description of any real server port connection statistics. TABLE 413 Attributes Name Type Presence rsPort Server Optional RS port runTimeState realServerAndPortStatusEnum Optional Run time state currentConn unsignedInt Optional The number of client connections that are currently on the real server port.
5 Data structures RealServerPortConnStatsFilter This structure is the high-level description of any any real server port connection statistics filter. TABLE 414 Attributes Name Type Presence simpleFilter RealServerPortConnStatsSimpleFilter Optional Rules Description Simple filter description. RealServerPortConnStatsSimpleFilter This structure is the high-level description of any real server port connection statistics simple filter.
Data structures 5 RealServerPortSimpleFilter This structure is the high-level description of any real server port filter. TABLE 418 Attributes Name Type Presence Rules Description field realServerPortFilterFieldEnum Optional The filter field name. operator filterOperatorEnum Optional The filter operator type. value string Optional The value of the field for filtering. startValue string Optional The start value in a range. endValue string Optional The end value in a range.
5 Data structures TABLE 420 Attributes (Continued) Name Type Presence Rules Description txPkts unsignedInt Optional The number of packets sent by the port to the server. applRTTms unsignedInt Optional Application round-trip time, in milliseconds. rxPktsRate unsignedInt Optional Rx packets rate txPktsRate unsignedInt Optional Tx packets rate totalConnections unsignedInt Optional Total number of connections.
Data structures 5 RealServerPrimaryBackupList This structure is a mapping of primary to backup server. TABLE 424 Attributes Name Type Presence Rules Description primaryServer Server Optional Identifies the primary server associated with a backup server. backupServer Server Optional Identifies the backup server. RealServerPrimaryBackupSimpleFilter This structure is the high-level description of any real server primary backup filter.
5 Data structures RealServerSummary This structure is the high-level description of a real server with some of its frequently used attributes. TABLE 428 Attributes Name Type Presence Rules Description realServer Server Optional Identifies a real server. adminStatus twoWayToggleEnum Optional The administrative state of the real server. runTimeState realServerAndPortStatusEnum Optional The runtime state of the server, whether it is up or down.
Data structures TABLE 429 5 Attributes (Continued) Name Type Presence Rules Description runTimeStatus realServerAndPortStatusEnum Optional The runtime state of the server, whether it is up or down. isRemoteServer boolean Optional The real server information, whether it is remote or not. isBackup boolean Optional The real server information, whether it is a backup or not. portSummary RealServerPortSummary[ ] Optional Real server port summary.
5 Data structures RequestHeader This structure is the high-level description of the request header. TABLE 433 Attributes Name Type Presence Rules Description contextName string Optional Name of the context. sessionID string Optional The session ID. RequestRule This structure is the high-level description . TABLE 434 Attributes Name Type Presence Rules Description ruleName string Mandatory Request rule name. ruleType cswRequestRuleTypeEnum Mandatory Rule type.
Data structures 5 ScriptBindpoint This structure represents a script and a server port. TABLE 437 Attributes Name Type Presence Rules Description name string Mandatory Name of the script bindpoint ServerPort Mandatory Server port at which the script is bound ScriptBindpointSummary This structure represents the summary of a script at a binding.
5 Data structures ScriptConfigurationSummary This structure represents the configuration summary of the script.
Data structures 5 ScriptFilter This structure is a hih-level descriptiion of script filter information TABLE 445 Attributes Name Type Presence simpleFilter ScriptSummarySimpleFilter Rules Description ScriptPerformanceEstimate This structure is a high-level description of script performance estimation details. TABLE 446 Attributes Name Type Presence Rules Description cpsEstimate unsignedInt Optional cps value. cpuUtilization unsignedInt Optional CPU utilization value.
5 Data structures ScriptProfileSimpleFilter This structure is the high-level description of script profile simple filter information. TABLE 449 Attributes Name Type Presence Rules Description field ScriptProfileFilterFieldEnum Unused Field operator filterOperatorEnum Unused Operator value string Unused Value startValue string Unused Start value endValue string Unused End value ScriptResourceSummary This structure is currently unused.
Data structures 5 Server This structure is the high-level description of any real or virtual server. TABLE 453 Attributes Name Type Presence Rules Description Name string Optional The name of the target server. IP string Optional The IP address of the target server. Description string Optional The description of the server. ServerAndConfiguredPortList This structure is the high-level description of any server with list of associated ports.
5 Data structures TABLE 456 Attributes (Continued) Name Type Presence Rules Description startValue string Optional This parameter is mandatory and considered only when the operator value is RANGE. The start value in a range. endValue string Optional This parameter is mandatory and considered only when the operator value is RANGE. The end value in a range. ServerAndConfiguredPortWithProfileList This structure represents a script along with a bindpoint and a script profile.
Data structures 5 ServerPort This structure is a high-level description of server port. TABLE 460 Attributes Name Type Presence Rules Description srvr server Optional Maximum 48 characters. Name of the real server. port L4Port Optional Maximum 48 characters Port details serverSimpleFilter This structure is the high-level description of a filter for a server.
5 Data structures TABLE 462 Attributes (Continued) Name Type Presence Rules Description interval2 unsignedInt Optional Valid from 1 to 1000000. Specifies the length of the second interval in seconds. maxConnections unsignedInt Optional Valid from 1 to 1000000. Number of concurrent connections allowed for the port during the time the server is active. SSLCertInfo This structure is a high-level description of any SSL certificate.
Data structures 5 SSLCSRInfo This structure is a high-level description of any SSL Certificate Signing Request (CSR). TABLE 465 Attributes Name Type Presence Rules Description countryName string Optional The name of the country. Only two characters are allowed. stateOrProvince string Optional The name of the state. locality string Optional The name of the locality. organizationName string Optional The name of the organization.
5 Data structures TcpOptions This structure is the high-level description of TCP options. TABLE 468 Attributes Name Type Presence sack boolean timeStamp boolean windowScale unsignedInt Rules Description TftpInfo The following is the data structure for TFTP information: TABLE 469 Members Type Presence Rules Description tftpServerIP string Mandatory TFTP server IP address. targetFileName string Mandatory Policy list file on the TFTP server.
Data structures 5 VirtualServerConfiguration This structure a high-level description of any virtual server configuration. TABLE 472 Attributes Name Type Presence virtualServer Server Optional The virtual server name. clientMaxConnLimit string Optional The maximum number of client connections allowed for the virtual server. clientTcpRateTransactionLimit string Optional The maximum number of TCP transactions allowed for the virtual server.
5 Data structures TABLE 472 516 Attributes (Continued) Name Type Presence Rules Description stickyAgeMultiplier unsignedInt Optional enableVipProtection boolean Optional predictor predictorEnum Optional The load balancing predictor that the Brocade Virtual ADX uses to balance traffic among the real servers bound to the virtual server.
Data structures TABLE 472 5 Attributes (Continued) Name Type Presence Rules Description nextHop string Optional tosMarking unsignedInt Optional enableHealthCheckLayer3DSR boolean trackingMode trackingModeE num Optional Determines if it is a port or a group of ports. trackPort L4Port Optional Track port trackPortList L4Port[] Optional List of ports in a track group. vipHealthInjectionSubnetLength unsignedInt Optional VIP RHI Route Mask Length.
5 Data structures TABLE 473 Attributes (Continued) Name Type Presence Rules Description currentConnections unsignedInt Optional The total connections through the virtual server. totalConn unsignedInt Optional The number of client connections on the server since the Brocade Virtual ADX was last booted. rcvPkts unsignedInt Optional The number of packets that the Brocade Virtual ADX has received from the virtual server.
Data structures TABLE 475 5 Attributes (Continued) Name Type Presence Rules Description startValue string Optional This parameter is mandatory and considered only when the operator value is RANGE. The start value in a range. endValue string Optional This parameter is mandatory and considered only when the operator value is RANGE. The end value in a range. VirtualServerFilter This structure is the high-level description of any virtual server filter.
5 Data structures VirtualServerMonitoringInfo This structure is the high-level description of any virtual server monitoring information.
Data structures TABLE 479 5 Attributes (Continued) Name Type Presence customHealthCheck string Optional The name of the customized health check. enableClientKeepAlive boolean Optional Enables client keepalive. enableBackupMechanism boolean Optional Enables back up if required. enableServerGroupFailover boolean Optional Enables server group failover. enablePersistentHash boolean Optional Enables a persistent hashing mechanism for the virtual server port.
5 Data structures TABLE 479 522 Attributes (Continued) Name Type Presence Rules Description enableSSLSessionidSwitching boolean Optional Enables SSL session ID switching on the virtual server port. enableSwL4Pbslb boolean Optional Enables policy-based SLB on a virtual server port. enableWaitforEndHTTP boolean Optional The device buffers all request packets until all the necessary information is received ensuring that the whole HTTP header is saved.
Data structures TABLE 479 5 Attributes (Continued) Name Type Presence Rules Description enableSessionSync boolean Optional Specifies whether session sync is enabled for this port. stateless boolean Optional Specifies whether the port is stateless. disableHashing boolean Optional Specifies whether the stateless SLB uses a hashing algorithm to select a real server or not. enableSpoofing boolean Optional Enables spoofing for reverse SLB traffic.
5 Data structures TABLE 480 Attributes (Continued) Name Type Presence Rules Description totalConn unsignedInt Optional The number of client connections on the virtual server since the Brocade Virtual ADX was booted. tcpProxyProfileName string Optional The TCP Proxy profile applied to the port. rxPktsRate unsignedInt Optional Rate of Rx packets. txPktsRate unsignedInt Optional Rate of Tx packets.
Data structures 5 VirtualServerPortStatus This structure is a high-level description of any virtual server port status. TABLE 484 Attributes Name Type Presence Rules Description status predictorEnum[] Optional The state of the virtual server port. adminState twoWayToggleEnum Optional The admin status. VirtualServerPortSummary This structure provides the summary details of the virtual server port.
5 Data structures VirtualServerPortSummaryInfo This structure is a high-level description of of any virtual server port summary information.
Data structures 5 VirtualServerStatus This structure is a high-level description of any virtual server status. TABLE 490 Attributes Name Type Presence Rules Description virtualServer Server status virtualServerAndPortStatusEnum[ ] Optional Indicates the current status of the virtual server.
5 Data structures VirtualServerStatusSimpleFilter This structure is the high-level description of a simple filter for the virtual server status. TABLE 492 Attributes Name Type Presence field virtualServerStatusFilterFieldEnum Mandatory The filter field name. operator filterOperatorEnum Mandatory The filter operator type. value string Optional Ignored when the operator value is RANGE. The value of the field for filtering.
Data structures TABLE 493 5 Attributes (Continued) Name Type Presence Rules Description txPkts unsignedInt Optional The number of packets the Brocade Virtual ADX has sent to the virtual server totalPorts unsignedInt Optional This is the total number of ports on this real server symmetricPriority unsignedInt Optional Symmetric priority ports VirtualServerPortSummary[ ] Optional Ports currentConnRate unsignedInt Optional Current connection rate rxPktsRate unsignedInt Optional R
5 Data structures TABLE 495 Attributes (Continued) Name Type Presence Rules Description startValue string Optional This parameter is mandatory and considered only when the operator value is RANGE. The start value in a range. endValue string Optional This parameter is mandatory and considered only when the operator value is RANGE. The end value in a range. VirtualToRealServerPortBinding This structure is a high-level description of virtual server to real server-port binding.
Enumerations 5 Enumerations booleanOperatorEnum This type of data will be a boolean operator enumerated list. Derived from: restricting string TABLE 498 Parameters Description AND To configure a health-check policy that is successful only if the device ADX receives a successful reply from all servers and application ports in the policy. OR To create a health-check policy that is successful if at least one of the applications passes its health check.
5 Enumerations cswPolicyFilterEnum This type of data will be an enumerated list. Derived from: restricting string TABLE 500 Parameters Description POLICY_NAME CSW policy name POLICY_TYPE CSW policy type NUM_RULES Number of CSW rules IN_USE Flag to identify whether the filter is being used. CASE_SENSITIVE Flag to identify whether the filter is case-sensitive cswPolicyOrRuleTypeEnum This type of data will be an enumerated list.
Enumerations 5 TABLE 502 Parameters Description DNS_TYPE Valid Query types: or ADDRESS_RECORD or IPV6_ADDRESS_RECORD or CERTIFICATE_RECORD or CANONICAL_NAME_RECORD or DNS_KEY_RECORD or DELEGATION_SIGNER or IPSEC_KEY_RECORD:KEY_RECORD or LOCATION_RECORD or MAIL_EXCHANGE or NAME_SERVER or NEXT_SECURE_RECORD or POINTER_RECORD or DNSSEC_SIGNATURE or SERVICE_LOCATOR or TEXT_RECOR.
5 Enumerations TABLE 502 Parameters Description COOKIE_NAME Cookie name COOKIE_DOMAIN Cookie domain COOKIE_PATH Cookie path COOKIE_AGE Cookie age HEADER_DIRECTION REQUEST, RESPONSE HEADER_VALUE HTTP Header value CLIENT_IP_HEADER_NAME Client IP Header name CLIENT_CERTIFICATE_INSERT_FIELDS Valid strings ENTIRE_CHAIN, LEAF_ONLY, WELL_KNOWN_FIELDS CLIENT_CERTIFICATE_HEADER Client certificate header MATCHED_STRING Matched string CUSTOM_STRING Custom string POSITIVE_OFFSET Possitive off
Enumerations 5 TABLE 503 Parameters Description UDP_CONTENT UDP content rule type NESTED Nested rule type. NESTED_CONTENT Nested content. cswResponseRuleTypeEnum This type of data will be an enumerated list. Derived from: restricting string TABLE 504 Parameters Description STATUS_CODE Status code HEADER HTTP Header value BODY HTTP Body value cswRuleFilterEnum This type of data will be an enumerated list.
5 Enumerations TABLE 506 Parameters Description CSW_XML_TAG CSW_NESTED_RULE DPI_ADDRESS DPI_IPV6_ADDRESS DPI_CERTIFICATE DPI_CANONICAL_NAME DPI_DNS_KEY DPI_DELEGATION_SIGNER DPI_IPSEC_KEY DPI_KEY DPI_LOCATION DPI_MAIL_EXCHANGE DPI_NAME_SERVER DPI_NEXT_SECURE DPI_POINTER_DNSSEC DPI_START_OF_AUTHORITY DPI_SERVICE DPI_TEXT DPI_DNS_QUERY_NUMBER DPI_DNS_QUERY_NAME DPI_DNS_NO_QUERY_NAME_OR_TYPE TCP_CONTENT UDP_CONTENT TCA_DNS NESTED_CONTENT RESPONSE_STATUS_CODE RESPONSE_HEADER RESPONSE_BODY cswRuleTypeEnum T
Enumerations 5 dnsDpiFilterEnum This type of data will be an enumerated list. Derived from: restricting string TABLE 508 Parameters Description BIND_COUNT Bind count. dsrStateEnumt This type of data will be an enumerated list.
5 Enumerations errorEnum This structure is the high-level description of all generated faults and their return messages. Please refer to List of Error Messages for further information. filterOperatorEnum These are the enumerations for filter operations. TABLE 512 Parameters Description CONTAINS If the search data is part of the field. Applicable only on string type fields. LESS_THAN If the value is less the filter value. Applicable only on Integer type fields.
Enumerations 5 haStatusEnum This type of data describes a HA status enumerated list. TABLE 515 Parameters Description ACTIVE Indicates the active device in the HA pair. STANDBY Indicates the standby device in the HA pair. HealthCheckPolicyTypeEnum This type of data will be a health check policy type enumerated list. Derived from: restricting string TABLE 516 Parameters Description SCRIPTEDTYPE Scripted health check.
5 Enumerations l4PortTypeEnum This is an enumerated list describing L4 port types. TABLE 519 Parameters Description TCP Indicates a TCP port. UDP Indicates a UDP port. ldapVersionEnum This type of data will be an enumerated list. Derived from: restricting string TABLE 520 Parameters Description V2 Version 2 of the LDAP. V3 Version 3 of the LDAP. matchConditionEnum This type of data will be a match condition enumerated list.
Enumerations 5 Derived from: restricting string TABLE 523 Parameters Description POLICIES_DISABLE Disable policy. POLICIES_ENABLE Enable policy pbSlbConfigFilterFieldEnum This type of data describes the enumerations for PBSLB configuration filter field. TABLE 524 Parameters Description IP_ADDRESS IP address. SUBNET_MASK Subnet mask. SERVER_GROUP_ID Server group ID. MASK_BIT Mask bit. pbslbGlobalAttributeEnum This type of data describes the enumerations for PBSLB global attributes.
5 Enumerations pbSlbTftpStatusEnum This type of data describes the enumerations for PBSLB TFTP status. TABLE 526 Parameters Parameters Description COMPLETED_NO_ERROR TFTP operation completed with no errors. TIMEOUT_ERROR Time out error. UNKNOWN_ERROR Unknown error. STATUS_UNKNOWN Status is unknown. FLASH_PREPARATION_FOR_READ_FAILED Flash preparation failed. FLASH_READ_ERROR Flash read error. FLASH_PREPARATION_FOR_ WRITE_FAILED Flaash preparation for write failed.
Enumerations 5 Derived from: restricting string TABLE 527 Parameters Description POLICY_NAME Policy name PORT Port number or name PROTOCOL Protocol number or name INUSE Flag to identify whether the filter is being used. portProfileSummaryFilterFieldEnum This type of data will be a port profile filter enumerated list. Derived from: restricting string TABLE 528 Parameters Description PORT Port number or name. PROTOCOL Protocol number or name.
5 Enumerations TABLE 530 Parameters Description WEIGHTED_ROUND_ROBIN_STATIC The static weighted round robin method. DYNAMIC_WEIGHTED_DIRECT The dynamic weighted direct method. DYNAMIC_WEIGHTED_REVERSE The dynamic weighted reverse method. realServerAndPortStatusEnum This data describes the real server and port enumerated list. TABLE 531 Parameters Description DISABLED The port is disabled. ENABLED The port is enabled. FAILED The last operation on port failed.
Enumerations 5 TABLE 532 Parameters Description ENABLE_SOURCE_NAT Enables source NAT. ENABLE_DESTINATION_NAT Enables the destination NAT. ENABLE_HW_FORWARD_PASSTHROUGH_TRAFFIC Enables the hardware forward of pass through traffic. NO_REVERSE_NAT Disables reverse NAT. SOURCE_NAT_ACL_ID The ACL ID for source NAT. SOURCE_IP The source IP address. MAX_CONNECTION The maximum number of connections. ENABLE_EXCEED_MAX_DROP Drops the packet if the maximum connections are surpassed.
5 Enumerations realServerPortAttributesEnum This structure is the high level description of a real server port attributes. TABLE 535 Parameters Description MAX_TCP_CONN_RATE Maximum TCP connection rate. MAX_UDP_CONN_RATE Maximum UDP connection rate. MAX_CONNECTIONS Maximum connection rate. TCP_ONLY Allows only TCP traffic to the real server port. UDP_ONLY Allows only UDP traffic to the real server port. SERVER_ID Server ID SLOW_START_ID Configured slow start ID.
Enumerations 5 TABLE 536 Parameters Description TX_BYTES Tx bytes APPL_RTT_MS Application RTT MS TCP_RTT_MSTCP_RTT_MS TCP RTT MSTCP RTT MS CURRENT_TCP_RTT Current TCP RTT CURRENT_APPL_RTT Current Application RTT ADMIN_STATUS Admin status IS_BACKUP Is backup PORT_RUNTIME_STATUS Port runtime status REASSIGN_COUNT Reassign count realServerPortFilterFieldEnum This type of data describes the real server filter.
5 Enumerations TABLE 538 Parameters Description TX_PKTS Tx packets APPL_RTT_MS Application RTT MS TOTAL_CONNECTIONS Total number of connections realServerPrimaryBackupFilterFieldEnum This is an enumerated list describing the real server primary backup filter. TABLE 539 Parameters Description PRIMARY_SERVER_NAME The name of the primary real server. PRIMARY_SERVER_IP The IP address of the primary server. BACKUP_SERVER_NAME The name of the backup server.
Enumerations 5 TABLE 542 Parameters Description PORT Port number VSERVER_AND_PORT ScriptProfileFilterFieldEnum This type of data describes the enumerations for the script profile filter. TABLE 543 Parameters Description PROFILE_NAME ScriptStateEnum This type of data describes the enumerations for the state of the script.
5 Enumerations synProxyGlobalConfigAttributeEnum This type of data describes the enumerations for types of Syn-proxy global configuration attribute names. TABLE 547 Parameters Description ENABLE_SYN_PROXY Enable Syn Proxy. ENABLE_AUTO_CONTROL Enables auto control. LIMIT_SYN_PROXY_TO_DEFINED_VIPS Limits Syn Proxy to Defined Vips. LIMIT_SYN_PROXY_TO_VIP_TRAFFIC_ONLY Limits Syn Proxy to VIP traffic only. ENABLE_SOURCE_MAC_TO_ADX_MAC Enable source MAC to ADX MAC address.
Enumerations 5 Derived from: restricting string TABLE 550 Parameters Description ENABLED enabled DISABLED disabled upOrDownEnum This type of data will be an up or down enumerated list. Derived from: restricting string TABLE 551 Parameters Description UP UP state of the port. DOWN DOWN state of the port. virtualServerAndPortStatusEnum This type of data describes the virtual server and the port enumerated list.
5 Enumerations virtualServerAttributeEnum This type of data describes the virtual server attributes enumerated list. TABLE 553 Parameters Description CLIENT_MAX_CONN_LIMIT The maximum number of client connections allowed for the virtual server. CLIENT_TCPRATE_TRANSACTION_LIMIT The maximum number of TCP transactions allowed for the virtual server. CLIENT_UDPRATE_TRANSACTION_LIMIT The maximum number of UDP transactions allowed for the virtual server.
Enumerations 5 virtualServerConnStatsFilterFieldEnum This type of data describes the enumerations for fields in virtual server connection statistics. TABLE 554 Parameters Description SERVER_NAME Identifier for the “virtualServerConnStats ->virtualServer->Name” parameter. SERVER_IP Identifier for the “virtualServerConnStats ->virtualServer->IP” parameter. STATUS Identifier for the “virtualServerConnStats -> virtualServerStatusInfo-> status” parameter.
5 Enumerations virtualServerPortAttributeEnum This type of data describes the virtual server port attributes enumerated list. TABLE 556 Parameters Description ADMINSTATE The administrative state of the virtual server. ENABLE_STICKY Designates the virtual server port to be sticky. ENABLE_DSR Enables Direct Server Return (DSR) on the virtual server port. IS_CONCURRENT The port is configured for concurrent connections. ENABLE_CLIENT_SUBNETSTICKY Enables sticky sessions based on the client subnet.
Enumerations 5 TABLE 556 Parameters Description ENABLE_WINDOWS_TERMINAL_SERVERPORT Enables the windows terminal server port. ENABLE_STICKY_ACL Enables sticky ACL. ENABLE_DROP_ACK_WITH_NODATA Drops acknowledgement with no data. ENABLE_SSL_SESSIONID_SWITCHING Enables SSL session ID switching on the virtual server port. ENABLE_SWL4_PBSLB Enables policy-based SLB on a virtual server port.
5 Enumerations virtualServerPortSummaryFilterFieldEnum This type of data describes the enumerations for fields in the virtual server port summary filter. TABLE 558 Parameters Description SERVER_NAME Identifier for the “virtualServerPortSummary->virtualServerPort>srvr->Name” parameter. SERVER_IP Identifier for the “virtualServerPortSummary->virtualServerPort>srvr->IP” parameter. PORT_NAME_OR_NUMBER Identifier for the “virtualServerPortSummary->virtualServerPort>port-> NameOrNumber” parameter.
Enumerations 5 TABLE 559 Parameters Description SYM_STATUS Identifier for the “virtualServerStatus ->symStatus” parameter. NUM_ACTIVE_TRANSITIONS Identifier for the “virtualServerStatus ->numActiveTransitions” parameter. NUM_BACKUP_TRANSITIONS Identifier for the “virtualServerStatus ->numBackupTransitions” parameter. NUM_MISSED_KEEP_ALIVES Identifier for the “virtualServerStatus ->numMissedKeepAlives” parameter.
5 Enumerations TABLE 561 558 Parameters Description REAL_SERVER_IP Real server IP REAL_SERVER_PORT_NAME_OR_NUMBER Real server port name or number Brocade Virtual ADX XML API Programmer’s Guide 53-1003248-01
Chapter 6 Security API Reference In this chapter • Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . • Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . • Data structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . • Enumerations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
6 Methods bindAclToInterface Description Binds ACLs to an IP interface. Parameter Table 2 contains the parameter required for the method. TABLE 2 Parameter Name Type Presence bindingInfo AclOnInterface Mandatory Rules Description ACL binding information on the IP interface. Error messages List of Error Messages bindAclToSsh Description Binds ACLs to restrict SSH access. Parameters Table 3 contains the parameters required for the method.
Methods 6 clearAclStatistics Description Removes the ACL statistics. Parameters Table 5 contains the parameters required for the method. TABLE 5 Parameters Name Type Presence Rules Description ids unsignedInt[] Optional Value from 1 to 99 for a standard ACL. Value from 100 to 199 for an extended ACL. Specifies ACL ID number for clearing statistics. all boolean Optional Clears all ACL statistics.
6 Methods deleteAcls Description Removes configured ACLs with all related rules from the configuration. Parameters Table 7 contains the parameters required for the method. TABLE 7 Parameters Name Type Presence idList AclID[] Mandatory Rules Description List of ACL ID numbers or names to be deleted. Error messages List of Error Messages. getAclBindingsOnInterfaces Description Retrieves ACLs bound to IP interfaces. Parameters Table 8 contains the parameters required for the method.
Methods 6 Return values Table 10 contains the return values of the method. TABLE 10 Return values Name Type Description config AclConfig ACL configuration parameters. Error messages List of Error Messages getAclInterfaceConfig Description Retrieves ACL IP interface configurations. Parameters Table 11 contains the parameters required for the method. TABLE 11 Parameters Name Type Presence Rules id InterfaceID Mandatory Description IP interface.
6 Methods Return values Table 14 contains return values of the method. TABLE 14 Return values Name Type Description genericInfo ResponseInformation bindingInfoListt AclOnInterface[] List of retrieved ACL binding information on IP interface. Error messages List of Error Messages getAllAclIDs Description Retrieves all the configured ACL IDs. Parameters Table 15 contains the parameter required for the method.
Methods 6 getAllAclRules Description Retrieves all the configured ACL rules. Parameters Table 17 contains the parameters required for the method. TABLE 17 Parameters Name Type Presence Rules Description id AclID Mandatory Acl ID or name startIndex unsignedInt Optional Start index for retreiving ACL rules. numRetrieved unsignedInt Optional Specifies the number of ACL rules to retrieve. Return values Table 18 contains the return value of the method.
6 Methods Return values Table 20 contains the return value of the method. TABLE 20 Return value Name Type Description genericInfo ResponseInformation aclList Acl[] List of ACL entries. Error messages List of Error Messages getAllAclSummary Description Retrieves a summary of all the configured ACLs (includes IPV4 and IPV6). Parameter Table 21 contains the parameter required for the method.
Methods 6 Parameters Table 23 contains the parameters required for the method. TABLE 23 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional Start index for retrieving statistics for IP protocol. numRetrieved unsignedInt Optional Number of ACLs statistics to be retrieved. filter AclTrafficFilter Optional Filter criteria. Return values Table 24 contains the return value of the method.
6 Methods Parameters Table 27 contains the parameters required for the method. TABLE 27 Parameters Name Type Presence Rules Description idList AclID[] Optional Either “idList” or “all” must be present. Both cannot be present together. ACL ID numbers or names for rebinding. all boolean Optional Either “idList” or “all” must be present. Both cannot be present together. Rebinds all ACLs.
Methods 6 unbindAclFromInterface Description Unbinds Access Control Lists from an IP interface. Parameters Table 30 contains the parameter required for the method. TABLE 30 Parameter Name Type Presence bindingInfo AclOnInterface Mandatory Rules Description Clears ACL binding information on an IP interface. Error messages List of Error Messages unbindAclFromSsh Description Unbinds ACLs to restrict SSH access. Parameters Table 31 contains the parameters required for the method.
6 Methods Security - Network Address Translation Description Network Address Translation (NAT) is the process of modifying IP address information in IP packet headers while in transit across a traffic routing device. NAT helps improve security by reusing IP addresses. The NAT router translates traffic coming into and leaving the private network. The following APIs use NAT to provide security functions on the Brocade Virtual ADX device.
Methods 6 Parameters Table 34 contains the parameters required for the method. TABLE 34 Parameters Name Type Presence Rules Description isInsideNat boolean Optional Both "insideNat" and "protocol" cannot be present. When set to “TRUE”, clear a specific NAT entry based on the private and global IP addresses. protocol ipProtocolEnum Optional Both "insideNat" and "protocol" cannot be present. Valid values are "TCP", "UDP" and "ICMP". Clears the NAT entries based on protocol.
6 Methods Parameters Table 36 contains the parameters required for the method. TABLE 36 Parameters Name Type Presence mapList StaticNatMap[] Mandatory Rules Description Static NAT global IP and private IP mapping. Error messages List of Error Messages deleteNatPools Description Deletes already configured NAT pools. Parameters Table 37 contains the parameters required for the method.
Methods 6 Parameters Table 39 contains the parameters required for the method. TABLE 39 Parameters Name Type Presence poolNames string[] Mandatory Rules Description Specifies the pool names. Return values Table 40 contains the return value of the method. TABLE 40 Return value Name Type Description bindingList AclOnNatPool[] Specifies ACLs to associated to NAT pools. Error messages List of Error Messages getAllNatPools Description Retrieves all the configured NAT pools.
6 Methods getAllStaticNatMappings Description Retrieves static NAT mappings. Parameters Table 43 contains the parameters required for the method. TABLE 43 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional Start index to retrieve static NAT mappings. numRetrieved unsignedInt Optional Number of mappings to be retrieved. Maximum value allowed is 10. filter StaticNatMapFilter Optional Filter criteria.
Methods 6 Error messages List of Error Messages getNatConfig Description Retrieves NAT configurations. Return values Table 47 contains the return value of the method. TABLE 47 Return value Name Type Description config NatConfig NAT configurations. Error messages List of Error Messages getNatPools Description Retrieves configured NAT pools. Parameters Table 48 contains the parameters required for the method.
6 Methods Return values Table 50 contains the return value of the method. TABLE 50 Return value Name Type Description infoList NatRedundancyInfo[] NAT redundancy information list. Error messages List of Error Messages setIPNatStatusOnRouter Description Sets the IP NAT status on the router. Parameters Table 51 contains the parameters required for the method. TABLE 51 Parameters Name Type Presence Rules Description id InterfaceID Mandatory Interface on which NAT is being enabled.
Methods 6 Parameters Table 53 contains the parameters required for the method. TABLE 53 Parameters Name Type Presence bindingList AclOnNatPool[] Mandatory Rules Description Specifies ACLs to be dis-associated with NAT pools. Error messages List of Error Messages Security - Secure Socket Layer Description The Secure Socket Layer (SSL) is a commonly-used protocol to manage the security of a message transmission on the Internet.
6 Methods Parameters Table 55 contains the parameters required for the method. TABLE 55 Parameters Name Type Presence Rules Description password string Mandatory Maximum of 24 characters. Master password. Error messages List of Error Messages. createSslCrlRecords Description Creates new Certificate Revocation List (CRL) records. Parameters Table 56 contains the parameters required for the method.
Methods 6 Parameters Table 58 contains the parameters required for the method. TABLE 58 Parameters Name Type Presence profileList TcpProfile[] Mandatory Rules Description Information required to create a new TCP profile. Error messages List of Error Messages. deleteSslCertificateFiles Description Delete SSL Certificate files. Parameters Table 59 contains the parameters required for the method.
6 Methods Parameters Table 61 contains the parameters required for the method. TABLE 61 Parameters Name Type Presence Rules Description filenames string[] Mandatory Key pair file must already exist. Names of the key pair files which need to be deleted. Error messages List of Error Messages deleteSslProfiles Description Deletes existing SSL profiles. Parameters Table 62 contains the parameters required for the method.
Methods 6 generateSslCsr Description Generates an SSL Certificate Signing Request (CSR). Parameters Table 64 contains the parameters required for the method. TABLE 64 Parameters Name Type Presence Rules Description keyPairFilename string Mandatory Identifies the SSL key file name. csrInfo SslCsrInfo Optional Identifies the details of the Distinguished Name (DN) that are to be included in the CSR. Return values Table 65 contains the return value of the method.
6 Methods Error messages List of Error Messages generateSslSelfSignedCertificate Description Generates the SSL self-signed certificate file on Brocade Virtual ADX. Parameters Table 68 contains the parameters required for the method. TABLE 68 Parameters Name Type Presence certificateInfo SslCertificateGenerationInfo Mandatory Rules Description Information required to generate the self-signed certificate file. Return values Table 69 contains the return value of the method.
Methods 6 Return values Table 71 contains the return values of the method. TABLE 71 Return values Name Type Description genericInfo ResponseInformation Generic response information. filenameList sslCertName[] Array of SSL certificate file names. Error messages List of Error Messages getAllSslCertificatesSummary Description Retrieves the summary information of all SSL certificates. Parameters Table 72 contains the parameters required for the method.
6 Methods Return values Table 73 contains the return values of the method. TABLE 73 Return values Name Type Description genericInfo ResponseInformation Generic response information. summaryList SslCertificateSummary[] Returns the information of all SSL certificate information. Error messages List of Error Messages getAllSslCrlRecordNames Description Retrieves all CRL record names. Parameters Table 74 contains the parameters required for the method.
Methods 6 getAllSslCrlStatus Description Get status information of all SSL CRL from MP. Parameters Table 76 contains the parameters required for the method. TABLE 76 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional Sets the start index for retrieving the CRL record status. When both the startIndex and numRetrieved parameters are not present, then the status of the possible number of CRL records is returned.
6 Methods Parameters Table 78 contains the parameters required for the method. TABLE 78 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional Sets the start index for retrieving the key pair file names. When both startIndex and numRetrieved parameters are not present, all the key pair names are returned. numRetrieved unsignedInt Optional Specifies the number of key pair file names to retrieve. Maximum value allowed is 4096.
Methods 6 Return values Table 81 contains the return values of the method. TABLE 81 Return values Name Type Description genericInfo ResponseInformation Generic response information. summaryList SslKeyPairFileSummary[] SSL key summary. Error messages List of Error Messages getAllSslProfileBindingsSummary Description Retrieves the summary information of all SSL services (enabled on all virtual servers). Parameters Table 82 contains the parameters required for the method.
6 Methods Return values Table 83 contains the return value of the method. TABLE 83 Return value Name Type Description genericInfo ResponseInformation Generic response information. summaryList SslProfileBindingsSummary[] Summary information of all SSL services enabled on VIP ports. Error messages List of Error Messages getAllSslProfileNames Description Retrieves all SSL profile names. Parameters Table 84 contains the parameters required for the method.
Methods 6 Parameters Table 86 contains the parameters required for the method. TABLE 86 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional Sets the starting index for labeling the number of SSL profiles on the virtual server in an ordered list. When both startIndex and numRetrieved parameters are absent, then a number of SSL profiles are returned.
6 Methods TABLE 88 Parameters Name Type Presence Rules Description numRetrieved unsignedInt Optional Specifies the number of SSL profiles to retrieve. Maximum value allowed is 256. When both the startIndex and numRetrieved parameters are absent, then all the SSL profile names are returned. filter SslProfileSummaryFilter Optional Summary filter criteria. Return values Table 89 contains the return values of the method.
Methods 6 Error messages List of Error Messages getAllTcpProfiles Description Retrieves the information on existing TCP profiles. Parameters Table 92 contains the parameters required for the method. TABLE 92 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional Sets the start index to retrieve the TCP profiles. When both the startIndex and numRetrieved parameters are absent, then all the TCP profile are returned.
6 Methods Return values Table 94 contains the return values of the method. TABLE 94 Return values Name Type Description genericInfo ResponseInformation The SSL statistics. token unsignedInt The token to be used for further queries to get the statistics. Error messages List of Error Messages getSslAlertStatisticsStatus Description Retrieves the SSL alert statistics from BP for a specific token. Parameters Table 95 contains the parameters required for the method.
Methods 6 Return values Table 97 contains the return value of the method. TABLE 97 Return value Name Type Description genericInfo ResponseInformation The SSL statistics. token unsignedInt The token to be used for further queries to get the statistics. Error messages List of Error Messages getSslAuthenticationStatisticsStatus Description Retrieves the SSL authentication statistics from the BP for a particular token. Parameters Table 98 contains the parameters required for the method.
6 Methods Parameters Table 100 contains the parameters required for the method. TABLE 100 Parameters Name Type Presence Rules Description startIndex unsignedInt Optional The starting index. numRetrieved unsignedInt Optional The number that is retrieved. Return values Table 101 contains the return value of the method. TABLE 101 Return value Name Type Description genericInfo ResponseInformation The SSL statistics.
Methods 6 getSslCertificateFile Description Retrieves the SSL certificate file. Parameters Table 104 contains the parameters required for the method. TABLE 104 Parameters Name Type Presence Rules Description filename string Mandatory Certificate file must already exist. Name of the certificate from which complete details are to be retrieved. Return values Table 105 contains the return value of the method.
6 Methods getSslCertificateFilenamesOnVirtualServer Description Retrieves the certificate file names on an SSL virtual server. If a VIP port is not specified as an input, all the SSL ports on the VIP are considered for retrieval. Parameters Table 108 contains the parameters required for the method. TABLE 108 Parameters Name Type Presence Rules Description vipPort ServerPort Mandatory Identifies the virtual server from which the SSL certificates are being obtained.
Methods 6 getSslClientStatisticsStatus Description Retrieves the SSL Client statistics from a BP for a specific token. Parameters Table 111 contains the parameters required for the method. TABLE 111 Parameters Name Type Presence Rules token unsignedInt Mandatory Description The token to be used for further queries to get the statistics. Return values Table 112 contains the return value of the method.
6 Methods Return values Table 114 contains the return value of the method. TABLE 114 Return value Name Type Description statusList sslCrlStatus[] List of CRL Status information. Error messages List of Error Messages getSslKeyPairFile Description Retrieves the SSL key pair file. Parameters Table 115 contains the parameters required for the method. TABLE 115 Parameters Name Type Presence Rules Description filename string Mandatory Key pair file must already exist.
Methods 6 Return values Table 118 contains the return value of the method. TABLE 118 Return value Name Type Description keyPairFileDump string Contents of the requested key pair file in a readable format. Error messages List of Error Messages getSslMemoryStatistics Description Retrieves SSL memory statistics. Parameters None Return values Table 119 contains the return values of the method. TABLE 119 Return values Name Type Description genericInfo ResponseInformation The SSL statistics.
6 Methods Return values Table 121 contains the return value of the method. TABLE 121 Return value Name Type Description genericInfo ResponseInformation The SSL statistics. statusCode asyncCallStatusEnum The asynchronous call status. Statistics sslMemoryStatistics The SSL statistics details. Error messages List of Error Messages getSslProfileBindingsOnVipPorts Description Retrieves the information of SSL profiles that are bound to virtual server ports.
Methods 6 Parameters Table 122 contains the parameters required for the method. TABLE 124 Parameters Name Type Presence Rules Description virtualServer Server Mandatory Identifies the virtual server from which SSL profile binding information is to be retrieved. startIndex unsignedInt Optional Sets the starting index, for labeling binding information of SSL profiles on the virtual server, in an ordered list.
6 Methods getSslStatistics Description Retrieves the SSL statistics. Parameters None Return values Table 128 contains the return values of the method. TABLE 128 Return values Name Type Description genericInfo ResponseInformation The SSL statistics. token unsignedInt The token to be used for further queries to get the statistics. Error messages List of Error Messages getSslStatisticsStatus Description Retrieves the SSL statistics from the BP for a particular token.
Methods 6 Return values Table 131 contains the return value of the method. TABLE 131 Return value Name Type Description summary SslSummary SSL summary information. Error messages List of Error Messages getSslSystemMaxParameters Description Retrieves the system-wide maximum SSL parameters. Return values Table 132 contains the return value of the method. TABLE 132 Return value Name Type Description sslParameters sslSystemMaxParameters Maximum values for system wide SSL parameters.
6 Methods Error messages List of Error Messages setSslExportMasterPassword Description Sets a master password which grants permission to export all SSL keys on a Brocade Virtual ADX switch using SCP copy. Parameters Table 135 contains the parameters required for the method. TABLE 135 Parameters Name Type Presence Rules Description password string Mandatory Maximum of 24 characters. Master password. Error messages List of Error Messages.
Methods 6 Parameters Table 137 contains the parameters required for the method. TABLE 137 Parameters Name Type Presence sslParameters sslSystemMaxParameters Mandatory Rules Description Maximum values for System wide SSL parameters. Error messages List of Error Messages unbindSslProfileFromVipPorts Description Unbinds the SSL profile from virtual server ports. Parameters Table 138 contains the parameters required for the method.
6 Methods updateSslProfiles Description Updates existing SSL profiles. Parameters Table 140 contains the parameters required for the method. TABLE 140 Parameters Name Type Presence Rules Description profileList SslProfile[] Mandatory The name parameters must be present. Information required to update an existing SSL profile. Error messages List of Error Messages updateTcpProfiles Description Updates the information of existing TCP profiles.
Methods 6 uploadSslKeyPairFile Description Uploads the SSL key pair file onto Brocade Virtual ADX. Parameters Table 143 contains the parameters required for the method. TABLE 143 Parameters Name Type Presence keyPairFile SslKeyPairFile Mandatory Rules Description The KeyPair file contents (Hex Binary format) to be uploaded onto Brocade Virtual ADX. Error messages List of Error Messages uploadSslPkcs12File Description Uploads the SSL PKCS12 file into Brocade Virtual ADX.
6 Methods Parameters Table 145 contains the parameters required for the method. TABLE 145 Parameters Name Type Presence Rules Description version ipVersionEnum Mandatory Identifies the IP (IPv4 or IPv6) address of the device. firewall Firewall [ ] Mandatory Identifies the firewall data structure. Return values Not applicable. Error messages List of Error Messages Syn-Proxy Syn-Proxy allows TCP connections to be terminated on the ServerIron ADX device.
Methods 6 Parameters Table 147 contains the parameters required for the method. TABLE 147 Parameters Name Type Presence config SynProxyGlobalConfig Mandatory Rules Description Global configuration for Syn-Proxy. Return values Not applicable. Error messages List of Error Messages getSynProxyGlobalConfig Description Retrieves the global Syn-Proxy configuration. Return Values Table 148 contains the return values required for the method.
6 Data structures Error messages List of Error Messages Data structures AccessList This structure is a high-level description of the Access list. TABLE 150 Attributes Name Type Presence number unsignedInt aclAction accessListActionEnum ipProtocol l4PortTypeEnum sourceIP PortConfigData destinationIP PortConfigData precedence string tos string log twoWayToggleEnum Rules Description Acl This structure is a high-level description of the Access Control list.
Data structures 6 AclOnNatPool This structure is a high-level description of of ACLs associated with a NAT pool. TABLE 152 Attributes Name Type Presence poolName string Mandatory aclIDList AclID[ ] Mandatory Rules Description NAT pool name. Only “aclID->number” is considered. The range of valid value is from 1 to 199. Access list ID numbers for global addresses. bpID This structure contains the high-level description of a BP identifier.
6 Data structures TABLE 155 Attributes (Continued) Name Type partnerPorts InterfaceID allowDynamicPortChange boolean forceRoute boolean enableStrictSecurity boolean allowMulticast boolean sessionSyncDelay unsignedInt sessionSync boolean enablestrictFowarding boolean transparentVlan boolean Presence Rules Description FirewallGroup This structure contains the high-level description of firewall group.
Data structures TABLE 157 6 Attributes (Continued) Name Type acl string preferRouterCount unsignedInt preferCount unsignedInt policyAcl PolicyHashAcl Presence Rules Description FirewallName This structure contains the high-level description of firewall name. TABLE 158 Attributes Name Type Name string Presence Rules Description FirewallPathIndex This structure contains the high-level description of firewall path index.
6 Data structures FirewallZone This structure contains the high-level description of firewall zone. TABLE 161 Attributes Name Type name string zoneNumber unsignedInt aclNumber unsignedInt Presence Rules Description FwGroupSummary This structure contains the high-level description of firewall group summary.
Data structures 6 FwTrafficStatistics This structure contains the high-level description of firewall traffic statistics. TABLE 165 Attributes Name Type state string currentConnections string totalConnections unsignedInt packetsFromHostToServer unsignedInt octetsFromHostToServer unsignedLong packetsFromServerToHost unsignedInt octetsFromServerToHost unsignedLong Presence Rules Description FwPathSummary This structure contains the high-level description of firewall path summary.
6 Data structures HashInfo This structure contains the high-level description of hash information. TABLE 167 Attributes Name Type Presence sourceMask string destinationMask string Rules Description InterfaceID This structure is a high-level description of IP Interface. TABLE 168 Attributes Name Type Presence Rules Description portString string Optional When this parameter is present as part of the request message, the parameters portString, slot and port must be absent.
Data structures 6 NatConfig This structure is the high-level description of NAT configuration. TABLE 170 Attributes Name Type Presence Rules Description enableForwardingOnSessionNotFound boolean Optional Enables or disables the forwarding of packets without NAT translation when sessions are not found. enableStatelessStaticNat boolean Optional Enables or disables stateless static NAT. timeoutInfo NatTranslationTimeout Mandatory Configures NAT Translation timeout information.
6 Data structures NatPoolFilter This structure is the high-level description of a filter that contains a simple filter and can add complex operations for the filters. TABLE 172 Attributes Name Type Presence Rules SimpleFilter NatPoolSimpleFilter Mandatory Description Simple filter name. NatPoolSimpleFilter This structure is the high-level description of a filter for NAT pools.
Data structures 6 NatTranslationTimeout This structure is the high-level description of NAT translation timeouts. TABLE 175 Attributes Name Type Presence Rules Description dnsTimeout unsignedInt Optional Default value is 120 seconds. Specifies the timeout for NAT DNS flows. setToMaxDnsTimeout boolean Optional Both "dnsTimeout" and "setToMaxDnsTimeo ut" cannot be present. Sets the maximum timeout for NAT DNS flows.
6 Data structures PathCount This structure is the high-level description of path count. TABLE 176 Attributes Name Type Presence Rules Description state unsignedInt Optional The state of the path count priority unsignedInt Optional The priority of the path count firewallPathCount unsignedInt Optional The firewall path count routerPathCount unsignedInt Optional The router path count PathData This structure is a high-level description of other path data.
Data structures 6 PolicyHashAcl This structure is a high-level description of other policy hash ACL TABLE 178 Attributes Name Type Presence Rules Description aclID string Optional Specifies a standard or extended ACL. It should be named ACL or ACL ID. sourceMask string Optional Source mask. destinationMask string Optional Destination mask. PortConfigData This structure is the high-level description of port configuration data.
6 Data structures Server This structure is a high-level description of any real or virtual server. TABLE 181 Attributes Name Type Presence Rules Description Name string Mandatory Maximum of 32 characters The name of the target server. IP string Optional Maximum of 48 characters. The IP address (IPv4 or IPV6)of the target server. Description string Optional The description of the real or virtual server.
Data structures TABLE 183 6 Attributes (Continued) Name Type Presence Rules Description decodeError unsignedInt Optional Decode error. decryptError unsignedInt Optional Decrypt error. exportRestriction unsignedInt Optional Export restriction. protocolVersion unsignedInt Optional Protocol version. insufficientSecurity unsignedInt Optional insufficient security. internalError unsignedInt Optional Internal error. userCancelled unsignedInt Optional User cancelled.
6 Data structures sslCacheProfileStatistics This structure is a high-level description of SSL cache profile statistics. TABLE 187 Attributes Name Type Presence Rules Description itemsInSessionCache unsignedInt Optional The items in session cache. clientConnects unsignedInt Optional The client connects. clientRenegotiates unsignedInt Optional The client renegotiates. finishedClientConnects unsignedInt Optional The finished client connects.
Data structures TABLE 188 6 Attributes (Continued) Name Type Presence Rules Description existingServerCeriticateFilename string Optional Valid Server Certificate file. Considered only when "enableCACert ificateChainin g" value is "TRUE". Valid only as part of the “uploadSslCertificateFi le” request. The name of the existing Server Certificate file in which the contents of Certificate (to be uploaded) is appended. fileContent string Mandatory A maximum of 16000 characters.
6 Data structures TABLE 190 Attributes (Continued) Name Type Presence Rules Description subjectName string Optional Null Details of the organization that owns the certificate and possesses the private key. validFrom string Optional The time period from which the certificate is valid. validTo string Optional The time period from which the certificate is invalid. serialNum string Optional The serial number related to the certificate.
Data structures TABLE 192 6 Attributes (Continued) Name Type Presence Rules Description startValue string Optional This parameter is mandatory and considered only when the “operator” value is “RANGE”. The start value in a range. endValue string Optional This parameter is mandatory and considered only when the “operator” value is “RANGE”. The end value in a range. sslCertificateVerificationStatistics This structure is a high-level description of SSL certificate verification statistics.
6 Data structures sslCertName This structure is a high-level description of an SSL certificate name. TABLE 194 Attributes Name Type Presence Rules Description name string Mandatory The SSL certificate name. boundPortOnVip unsignedInt Optional The virtual server port to which the certificate is bound. This is used only as an output parameter. SslClientCertificateVerification This structure is a high-level description of the Client Certificate verification information.
Data structures TABLE 196 6 Attributes (Continued) Name Type Presence resetCount unsignedInt Optional The reset count. level1AlertsReceived unsignedInt Optional The level1 alerts received. level1AlertsSent unsignedInt Optional The level1 alerts sent. receivedBytesFromTcp unsignedInt Optional The received bytes from TCP. receivedApplicationDataFromTcp unsignedInt Optional The received application data from TCP.
6 Data structures TABLE 196 Attributes (Continued) Name Type Presence Rules Description rc4Calls unsignedInt Optional The RC4 calls. sslMacSha1Calls unsignedInt Optional The SSL MAC SHA 1 calls. tlsMacSha1Calls unsignedInt Optional The TLS MAC SHA1 calls. sslCrlRecord This structure is the high-level description of a CRL record. TABLE 197 Attributes Name Type Presence Rules Description name string Mandatory Maximum of 64 characters. Specifies a name for the CRL entry.
Data structures TABLE 199 6 Attributes (Continued) Name Type Presence Rules Description nextDownloadHours unsignedInt Optional Next download duration in hours. nextDownloadMinutes unsignedInt Optional Next download duration in minutes. sslCrlStatusFilter This structure is a high-level description of the summary of SSL CRL status. TABLE 200 Attributes Name Type Presence Rules field sslCrlStatusFilterFieldEnum Mandatory Description Filter field name.
6 Data structures TABLE 202 Attributes (Continued) Name Type Presence Rules Description locality string Optional The default value is "San Jose" The name of the locality. organizationName string Optional The default value is "Brocade Systems" The name of the organization. organizationUnit string Optional The default value "Web administration" The name of the unit within the organization. commonName string Optional The default value is "www.brocade.com" The domain name.
Data structures 6 SslKeyPairFile This structure is a high-level description of Key Pair file for upload or download. TABLE 205 Attributes Name Type Presence Rule Description filename string Mandatory Maximum of 24 characters. Valid characters [a-z] or [A-Z] or [0-9] or special characters ’-’, ’ _’, ’$’, ", ’%’, ’&’, and ’!’. Spaces are invalid. Filename of Key Pair file. fileFormat sslKeyFormatEnum Optional Only “PEM” format is supported. File format of Key Pair file.
6 Data structures SslKeyPairFileSummarySimpleFilter This structure is a high-level description of simple filter information for summary of SSL Key Pair files. TABLE 208 Attributes Name Type Presence Rule Description field sslKeyPairFileSummaryFilterFieldEnum Mandatory Filter field name. operator filterOperatorEnum Mandatory Filter operator type. value string Optional Ignored when “operator” value is “RANGE”. Value of the field for filtering.
Data structures 6 SslPkcs12File This structure is the high-level description of the SSL PKCS file for upload. TABLE 210 Attributes Name Type Presence Rules Description filename string Mandatory The file name of the PKCS12 file. Maximum of 24 characters. Valid characters [a-z] or [A-Z] or [0-9] or special characters ’-’, ’ _’, ’$’, ", ’%’, ’&’, and ’!’. Spaces are invalid. passphrase string Mandatory Maximum of 64 characters. Passphrase for the PKCS12 file.
6 Data structures TABLE 211 636 Attributes (Continued) Name Type Presence Rules Description allowCACertificateChaining boolean Optional Default value is False. Allows or disallows the Brocade Virtual ADX to send the entire certificate chain (including the root CA certificate and any intermediate CA certificates) maxCertChainVerificationDepth unsignedInt Optional The valid range is from 4 to 10. The default value is 4. The maximum certificate chain verification depth.
Data structures 6 sslProfileBinding This structure is a high-level description of an SSL profile binding. TABLE 212 Attributes Name Type Presence Rules Description sslMode sslModeEnum Optional Mandatory while enabling an SSL service on a VIP port. The SSL mode (Termination or Proxy). clientProfile string Mandatory serverProfile string Optional This parameter is mandatory and considered only when the value of sslMode is PROXY. Name of server SSL profile for SSL client communication.
6 Data structures TABLE 214 Attributes Name Type Presence clientSslProfile string Mandatory serverTcpProfile string Optional clientTcpProfile string Optional Rules Description Name of Client SSL profile for real server communication. This parameter is present only when value of sslMode is TERMINATE. Name of TCP profile for real server communication. Name of TCP profile for real server communication.
Data structures 6 SslProfileFilter This structure is the high-level description of information of the filter for an SSL profile. TABLE 217 Attributes Name Type Presence simpleFilter SslProfileSimpleFilter Mandatory Rules Description Simple filter SslProfileSimpleFilter This structure is the high-level description of information of a simple filter for SSL profile. TABLE 218 Attributes Name Type Presence Rules Description field sslProfileFilterFieldEnum Mandatory Filter field name.
6 Data structures SslProfileSummaryFilter This structure is the high-level description of information of a filter for the summary of an SSL profile. TABLE 220 Attributes Name Type Presence simpleFilter SslProfileSummarySimpleFilter Optional Rules Description Simple filter information. SslProfileSummarySimpleFilter This structure is the high-level description of information of a simple filter for the summary of an SSL profile.
Data structures TABLE 222 6 Attributes (Continued) Name Type Presence Rules Description closedConnection unsignedInt Optional The closed connection. rstReceived unsignedInt Optional The received RST. socketErrorOrTimeout unsignedInt Optional The socket error or timeout. HandshakeDone unsignedInt Optional The handshake complete. dataReceived unsignedInt Optional The data received. receivesUnblocked unsignedInt Optional The receives unblocked.
6 Data structures sslProxyStatistics This structure is the high-level description of SSL proxy statistics. TABLE 224 Attributes Name Type Presence Rules Description clientFacing sslClientStatistics Optional Client facing statistics. serverFacing sslProxyServerSideStatistics Optional Server facing statistics. sslSessionCacheStatistics This structure is a high-level description of SSL session cache statistics.
Data structures 6 sslStatistics This structure is high-level description of SSL statistics. TABLE 227 Attributes Name Type Presence connectionAttempts unsignedInt Optional The number of connection attempts. closeCount unsignedInt Optional The number of connections closed. resetCount unsignedInt Optional The number of connections reset. transactionShutdown unsignedInt Optional The number of connections that had transaction shut down.
6 Data structures TABLE 227 644 Attributes (Continued) Name Type Presence Rules Description remoteCloseCount unsignedInt Optional The number of sessions that were closed by the remote client. remoteResetCount unsignedInt Optional The number of sessions that were reset by the remote client. getClientHelloFail unsignedInt Optional The number of times the hello messages to a client failed. clientSideConnection unsignedInt Optional The client side connection.
Data structures 6 SslSummary This structure is a high-level description of an SSL summary. TABLE 228 Attributes Name Type Presence Rule Description keyCount unsignedInt Optional Number of Installed keys. certificateCount unsignedInt Optional Number of installed certificates. profileCount unsignedInt Optional Number of configured SSL Profiles. sslSystemMaxParameters This structure contains the high-level description of SSL system max parameters.
6 Data structures SslTcpProfile This structure is the high-level description of TCP profile information. TABLE 230 Attributes Name Type Presence assignTcpProfile boolean Mandatory tcpProfileName string Optional Rules Description Sets or clears the TCP profile to SSL profile. Mandatory when the value of “assignTcpProfile” is set to “TRUE”. TCP profile should already exist. Name should be a maximum of 64 characters. TCP profile name.
Data structures 6 StaticNatMapSimpleFilter This structure is a high-level description of a simple filter for Static NAT mapping. TABLE 233 Attributes Name Type Presence Rule Description field staticNatMapFilterFieldEnum Mandatory Filter field name. operator filterOperatorEnum Mandatory Filter operator type. value string Optional Ignored when “operator” value is “RANGE”. Value of the field for filtering.
6 Data structures TABLE 234 Attributes (Continued) Name Type Presence Rules Description windowScaleSize unsignedInt Optional The valid range is from 1 to 7. TCP window scale factor. inUse boolean Optional Valid as part of the response only. Indicates if the TCP profile is in use. tcpProfileFilter This structure is a high level description of the filter for TCP profiles.
Data structures 6 AclID This structure is a high-level description of ACL identifier. TABLE 237 Attributes Name Type Presence Rules Description number unsignedInt Optional Either number or name must be present. Both cannot be present. Value from 1 to 99 for a standard ACL. Value from 100 to 199 for an extended ACL. Specifies the ACL ID number. ipVersion ipVersionEnum Optional This parameter value is ignored when the number parameter is present with a value.
6 Data structures TABLE 239 Attributes (Continued) Name Type Presence Rules Description value string Optional Ignored when the operator value is RANGE. Value of the field for filtering. startValue string Optional This parameter is mandatory and considered only when the operator value is RANGE. The start value in a range. endValue string Optional This parameter is mandatory and considered only when the operator value is RANGE. The end value in a range.
Data structures 6 AclStandardEntry This structure is a high-level description of the ACL standard entry. TABLE 241 Attributes Name Type Presence Rules Description action aclActionEnum Mandatory anyHost boolean Optional Either the anyHost or host parameter must be present. Both cannot be present. Match on all host addresses. host AclHost Optional Either the anyHost or host parameter must be present. Both cannot be present. The ACL source host details.
6 Data structures AclExtendedEntryPortFilter This structure is a high-level description of port filter in the ACL extended entry. TABLE 243 Attributes Name Type Presence Rules Description operator aclIDFilterFieldEnum Optional When the parameter value is ALL_ESTABLISHED then the values in the port, startPort and endPort parameters are ignored. Filter operator for source or destination port.
Data structures 6 AclIpv6 This structure is a high-level description of IPV6 protocol information for ACL. TABLE 245 Attributes Name Type Presence Rules Description matchIpv6FragmentsWithNonZeroOffset boolean Optional This parameter is valid only when value of the protocol parameter is IPV6. Enables or disables the matching IPv6 fragments with a non zero fragment offset.
6 Data structures TABLE 246 654 Attributes (Continued) Name Type Presence Rules Description destinationHost AclHost Optional Either the anyDestinationHost or destinationHost parameters must be present. Both cannot be present. The ACL destination host details. destinationPortFilter AclExtendedEntryPortFilter Optional This is valid only when the protocol value is TCP or UDP, otherwise it is ignored. The filter for the destination port.
Data structures 6 AclEntry This structure is a high-level description of the ACL entry. TABLE 247 Attributes Name Type Presence Rules Description standard AclStandardEntry Optional Either the standard or extended parameters must be present. Both cannot be present. A standard ACL entry. extended AclExtendedEntry Optional Either the standard or extended parameters must be present. Both cannot be present. An extended ACL entry.
6 Data structures TABLE 248 Attributes (Continued) Name Type Presence Rules Description destinationHost AclHost Optional Either the anyDestinationHost or destinationHost parameter must be present. Both cannot be present. The ACL destination host details. inUse boolean Optional This parameter is valid only as part of the response message and ignored when present in the request message. Specifies whether the ACL is in use.
Data structures 6 AclTraffic This structure is a high-level description of Access Control list traffic information. TABLE 251 Attributes Name Type Presence Rules Description protocol IpProtocol Optional The IP protocol (well known name or protocol number). inboundPacketsReceivedCount unsignedInt Optional The inbound packets received. outboundPacketsReceivedCount unsignedInt Optional The outbound packets received.
6 Data structures AclInterfaceConfig This structure is a high-level description of ACL IP Interface level configuration. TABLE 254 Attributes Name Type Presence Rules Description id InterfaceID Mandatory The IP interface. enableDropFragmentOnMatch boolean Optional Enables or disables the automatic drop of a fragment whose source and destination IP addresses exactly match an ACL entry that contains layer 4 information, even if the ACL entry’s action is permitted.
Data structures TABLE 255 6 Attributes (Continued) Name Type Presence Rules Description systemResetInterval unsignedInt Optional This parameter is mandatory when the systemThreshold parameter is present. The valid value range is from 1 to 30 minutes. Specifies the number of minutes that the device enforces the drop or forward action after a system level threshold has been exceeded. interfaceThreshold unsignedInt Optional The valid value range is from 300 to 8000. The default value is 4000.
6 Data structures TABLE 256 Attributes (Continued) Name Type Presence Rules Description enableHardwareFiltering boolean Optional The default value is FALSE. Enables or disables the hardware filtering of denied packets. enableStrictTcpMode boolean Optional The default value is FALSE. Enables or disables the strict TCP mode. enableStrictUdpMode boolean Optional The default value is FALSE. Enables or disables the strict UDP mode.
Data structures 6 aclOnInterfaceFilter This structure is a high-level description of the filter for ACL binding on the IP interface. TABLE 259 Attributes Name Type Presence Rules simpleFilter aclOnInterfaceSimpleFilter Mandatory Description The filter field name. aclOnInterfaceSimpleFilter This structure is a high-level description of the simple filter for ACL binding on the IP interface.
6 Data structures GlobalTcpMss This structure is a high-level description of global TCP MSS IPV4/IPV6 configuration. TABLE 262 Attributes Name Type Presence Rules Description mssv4 unsignedInt Optional • This parameter is used to define the Global TCP MSS IPv4 value for all SYN-ACK packets generated by a ServerIron ADX switch. • mssV6 GlobalTcpMssV6 Valid value range is from 64 to 9216. Make sure that the IP MTU of the interfaces is always greater than the MSS value.
Data structures 6 SynProxyGlobalConfig This structure is a high-level description of Syn-Proxy global configuration. TABLE 264 Attributes Name Type Presence Rules Description enableSynProxy twoWayToggleEnum Optional When auto control is already configured, then "enableSynProxy" cannot be set to DISABLED. This parameter is to enable or disable Syn-Proxy.
6 Enumerations TABLE 264 Attributes (Continued) Name Type Presence Rules Description ackWindowSize unsignedInt Optional Valid value range is from 1 to 65536. The default value is 8192. This parameter specifies the TCP window size that the ServerIron ADX uses on a SYN-ACK packet sent back to a client with SYN-Cookie.
Enumerations 6 accessListActionEnum These are the enumerations for an access list action enumerated list. TABLE 266 Attributes Parameters Description DENY Deny PERMIT Permit firewallGroupIDEnum These are the enumerations for a firewall group ID enumerated list. TABLE 267 Attributes Parameters Description IPV4_FW_GROUP_ID Internally the firewall group id for IPV4 is mapped to 2. IPV6_FW_GROUP_ID Internally the firewall group id for IPV4 is mapped to 4.
6 Enumerations aclActionEnum These are the enumerations for actions in ACL. TABLE 270 Attributes Parameters Description PERMIT ACL that permits. DENY ACL that denies. aclFragmentRateExceedActionEnum These are the enumerations for actions on exceeding the ACL fragment rate. TABLE 271 Attributes Parameters Description DROP Fragments are dropped without filtering by the ACLs. FORWARD Fragments are forwarded in the hardware without filtering by the ACLs.
Enumerations 6 aclIPPortFilterOperatorEnum These are the enumerations for an ACL IP Port filter operator. TABLE 273 Attributes Parameters Description EQUAL Equal NOT_EQUAL Not equal GREATER_THAN Greater than LESS_THAN Less than RANGE Range ALL_ESTABLISHED All established aclOnInterfaceFilterFieldEnum These are the enumerations for filter field names in the ACL on interface. TABLE 274 Attributes Parameters Description IP_INTERFACE_ID Identifier for “aclOnInterface->id” parameter.
6 Enumerations asyncCallStatusEnum These are the enumerations for asynchronous call status. TABLE 277 Attributes Parameters Description COMPLETED_FULL Asynchronous call for BP statistics collection completed COMPLETED_PARTIAL Asynchronous call for BP statistics collection partially completed TIMEDOUT Asynchronous call for BP statistics that are timedout UNKNOWN Status is unknown dsrStateEnum These are the enumerations for the dsr state.
Enumerations 6 interfaceTypeEnum These are the enumerations for types of IP Interfaces. TABLE 281 Attributes Parameters Description ETHERNET Ethernet interface GROUP_VIRTUAL Group virtual VIRTUAL Valid only on router mode. LOOPBACK Valid only on router mode. MANAGEMENT Management interface ipProtocolEnum These are the enumerations for supported IP protocol names for ACL..
6 Enumerations TABLE 282 670 Attributes Parameters Description ENCAP An IP encapsulation ESP Encapsulating security payload ETHERIP Ethernet-within-IP encapsulation FC Fibre channel FIRE FIRE GGP Gateway-gateway protocol GMTP GMTP GRE Generic routing encapsulation HMP Host monitoring protocol I_NLSP Integrated net layer security TUBA IATP Interactive agent transfer protocol ICMP Internet control message protocol IDPR Inter-domain policy routing protocol IDPR_CMTP IDPR contr
Enumerations TABLE 282 6 Attributes Parameters Description ISO_IP ISO internet protocol ISO_TP4 ISO transport protocol class 4 KRYPTOLAN Kryptolan L2TP Layer Two Tunneling Protocol LARP Locus Address Resolution Protocol LEAF_1 Leaf-1 LEAF_2 Leaf-2 MERIT_INP MERIT internodal protocol MFE_NSP MFE network services protocol MHRP Mobile host routing protocol MICP Mobile internetworking control protocol MOBILE IP mobility MTP Multicast Transport Protocol MUX Multiplexing protocol
6 Enumerations TABLE 282 672 Attributes Parameters Description SDRP Source demand routing protocol SECURE_VMTP SECURE_VMTP SEP Sequential exchange protocol SKIP SKIP SM SM SMP Simple message protocol SNP Sitara Networks protocol SPRITE_RPC Sprite RPC protocol SPS Secure packet shield SRP SpectraLink radio protocol SSCOPMCE SSCOPMCE ST Schedule transfer ST2 ST2 datagram mode (RFC 1819) SUN_ND SUN ND protocol - temporary SWIPE IP with encryption TCF TCF TCP Transmission
Enumerations 6 ipTrafficDirectionEnum These are the enumerations for IP Traffic direction. TABLE 283 Attributes Parameters Description INCOMING Incoming packets. OUTGOING Outgoing packets. aclSummaryFilterFieldEnum These are the enumerations for filter field names in an ACL summary. TABLE 284 Attributes Parameters Description TYPE Identifier for “aclSummary->type” parameter. ACL_ID_OR_NAME Identifier for “aclSummary->aclId_or_name” parameter.
6 Enumerations ipVersionEnum These are the enumerations for IP versions. TABLE 286 Attributes Parameters Description IPV4 IPv4 version IPV6 IPv6 version l4PortTypeEnum These are the enumerations for a Layer 4 port type enumerated list. TABLE 287 Parameters Description TCP Indicates the port uses TCP. UDP Indicates the port uses UDP. licenseTypeEnum These are the enumerations for a license type enumerated list.
Enumerations TABLE 290 6 Attributes Parameters Description START_IP Identifier for “natPool->startIP” parameter. END_IP Identifier for “natPool->endIP” parameter. SUBNET_MASK Identifier for “natPool->subnetMask” parameter. SUBNET_MASK_LENGTH Identifier for “natPool->subnetMaskLength” parameter. PRIORITY Identifier for “natPool->priority” parameter. natPoolTypeEnum These are the enumerations for types of NAT pools.
6 Enumerations sslCertificateSummaryFilterFieldEnum These are the enumerations for field names in the SSL certificate summary. TABLE 295 Attributes Parameters Description NAME Identifier for “ ->name” parameter. VERSION Identifier for “sslCertificateSummary->version” parameter. ISSUER Identifier for “sslCertificateSummary->issuer” parameter. SUBJECT_NAME Identifier for “sslCertificateSummary->subjectName” parameter. VALID_FROM Identifier for “sslCertificateSummary->validFrom” parameter.
Enumerations 6 sslClientCertVerificationBasisEnum These are the enumerations for an SSL client certificate verification basis. TABLE 297 Attributes Parameters Description PER_CONNECTION Requests a client certificate for every new SSL connection. PER_SSL_HANDSHAKE Requests a client certificate for every new SSL handshake. sslClientCertVerificationModeEnum These are the enumerations for client certification verification modes.
6 Enumerations sslCrlStatusFilterFieldEnum These are the enumerations for CRL states. TABLE 301 Attributes Parameters Description NAME Identifier for “sslCrlStatus-> crlRecordInfo->name” parameter. URL Identifier for “sslCrlStatus-> crlRecordInfo->url” parameter. FILE_FORMAT Identifier for “sslCrlStatus-> crlRecordInfo->fileFormat” parameter. REFRESH_INTERVAL Identifier for “sslCrlStatus-> crlRecordInfo->refreshInterval” parameter. STATE Identifier for “sslCrlStatus->state” parameter.
Enumerations 6 sslKeyPairFileSummaryFilterFieldEnum These are the enumerations for the SSL key pair file summary. TABLE 305 Attributes Parameters Description FILENAME Identifier for “sslkeyPairFileSummary->filename” parameter. FILE_FORMAT Identifier for “sslkeyPairFileSummary->fileFormat” parameter. KEY_LENGTH Identifier for “sslkeyPairFileSummary->keyLength” parameter. sslModeEnum These are the enumerations for SSL modes.
6 Enumerations TABLE 308 Attributes Parameters Description ALLOW_SELF_SIGNED_CERTIFICATE Identifier for “sslProfile->allowSelfSignedCertificate” parameter. ENABLE_CA_CERTIFICATE_CHAINING Identifier for “sslProfile->enableCACertificateChaining” parameter. MAX_CERT_CHAIN_VERIFICATION_DEPTH Identifier for “sslProfile->maxCertChainVerificationDepth” parameter. CA_CERTIFICATE_FILENAME Identifier for “sslProfile->caCertificateFilenames” parameter.
Enumerations 6 staticNatMapFilterFieldEnum These are the enumerations for fields in Static NAT mappings. TABLE 311 Attributes Parameters Description PRIVATE_IP Identifier for “staticNatMap->privateIP” parameter. GLOBAL_IP Identifier for “staticNatMap->globalIP” parameter. PRIORITY Identifier for “staticNatMap->priority” parameter. ACL_ID Identifier for “staticNatMap->aclID” parameter. targetIpStateEnum These are the enumerations for a TCS predictor enumerated list.
6 Enumerations twoWayToggleEnum These are the enumerations for a two way toggle enumerated list. TABLE 314 Parameters Description ENABLED Enabled. DISABLED Disabled. aclIDFilterFieldEnum These are the enumerations for filter field names in the ACL ID. TABLE 315 Attributes Parameters Description NUMBER Identifier for “aclID->number” parameter. IP_VERSION Identifier for “aclID->ipVersion” parameter. TYPE Identifier for “aclID->type” parameter. NAME Identifier for “aclID->name” parameter.
Chapter 7 Global Server Load Balancing API Reference In this chapter • Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . • Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . • Data Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . • Enumerations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
7 Methods Return Values Not applicable. Error messages List of Error Messages. createGslbSiteAdx Description Create a GSLB site ADX. Parameters TABLE 2 createGslbSiteAdx parameters Parameters Type Presence Rules Description siteName string Mandatory Name of GSLB site whose ADX entry is to be created. adx gslbAdx Mandatory GSLB site configuration for update. Return Values Not applicable. Error messages List of Error Messages.
Methods 7 deleteGslbSiteAdx Description Delete ADX entry for a GSLB site. Parameters TABLE 4 deleteGslbSiteAdx parameters Parameters Type Presence Rules Description siteName string Mandatory Name of GSLB site whose ADX entry is to be deleted. adx gslbAdx Optional ADX Server. Return Values Not applicable. Error messages List of Error Messages. getAllGslbSiteAdx Description Get details of all GSLB site ADX.
7 Methods Error messages List of Error Messages. getAllGslbSites Description Get details of all GSLB sites. Parameters TABLE 7 getAllGslbSites parameters Parameters Type Presence Rules Description startIndex unsignedInt Optional Sets the starting index for retrieving GSLB site details. numRetrieved unsignedInt Optional Specifies the number of GSLB sites are to be retrieved. filter gslbSiteFilter Optional Filtering criteria.
Methods 7 Return Values TABLE 10 getGslbSite return values Name Type Description site gslbSite GSLB site configuration for update. Error messages List of Error Messages. getGslbSiteAdx Description Get details of GSLB site ADX. Parameters TABLE 11 getGslbSiteAdx parameters Parameters Type Presence Rules Description siteName string Mandatory Name of GSLB site whose ADX entry is to be retrieved. adxNameOrIP Server Mandatory Name of GSLB site whose details are to be retrieved.
7 Methods Return Values Not applicable. Error messages List of Error Messages. updateGslbSiteAdx Description Update a GSLB site ADX. Parameters TABLE 14 UpdateGslbSiteAdx parameters Parameters Type Presence Rules Description siteName string Mandatory Name of GSLB site whose ADX entry is to be updated. adx gslbAdx Mandatory GSLB Site configuration for update. Return Values Not applicable. Error messages List of Error Messages.
Methods 7 Error messages List of Error Messages. createGslbZoneHost Description Create new GSLB host in an already existing GSLB zone. Parameters TABLE 16 createGslbZoneHost parameters Parameters Type Presence Rules Description zoneName string Mandatory Name of the GSLB zone in which hosts are to be created. host gslbHost Mandatory GSLB host data structure. Return Values Not applicable. Error messages List of Error Messages. deleteGslbZone Description Delete a configured GSLB zone.
7 Methods Parameters TABLE 18 deleteGslbZoneHost parameters Parameters Type Presence zoneName string Mandatory host gslbHost Mandatory Rules Description Name of the GSLB zone in which hosts are to be deleted. To delete a full configured host the “hostNameSuffix” and “portConfigList” parameters are mandatory: Either “portConfigList ->hostApplication” or “portConfigList ->portNumber” must be present. The rest of the parameter values (if present) are ignored. GSLB host to be deleted.
Methods 7 getAllGslbZones Description Get information about GSLB zones. Parameters TABLE 21 getAllGslbZones parameters Parameters Type Presence Rules Description startIndex unsignedInt Optional Sets the starting index for retrieving GSLB zones. numRetrieved unsignedInt Optional Specifies the number of GSLB zones are to be retrieved. filter gslbZoneFilter Optional Filter criteria.
7 Methods getGslbZoneHost Description Get GSLB zone host information. Parameters TABLE 25 getGslbZoneHost parameters Parameters Type Presence Rules Description zoneName string Mandatory Name of the GSLB zone from which hosts are to be retrieved. hostName string Mandatory GSLB host name Return Values TABLE 26 getGslbZoneHost return values Parameters Type Description host gslbHost Details of GSLB hosts configured on specified zone. Error messages List of Error Messages.
Methods 7 Parameters TABLE 28 updateGslbZoneHost parameters Parameters Type Presence Rules Description zoneName string Mandatory Name of the GSLB zone in which hosts are to be updated. host gslbHost Mandatory GSLB host in which configuration is to be updated. Return Values Not applicable. Error messages List of Error Messages.
7 Methods Parameters TABLE 30 deleteGslbPolicy parameters Parameters Type Presence Rules Description policyType policyTypeEnum Mandatory Global or host policy. policyName string Mandatory Name of the policy to be deleted if the policy type specified is host policy. Return Values Not applicable. Error messages List of Error Messages. getAllGslbPolicies Description Get All GSLB global or host policies.
Methods 7 Parameters TABLE 33 getGslbPolicy parameters Parameters Type Presence Rules Description policyType policyTypeEnum Mandatory GSLB policy or host policy details. policyName string Mandatory Name of the policy whose details are to be retrieved if the policy type selected is host policy. Return Values TABLE 34 getGslbPolicy return values Parameters Type Description policy gslbPolicy GSLB policy or host policy details.
7 Methods deleteGslbHA Description Deletes the GSLB HA group. Parameters TABLE 36 deleteGslbHA parameter values Parameters Type Presence Rules haGroup gslbHAGroup Mandatory Description GSLB HA group. Return Values None. Error messages List of Error Messages. getAllGslbHAGroup Description Get all configured GSLB high availability (HA) groups.
Methods 7 Parameters TABLE 39 getAllGslbHAVipList parameters Parameters Type Presence Rules Description group gslbHAGroup Optional HA group filter. startIndex unsignedInt Optional Sets the starting index for retrieving the information of HA groups. numRetrieved unsignedInt Optional Specifies the number of HA groups to be retrieved. Return Values TABLE 40 getAllGslbHAVipList return values Parameters Type Description genericInfo ResponseInformation Generic information.
7 Data Structures Parameters TABLE 42 setGslbGlobalControllerParameters parameters Parameters Type Presence Rules parameters gslbGlobalControllerParameters Mandatory Description GSLB controller parameters. Return Values Not applicable. Error messages List of Error Messages. setGslbHA Description Configure GSLB high availability (HA) group.
Data Structures 7 connLoadIMetric This structure is the high-level description of connection load metric in GSLB policy. TABLE 45 connLoadMetric structure Name Type Presence Rules Description limit unsignedInt Optional Default value is 0. Mandatory when value of “Metric” is set to “TRUE” Load limit threshold (Connections per second). intervals connLoadInterval Optional weightList unsignedInt[] Optional Connection load interval. Default value is 1.
7 Data Structures gslbAdx This structure is the high-level description of ADX information. TABLE 48 700 gslbAdx structure Name Type Presence Rules Description server Server Mandatory Server->Name is a maximum of 16 characters. ADX name or IP address. preference unsignedInt Optional Valid range is from 0 to 255. Default value is 128. Set the preference value for a site ADX you have already configured. enableDistributedHealthCheck boolean Optional Default value is "TRUE".
Data Structures TABLE 48 7 gslbAdx structure Name Type Presence Rules Description secureCommunication boolean Optional Valid value is "TRUE" only. Configure secure authentication and encryption siteInfo gslbAdxSiteInfo Optional Parameter is valid as part of response message only. Ignored when part of a request message. Site information for GSLB ADX. gslbAdxConnLoad This structure is the high-level description of ADX connection load sample.
7 Data Structures TABLE 51 gslbAdxSimpleFilter structure Name Type Presence Rules Description startValue string Optional Start value in a range. endValue string Optional End value in a range. gslbAdxSiteInfo This structure is the high-level description of ADX site connection information.
Data Structures 7 gslbAdxVipInfo This structure is the high-level description of ADX virtual IP information. TABLE 53 gslbAdxVipInfo structure Name Type ipAddress Presence Rules Description string Parameter is valid as part of response message only. Ignored when part of a request message. ADX virtual IP address. state haStatusEnum Parameter is valid as part of response message only. Ignored when part of a request message. ADX is an active or standby ADX for VIP address.
7 Data Structures TABLE 54 gslbGlobalControllerParameters structure Name Type Presence Rules Description optimiseSlbEnable boolean Optional Default value is "FALSE". Enable or disable SLB OPT path for IPv4 when GSLB is configured optimiseSlbIpv6Enable boolean Optional Default value is "FALSE". Enable or disable SLB OPT path for IPv6 when GSLB is configured. vipListAdditionalWaitTime unsignedInt Optional Valid value range is from 0 to 255 seconds. Default value is 3 seconds.
Data Structures TABLE 57 7 gslbHASimpleFilter structure Name Type Presence Rules Description field gslbHAParameterEnum Mandatory Filter field name. operator filterOperatorEnum Mandatory Filter operator type. value string Optional Value of the field for filtering. startValue string Optional Start value in a range. endValue string Optional End value in a range. gslbHost This structure is the high-level description of GSLB host.
7 Data Structures TABLE 58 gslbHost structure Name Type Presence ipWeight hostProxyIP[ ] Optional affinityGroupNumber unsignedInt Optional Rules Description Configure IP Weight. Affinity group number must be valid. Valid value range is from 1 to 128. Domain level affinity group number. gslbPolicy This structure is the high-level description of GSLB policy and host policy.
Data Structures TABLE 59 7 gslbPolicy structure Name Type Presence Rules Description healthStatusReportInterval unsignedInt Optional Valid value range is from 2 to 120 seconds. Default value is 5 seconds. Configures the health status reporting interval. protocolStatusReportInterval unsignedInt Optional Valid value range is from 1 to 300 seconds. Default value is 30 seconds. Specifies the number of seconds between status reports.
7 Data Structures TABLE 62 708 gslbSite structure Name Type Presence Rules Description name string Mandatory Maximum 16 characters. Name of the GSLB site. weight unsignedInt Optional Valid value range is from 0 to 100. Default value is 0. Assign weights to the site. geographicLocation gslbSiteGeographicLocation Optional noDistributedHealthCheck boolean Optional Default value is "TRUE". Enable or disable the non-distributed health check feature for an entire GSLB Site.
Data Structures TABLE 62 7 gslbSite structure Name Type Presence Rules Description rttRampUpFactor unsignedInt Optional Valid value range is from 1 to 10. Default value is 2. Specifies the increments in which successively new high RTT samples should be factored into the existing RTT value. rttRampDownFactor unsignedInt Optional Valid value range is from 1 to 10. Default value is 3.
7 Data Structures gslbSiteOptimization This structure is the high-level description of GSLB optimization parameters. TABLE 65 gslbSiteOptimization structure Name Type Presence Rules Description enableOptimizedVipListSending boolean Optional Default value is "FALSE". Enable or disable sending the VIP list from the controller in a more optimal manner. disableSendingActiveBindings boolean Optional Default value is "FALSE".
Data Structures 7 gslbSiteSecureCommunication This structure is the high-level description of secure communication configuration in GSLB. TABLE 67 gslbSiteSecureCommunication structure Name Type Presence Rules Description enableSecureCommunicatio n boolean Optional Default value is "FALSE”. Enable or disable the secure protocol (authentication and encryption).
7 Data Structures gslbSiteSummary This structure is the high-level description of GSLB site. TABLE 69 712 gslbSiteSummary structure Name Type Presence Rules name string Mandator Maximum 16 y characters. Name of the GSLB site. adxList gslbAdx[ ] Optional List of ADX Servers. weight unsignedInt Optional geographicLocation gslbSiteGeographicLocation Optional noDistributedHealthCheck boolean Optional Default value is "TRUE".
Data Structures TABLE 69 7 gslbSiteSummary structure Name Type Presence Rules Description rttRampUpFactor unsignedInt Optional Valid value range is from 1 to 10. Default value is 2. Specifies the increments in which successively new high RTT samples should be factored into the existing RTT value. rttRampDownFactor unsignedInt Optional Valid value range is from 1 to 10. Default value is 3.
7 Data Structures TABLE 72 gslbZoneSimpleFilter structure Name Type Presence Rules Description startValue string Optional Start value in a range. endValue string Optional End value in a range. gslbZoneSummary This structure is the high-level description of GSLB zone. Name Type Presence Rules Description name string The GSLB zone. hostList gslbHost[ ] The host range. dnsSec dnsSecModeEnum DNS SEC mode enumeration list.
Data Structures TABLE 74 7 hostPort structure Name Type Presence Rules Description urlHeathCheck string Optional Valid only when host application is HTTP. For HTTP hosts, you also can customize the health check by changing the URL method and the string requested by the ADX, as well as the HTTP status codes that the ADX accepts as valid responses. By default, the ADX performs the HTTP health check as follows: • The ADX sends a HEAD request for the default URL string, “HEAD /”.
7 Data Structures TABLE 76 716 hostProxyInfo structure Name Type Presence Rules Description addressType hostProxyTypeEnum Optional Parameter is valid as part of response message only. Ignored when part of request message. Indicates the type of address. serverState hostProxyStateEnum Optional Parameter is valid as part of response message only. Ignored when part of request message. The state of the server.
Data Structures TABLE 76 7 hostProxyInfo structure Name Type Presence Rules Description haPeerAdxIP string Optional Parameter is valid as part of response message only. Ignored when part of request message. The configured high-availability peer site ADX for this site ADX. sessionUtilizati on unsignedInt Optional Value is in percentage. Parameter is valid as part of response message only. Ignored when part of request message.
7 Data Structures TABLE 79 metricCounter structure Name Type Presence Rules Description metricType policyMetricTypeEnum Optional Parameter is valid as part of response message only. Ignored when part of request message. The metric that was used to select a given site as the best site. Optional Parameter is valid as part of response message only. Ignored when part of request message. The number of times that metric was the deciding factor in the selection of the site.
Data Structures TABLE 81 7 policyDnsParameters structure Name Type Presence Rules Description queryCheckInterval unsignedInt Optional Valid value range is from 1 to 1000000000 seconds. Default value is 30 seconds. Not Applicable for HostPolicy. Indicates how frequently the GSLB ADX refreshes its zone and host information with DNS servers. dnsCacheProxy boolean Optional Default value is “FALSE”. Not Applicable for HostPolicy. Enable or disable DNS cache proxy.
7 Data Structures TABLE 82 policyMetrics structure Name Type Presence Rules Description numSession numSessionMetric Optional Configure remote ADX available session capacity metric. flashback flashbackMetric Optional Configure server flashback speed metric. preference boolean Optional Default value is "DISABLED". Enable or disable remote Virtual ADX's preference metric. roundRobin boolean Optional Default value is "FALSE". Enable or disable Round Robin selection metric.
Enumerations TABLE 84 7 rttMetric structure Name Type Presence Rules Description cacheInterval unsignedInt Optional Valid range is from 10 to 1000000 seconds. Default value is 120 seconds. Duration to age out client prefixes in cache. cachePrefixLength unsignedInt Optional Valid length is from range 1 to 31. Default value is 20. Prefix length at which to aggregate measured RTT in cache. explorePercentage unsignedInt Optional Value is a percentage. Valid range is from 0 to 100.
7 Enumerations TABLE 87 dnsReturnCodeEnum Parameters Description FORMAT_ERROR Format error. NO_ERROR No error. This is the default value. NOT_IMPLEMENTED_ERROR Not implemented error. DOMAIN_DOESNT_EXIST_ERROR Non-existant domain error. QUERY_REFUSED_ERROR Query refused error. SERVER_FAILURE_ERROR Server failure error. dnsSecModeEnum These are the enumerations for modes of DNS SEC. TABLE 88 dnsSecModeEnum Parameters Description DNSSEC_CAPABLE GSLB zone is configured as DNSSEC-capable.
Enumerations TABLE 90 7 geographicLocationEnum Parameters Description AFRICA ASIA EUROPE NORTH_AMERICA SOUTH_AMERICA NONE gslbActiveRttParameterEnum These are the enumerations for parameter names in GSLB active RTT configuration. TABLE 91 gslbActiveRttParameterEnum Parameters Description AGENT_RTT_GATHERING Identifier for “enableActiveRTTGathering” parameter. DISCARD_PASSIVE_RTT Identifier for “discardPassiveRTT” parameter.
7 Enumerations TABLE 91 gslbActiveRttParameterEnum Parameters Description AGENT_FAST_AGE_ON_DNS_FAILURE Identifier for “GSLBActiveRTTAgentParameters->enableFastAgeOnDNSfailure” parameter. AGENT_UDP_PROBE_PORT Identifier for “GSLBActiveRTTAgentParameters->UDPProbePort” parameter. gslbAdxConnectionStateEnum These are the enumerations for connection states of the Virtual ADX.
Enumerations TABLE 94 7 gslbHAParameterEnum Parameters Description AGENT_IP_ADDRESS Identifier for “AgentIP” parameter. gslbPeerPublicKeyExpiryTypeEnum These are the enumerations for the GSLB types of peer public key expiry.
7 Enumerations gslbSiteParameterEnum These are the enumerations for parameters in GSLB site configuration. TABLE 98 gslbSiteParameterEnum Parameters Description ADX_SERVER_NAME Identifier for “GSLBSite->adxList->Server” name parameter. ADX_SERVER_IP Identifier for “GSLBSite->adxList->Server” IP parameter. ADX_LIST_PREFERENCE Identifier for “GSLBSite->adxList->preference” parameter.
Enumerations TABLE 99 7 gslbZoneEnum Parameters Description ZONE_NAME The zone name. DNS_SEC HOST_NAME The host name. PORT ALIAS USE_MIN_BINDINGS AFFINITY_GROUP_NUMBER The number of affinity definitions currently configured on the GSLB ADX and the maximum number that can be configured. haStatusEnum This type of data describes a HA status enumerated list. TABLE 100 Parameters Description ACTIVE Indicates the active device in the HA pair. STANDBY Indicates the standby device in the HA pair.
7 Enumerations hostProxySourceEnum These are the enumerations for source of GSLB host proxy. TABLE 102 hostProxySourceEnum Parameters Description CONFIGURED The address is one that you associated with the host as part of the DNS override feature. DNS_SERVER_AND_CONFIGURED The address was learned from the DNS server and is also one that you associated with the host. DNS_SERVER The address was learned from the DNS server.
Enumerations TABLE 105 7 policyMetricTypeEnum Parameters Description ROUND_TRIP_TIME Round-trip latency from remote ADX to client network metric. GEOGRAPHIC Geographic location metric. CONNECTION_LOAD Site ADX connection load metric. NUM_SESSION Remote ADX available session capacity metric. FLASHBACK Server Flashback speed metric. PREFERENCE Remote SI's preference metric. ORDER Default metric order ROUND_ROBIN_SELECTION Round robin selection metric.
7 Enumerations policyTypeEnum These are the enumerations for parameters in GSLB host policy configuration. TABLE 107 policyTypeEnum Parameters Description GLOBAL_POLICY Global policy HOST_POLICY Host policy BOTH Both global and host policies twoWayToggleEnum These are the enumerations for a two way toggle enumerated list. TABLE 108 730 Parameters Description ENABLED Enabled. DISABLED Disabled.
Appendix A Error Messages In this appendix • List of Error Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731 These error messages can be obtained by importing one or more of the WSDLs as required. Some of the error messages may overlap across WSDLs. A few of the error messages contain variable names which are replaced with the actual occurrence of the variable during run time.
A List of Error Messages TABLE 109 732 List of error messages Error String Message ACL_ADD_RULE_INVALID_INPUT The specified input is invalid. Both Number and Name cannot be used together. Please specify either a number or a name. ACL_ADD_RULE_MISSING_PARAM The mandatory parameter "%s" is missing. Please specify the mandatory parameter "%s" for "%s". ACL_BOTH_ANYHOST_AND_HOST_UNSUPPORTED The specified request contains both 'anyHost' and 'Host' information.
List of Error Messages TABLE 109 A List of error messages Error String Message ACL_INPUT_NAME_ALREADY_EXIST An extended access list with this name already exists. Please specify a valid and unique ACL name since "%s" is already in use. ACL_INVALID_ACL_NAME_SPECIFIED Invalid access list name"%s".
A List of Error Messages TABLE 109 734 List of error messages Error String Message ACL_MISSING_SYSTEM_RESET_INTERVAL_PARAM The mandatory parameter 'systemResetInterval' is missing. Please specify a valid value in the range of %d to %d. ACL_NOT_BOUND_TO_INTERFACE The specified Access-Group "%s" is not bound to the "%s". Please specify a valid ACL and interface information for unbinding. ACL_NOT_BOUND_TO_SSH The specified Access-Group "%s" is not bound to SSH.
List of Error Messages TABLE 109 A List of error messages Error String Message CONFIG_SYNC_DUPLICATE_SYM_PRIORITY_MAP_EN TRY The specified Sym priority map entry with Sender value = %u and Receiver value = %u already exists. Please specify a unique Sym priority map entry. CONFIG_SYNC_FILE_SYNC_TASK_INITIATION_FAILED The File sync or Config sync task failed to initiate. Please try again later. CONFIG_SYNC_FLASH_ERASE_IN_PROGRESS A Flash erase is in progress.
A List of Error Messages TABLE 109 736 List of error messages Error String Message CONFIG_SYNC_OPERATION_NOT_ALLOWED_ON_REC EIVER Cannot perform a Config sync operations on receiver. Please perform a Config sync operation from the sender only. CONFIG_SYNC_OPERATION_UNSUPPORTED_ON_MA STER This operation is not supported on MT Master. Please try with operations other than SSL or OpenScripts. CONFIG_SYNC_PEER_NOT_CONFIGURED The Config sync peer is not configured.
List of Error Messages TABLE 109 A List of error messages Error String Message FW_GROUP_ALREADY_EXIST The specified Firewall group "%s" already exists. Please specify a new Firewall group. FW_GROUP_DOESNOT_EXIST The specified Firewall Group "%s" does not exist. Please specify an existing Firewall Group. FW_GROUP_MISSING The Firewall Group is missing. Please specify either an IPv4 or IPv6 group ID. FW_INFO_MISSING The Firewall configuration is missing. Please specify the Firewall configuration.
A List of Error Messages TABLE 109 738 List of error messages Error String Message HA_ENABLE_VRRPE_NOT_SUPPORTED Enable VRRP Extended failed. Must disable VRRP before enabling VRRP Extended. HA_INVALID_BACKUP_DELAY Failover delay value is not in range. Maximum allowed value is 1200 (20 min), Please specify a valid value. HA_INVALID_BACKUP_GROUP_ID The specified backup group ID value is not in range. Please specify a valid value in the range of 0 to 127.
List of Error Messages TABLE 109 A List of error messages Error String Message NAT_MISSING_MANDATORY_PARAM The mandatory input parameter "%s" is missing. Please specify the input parameter to continue. NAT_MISSING_PRIVATE_IP_PARAM The mandatory parameter 'private IP' is missing. Please specify a valid private IP address. NAT_ONLY_NUMBERED_ACL_ALLOWED Only numbered ACLs are allowed for NAT pool binding. Please specify a numbered ACL for pool %s.
A List of Error Messages TABLE 109 740 List of error messages Error String Message NET_BGP4_ALREADY_CREATED The BGP instance is already created. Please delete the old instance before creating a new BGP instance. NET_BGP4_DELETE_FAILED The Delete BGP instance failed. The BGP instance does not exist. Please create a BGP instance before you can delete it. NET_BGP4_DOES_NOT_EXIST The Operation failed. The BGP instance does not exist. Please create a BGP4 instance before you can configure it.
List of Error Messages TABLE 109 A List of error messages Error String Message NET_INT_ADDRESS_NOT_FOUND The specified IP address %I is not found in the interface %P. Please specify an IP address which already exists. NET_INT_ADDRESS_ON_FOLLOWER_INT The specified interface %P is a follower interface. IP addresses cannot be configured on a follower interface. NET_INT_BOTH_PORTSTRING_AND_INTERFACE_UNS UPPORTED The specified interface ID has both 'portString' and 'interfaceType' parameters.
A List of Error Messages TABLE 109 List of error messages Error String Message NET_INT_INVALID_UNICAST_ADDRESS The specified unicast IP address %s in the interface %P is invalid. Please specify a valid unicast IP address. NET_INT_IP_ADDRESS_INVALID The specified IP address %s on the interface %P is invalid. Please specify a valid IPv4 or IPv6 address on the interface. NET_INT_IP_ADDRESS_NOT_FOUND_FOR_SYN_DEFE The specified interface %P does not have any IP NSE addresses configured.
List of Error Messages TABLE 109 A List of error messages Error String Message NET_INT_IPV6_ADDRESS_UNSUPPORTED The specified interface %P does not support and IPv6 address configuration. The IPv6 address configuration is not supported for the Management interface. NET_INT_IPV6_LINKLOCAL_IPMASK_UNSUPPORTED The specified subnet mask in interface %P is not supported for the link-local IP configuration. Please do not specify a subnet mask for a link-local IP address configuration.
A List of Error Messages TABLE 109 744 List of error messages Error String Message NET_INT_MISSING_SPEED_OR_DUPLEX The specified interface %P configuration is missing either a speed or duplex configuration. Please specify both speed and duplex configurations on the specified interface. NET_INT_MISSING_SUBNET_MASK The mandatory parameter subnet mask string (applicable only for IPv4) or length for the interface %P is missing.
List of Error Messages TABLE 109 A List of error messages Error String Message NET_INT_PORT_STRING_INVALID The specified portString "%s" is invalid. Please specify a valid value for portString. Ethernet: ('1', '1/1' etc), Loopback: ('lb1', 'lb2' etc), Group Virtual: ('group-ve1', 'group-ve2' etc), Virtual: ('ve1', 've2' etc) or Management: ('mgmt1' only). NET_INT_PRIMARY_ADDRESS_NOT_CONFIGURED The primary IP address is not configured on the specified subnet in the interface %P.
A List of Error Messages TABLE 109 746 List of error messages Error String Message NET_INT_SYN_DEFENSE_IS_ENABLED The specified interface %P is configured with SYN defense. Please disable SYN defense first before enabling SYN proxy on the specified interface. NET_INT_SYN_PROXY_IS_ENABLED The specified interface %P is configured with SYN proxy. Please disable SYN proxy first before enabling SYN defense on the specified interface.
List of Error Messages TABLE 109 A List of error messages Error String Message NET_INVALID_LOCAL_PREFERENCE The Local Preference value is invalid. Please specify a valid preference value in the range of %d to %u. NET_INVALID_MAX_AGE The specified Max Age is invalid. Please specify valid Max Age in the range of 6 to 40. NET_INVALID_MAX_ASPATH The Maximum AS Path value is invalid. Please specify a valid maximum AS Path value in the range of 0 to 300.
A List of Error Messages TABLE 109 748 List of error messages Error String Message NET_IPS_INVALIED_IP The specified IP subnet "%I" is invalid. Please specify a valid IP subnet. NET_IPS_INVALIED_SUBNET_MASK The specified IP subnet mask "%I" is invalid. Please specify a valid IP subnet mask. NET_IPS_ROUTER_INT_CONFIGURED A Virtual router interface is configured on VLAN. The virtual router interface is configured on "%s" VLAN %d.
List of Error Messages TABLE 109 A List of error messages Error String Message NET_MAC_ADDRESS_INVALID The specified MAC address "%s" is invalid. Please specify a valid MAC address. NET_MAC_ADDRESS_MISSING The specified request does not contain the MAC information. Please specify the MAC information. NET_MAC_ALREADY_EXISTS The specified MAC entry already exists. Specify a different and unique MAC address. NET_MAC_BROADCAST The broadcast MAC address cannot be configured as a static MAC address.
A List of Error Messages TABLE 109 750 List of error messages Error String Message NET_MISSING_ADMIN_DISTANCE The Admin distance value is missing. Please specify a valid admin distance value in the range of %d to %u. NET_MISSING_BGP_NEIGHBOR_IP The BGP Neighbor IP Address is missing. Please specify valid IPv4 Address for BGP4 and IPv6 for BGP4PLUS. NET_MISSING_BGP_VERSION The BGP Version is missing. Please specify a valid BGP version BGP4 or BGP4PLUS.
List of Error Messages TABLE 109 A List of error messages Error String Message NET_OSPF_AREA_RANGE_MANDATORY_PARAMETER S The mandatory parameter IP and mask/prefix is missing. Please specify the IP and mask/prefix to delete the OSPF Area. NET_OSPF_AREA_RANGE_MAX_ENTRY_EXCEEDED The specified Area Range "%s" cannot be added. The maximum entries for the Area Range have been reached. NET_OSPF_AREA_TYPE_MANDATORY The Area type is mandatory for configuring OSPF Area Range.
A List of Error Messages TABLE 109 752 List of error messages Error String Message NET_OSPF_INTERFACE_DOESNOT_EXIST The specified OSPF interface does not exist. Please specify an existing OSPF interface. NET_OSPF_INTERFACE_DOWN The specified interface %P is down. The interface should be active before the configuration can be applied. NET_OSPF_INTERFACE_ENTRIES_MISSING The OSPF interface entries are not available. Please configure OSPF at the interface level.
List of Error Messages TABLE 109 A List of error messages Error String Message NET_OSPF_INVALID_SPF_DELAY The specified SPF delay %u is invalid. Please specify a valid SPF delay value in the range of 0 to 65535. NET_OSPF_INVALID_SPF_HOLDTIME The specified SPF hold time %u is invalid. Please specify a valid SPF hold time value in the range of 0 to 65535. NET_OSPF_INVALID_SPINUM The specified spinum %u is invalid. Please a valid spinum value in the range of 256 to 4294967295.
A List of Error Messages TABLE 109 List of error messages Error String Message NET_OSPF_ROUTE_MISSING The OSPF routing entries are not available. Please configure the OSPF routing entries. NET_OSPF_SYSTEM_BUSY The OSPF database is busy. Please try again later. NET_OSPF_TABLE_FULL Failed to configure the OSPF Area. Please delete the unused OSPF Areas (if any). NET_OSPF_UNABLE_TO_SET_AREA_RANGE Failed to configure the Area Range. Please configure the Area ID first.
List of Error Messages TABLE 109 A List of error messages Error String Message NET_OSPFV3_LOG_NOT_SUPPORTED The OSPFv3 log is not supported. Please specify the OSPF version to configure the log. NET_OSPFV3_MD5_AUTH_KEY_ID_NOT_APPLICABLE The specified MD5 authentication key ID option is not applicable for OSPFv3. Please specify the option for OSPFv2. NET_OSPFV3_MD5_AUTH_KEY_NOT_APPLICABLE The specified MD5 authentication key option is not applicable for OSPFv3.
A List of Error Messages TABLE 109 756 List of error messages Error String Message NET_ST_INVALID_METRIC The specified static route metric is out of range. Please specify a valid value range of %d to %d. NET_ST_INVALID_TYPE The specified static route type is invalid. Please specify the valid static route type. NET_ST_IPV4_INCOSITENT_SUBNETMASK The specified subnet mask is invalid. The specified subnet mask is inconsistent. NET_ST_IPV4_INVLAID_SUBNETMASK The specified subnet mask is invalid.
List of Error Messages TABLE 109 A List of error messages Error String Message NET_SWITCH_IP_ADDRESS_IN_RESERVED_RANGE The specified IP address %I (subnet mask %I) is in reserved range. Please specify any IP address apart from reserved range from %I to %I. NET_SWITCH_IP_CONFIG_INFO_NEEDED The Switch IP configuration is missing. Please specify a valid Switch IP configuration. NET_SWITCH_IP_INFO_NEEDED The Switch IP and default gateway information is missing.
A List of Error Messages TABLE 109 758 List of error messages Error String Message NET_VLAN_GROUP_REMOVE_EXISTING Please remove the previously configured VLAN group. Please remove the previously configured VLAN group %d, and then try again. NET_VLAN_GROUP_SPECIFY_VLAN VLAN is not available to create a new VLAN group. Please specify a VLAN when creating a new VLAN group. NET_VLAN_GROUP_TOO_BIG The specified VLAN group is too big to remove more than 256 VLANs at a time.
List of Error Messages TABLE 109 A List of error messages Error String Message NET_VLAN_IPS_FAILED_PORT_NOT_CONF Failed to create an IP subnet VLAN (%I/%d) because ports were not configured in the Layer 2 VLAN %d. Please configure the ports in the Layer 2 VLAN. NET_VLAN_IPS_NAME_LENGTH_OUT_OF_RANGE The specified IP Subnet VLAN name is too long. Please specify a valid VLAN name not more than %d characters. NET_VLAN_IPS_NOT_FOUND The specified IP subnet VLAN is not found.
A List of Error Messages TABLE 109 List of error messages Error String Message NET_VLAN_ROUTER_INT_CONFIG_FAILED The route interface cannot be configured. No physical interfaces can be added to VLAN %d Please add physical interfaces to the VLAN and try again. NET_VLAN_ROUTER_INT_IN_USE The specified router interface %d has been configured on another VLAN. Please specify a different router interface. NET_VLAN_ROUTER_INT_INVALID The specified Router interface %d is invalid.
List of Error Messages TABLE 109 A List of error messages Error String Message NET_VRRP_IPV4_ADDRESS_CONFIG_ON_INTERFACE _FAILED The VRRP IPv4 address configuration on interface failed. The local IP address %I in this interface cannot be used as the VRRP IP address. NET_VRRP_IPV6_ADDRESS_CONFIG_ON_INTERFACE _FAILED The VRRP IPv6 address configuration on interface failed. The local IP address %s in this interface cannot be used as the VRRP-E IP address.
A List of Error Messages TABLE 109 762 List of error messages Error String Message NET_VRRP_VRID_IPV6_ALREADY_IN_USE IP configuration for VRID failed. IPv6 address %s already used by VRID %u as owner. Please specify new valid IPv6 Address. NET_VRRP_VRID_NOT_CONFIGURED The VRID value is not configured on any of the interface. Please specify a configured VRID value in the range of 1 to 255. PBSLB_CONFIG_DOWNLOAD_INETRVAL_FAILED Configuration of download interval failed.
List of Error Messages TABLE 109 A List of error messages Error String Message PBSLB_MEM_REQUIREMENT_FAILED PBSLB memory requirement failed on MP. PBSLB memory requirement failed on MP. PBSLB_MISSING_FILE_NAME The mandatory parameter TFTP filename is missing. Please specify a valid filename. PBSLB_POLICY_ENTRY_ALREADY_EXIST The specified policy entry %s already exists. Please specify valid policy entry. PBSLB_POLICY_ENTRY_DOES_NOT_EXIST The specified policy entry %s does not exist.
A List of Error Messages TABLE 109 764 List of error messages Error String Message RBM_INVALID_PASSWORD_EXPIRE_TIME The password-expired time value is out of range. Please specify a valid value in the time range of %d to %d. RBM_MAX_USER_PROFILE_REACHED The maximum allowed user profiles %d is already reached. Please delete any unused user profiles before trying to create new user profiles. RBM_MISSING_CONTEXT_NAME The mandatory parameter context name is missing.
List of Error Messages TABLE 109 A List of error messages Error String Message SCRIPT_INTERPRETER_NOTFOUND The interpreter is not found. Please check whether the interpreter was successfully allocated and initialized for the given virtual port. SCRIPT_INTERPRETER_NULL The Perl interpreter is not found. Please check whether the Perl interpreter is allocated. SCRIPT_L4DATA_L7EVENTS_COLLIDE The script has Layer 4 data (TCP or UDP) events along with HTTP events.
A List of Error Messages TABLE 109 List of error messages Error String Message SCRIPT_WARN_MESSAGE_GSLB Warning: The system has both GSLB and the script configured. GSLB action takes precedence over the actions set by the script on DNS packets. SLB_446_IPV6_PREFIX_NOT_CONFIGURED_BINDING The specified Virtual Server "%s" (%I) cannot be bound _FAILED with the Real Server because the SLB 446 IPv6 prefix is not configured. Please configure the SLB 446 IPv6 prefix first.
List of Error Messages TABLE 109 A List of error messages Error String Message SLB_CONTENT_CHECK_ARRAY_FAIL_ON_UDP_BOUN D_PORT The content-check array cannot be configured on a UDP bound port. Please specify a port which is not bound to the UDP port. SLB_CONTENT_CHECK_FAIL_FOR_KNOWN_PORTS The content-check cannot be configured for "known" ports. Please specify only the "unknown" ports for the content-check configuration.
A List of Error Messages TABLE 109 List of error messages Error String Message SLB_CSW_INVALID_CONFIG_RULE_ALREADY_BOUND The specified CSW Rule "%s" is already bound to the policy. Please specify another CSW Rule to bind to the policy. SLB_CSW_INVALID_COOKIE_CONFIG The cookie-name can only be specified with the group ID. Please specify the cookie-name with a group ID. The group ID value must be in the range of 0 to 1024.
List of Error Messages TABLE 109 A List of error messages Error String Message SLB_CSW_MISSING_PRIMARY_ACTION_FOR_DEFAUL T_RULE The primary action for the specified policy "%s" is missing. Please specify the primary action for the default rule. SLB_CSW_MISSING_PROPERTYLIST_NAME_CONNEC TION_RATE The property list name 'CONNECTION_RATE' is missing or invalid. Please specify a valid property list name.
A List of Error Messages TABLE 109 List of error messages Error String Message SLB_CSW_MISSING_PROPERTYLIST_VALUE_HTTP_T RL The property list value for 'TRL_POLICY_NAME' is missing. Please specify the property list name with a valid value. SLB_CSW_MISSING_RESPONSE_HEADER_NAME The Header name tag is missing. Please specify HEADER_NAME tag with value. SLB_CSW_MISSING_RULE_NAME The CSW Rule name is missing. Please specify a CSW Rule name that is not more than 1 to %d characters.
List of Error Messages TABLE 109 A List of error messages Error String Message SLB_CSW_RESPONSE_RULE_DOES_NOT_EXIST The specified CSW Response Rule "%s" does not exist. Please specify an existing CSW Response Rule name. SLB_CSW_RESPONSE_RULE_NAME_ALREADY_EXIST A response rule already exists for the specified response rule name "%s". Please specify a new CSW response rule. SLB_CSW_RULE_CTX_MISMATCH CSW Rule:"%s" does not belong to context "%s".
A List of Error Messages TABLE 109 772 List of error messages Error String Message SLB_ENABLE_STICKY_ACL_ID_FAILED Enabling Sticky ACL failed. To enable Sticky ACL, you must specify a sticky ACL ID value. SLB_ENABLE_STICKY_PARAMS_MISSING The enable client subnet sticky operation failed. To enable client subnet sticky operation, you must specify a subnet mask or a prefix length. SLB_ENABLE_TCP_OFFLOAD_FAILED Enabling the TCP offload has failed for the port %d.
List of Error Messages TABLE 109 A List of error messages Error String Message SLB_ERROR_ON_MAX_EXCEED_OF_HEADER_SUPPO RT The maximum number of headers supported has been exceeded. Please specify a maximum of %d headers. SLB_ERROR_ON_MAX_EXCEED_OF_XML_TAG_SUPP ORT The maximum number of XML TAGs supported has been exceeded. Please specify a maximum of %d XML TAGs. SLB_FAIL_CSW_BIND_ALREADY_BOUND_PORT The specified Virtual Server Port %d is already bound to another CSW Policy "%s".
A List of Error Messages TABLE 109 774 List of error messages Error String Message SLB_FAIL_CSW_RULE_UPDATE_RULE_IS_IN_USE The specified rule "%s" is in use. Please unbind the rule before updating the CSW Request Rule. SLB_FAIL_TO_CREATE_IDENTICAL_CSW_RULE_FOUN D The specified CSW rule "%s" is identical to the rule being defined. Please specify different values for the new rule to be created.
List of Error Messages TABLE 109 A List of error messages Error String Message SLB_HEALTH_CHECK_MISSING_DNS_QUERY_OR_ZO NE The DNS port parameters dns-query or zone are missing. Please specify either dns-query or zone or both values. SLB_HEALTHCHECK_INVALID_PROTOCOL The specified protocol "%s" is invalid. Please specify a valid protocol. SLB_HEALTHCHECK_MISSING_PORT_FOR_PROTOCO L You must configure the port before configuring the protocol. Please specify a valid port.
A List of Error Messages TABLE 109 776 List of error messages Error String Message SLB_INVALID_GROUP_ID_MISMATCH The specified group ID pair %d-%d is invalid. The group ID minimum value should not be greater than maximum value. SLB_INVALID_HEALTH_CHECK_RETRIES The specified health check retries %u is invalid. Please specify a valid value in the range of 3 to 31. SLB_INVALID_INPUT_HEALTH_CHECK_ICMP The port or potocol is applicable only to TCP or UDP Element Health Check policies.
List of Error Messages TABLE 109 A List of error messages Error String Message SLB_INVALID_PORT_TO_SET_MATCH_LIST_HEALTH_ CHECK The HTTP match-list health check cannot be applied for the port %d. Please specify only the HTTP port for the HTTP match-list health check. SLB_INVALID_PORT_TO_SET_TCP_HEALTH_CHECK The TCP health check cannot be applied for the UDP well-known port %d. Please specify only the TCP port for the TCP health check.
A List of Error Messages TABLE 109 List of error messages Error String Message SLB_INVALID_PROPERTYLIST_HTTP_VERSION_NAME The HTTP version rule name has exceeded the maximum number of characters allowed. Please specify the rule name that is not more than %d characters. SLB_INVALID_PROPERTYLIST_HTTP_VERSION_VALUE The property list value is invalid for the Request Rule "%s". Please specify the version value as 1.0 or 1.1.
List of Error Messages TABLE 109 A List of error messages Error String Message SLB_INVALID_SIMPLE_RULES The specified rule "%s" is a nested rule. Only simple rules are allowed inside nested rules. Please specify a valid simple rule. SLB_INVALID_STICKY_AGE_INTERVAL The sticky age interval value is out of range. Please specify a valid interval in the range of %d to %d. SLB_INVALID_STICKY_MASK The specified client sticky subnet mask is invalid. Please specify a valid MAC mask.
A List of Error Messages TABLE 109 780 List of error messages Error String Message SLB_L4_BRINGUP_CHECK_INTERVAL_OUT_OF_RAN GE The specified L4 bringup check interval value %d is out of range. Please specify a valid value in the range of %d to %d. SLB_L4_BRINGUP_INTERVAL_NOT_ALLOWED The Layer 4 bring up interval command does not apply to this port. Please specify a valid port. SLB_L4_BRINGUP_RETRIES_NOT_ALLOWED The Layer 4 bring up retries command does not apply to this port.
List of Error Messages TABLE 109 A List of error messages Error String Message SLB_MISSING_CSW_REQUEST_RULE_TYPE The Request Rule type for the specified rule "%s" is missing. Please specify one of the values: URL | HTTP_HEADER | HTTP_METHOD | HTTP_VERSION | HTTP_COOKIE | XML_TAG | TCP_CONTENT | UDP_CONTENT | NESTED. SLB_MISSING_CSW_RESPONSE_BEGIN_STATUS_CO DE The property list name for the specified Response Rule "%s" is missing. Please specify the property list name as BEGIN_STATUS_CODE.
A List of Error Messages TABLE 109 782 List of error messages Error String Message SLB_MISSING_PROPERTYLIST_HTTP_METHOD_VALU E The property list value is missing for the Request Rule "%s". Please specify one of the values: GET | HEAD | POST | OPTIONS | PUT | DELETE | TRACE | PROPFIND | MOVE | CONNECT | BDELETE | PROPPATCH | COPY | LOCK | UNLOCK |MKCOL | BCOPY | BMOVE | POLL | SUBSCRIBE | SEARCH |BPROPPATCH | RPC_OUT_DATA | RPC_IN_DATA.
List of Error Messages TABLE 109 A List of error messages Error String Message SLB_MISSING_RSRVR_NAME_AND_IP The Real Server name and IP address is missing. Please specify both the valid Real Server name and the IP address. SLB_MISSING_RSRVR_NAME_OR_IP The Real Server name or IP address is missing. Please specify a valid Real Server name or IP address. SLB_MISSING_RSRVR_PORT The Real Server Port name or number is missing. Please specify a valid Real Server Port.
A List of Error Messages TABLE 109 784 List of error messages Error String Message SLB_NO_PORT_BINDING The specified port has no Real Server bindings. Please specify a port which has Real Server bindings. SLB_NO_URL_KEEPALIVE The specified URL cannot be configured on the port %d. The URL is not supported for keepalive protocol. SLB_NODE_NOT_FOUND The health check element is not found. Please specify an existing health check element.
List of Error Messages TABLE 109 A List of error messages Error String Message SLB_PORT_NOT_DEFINED_RS The specified port "%s" is not defined on the real server "%s". Please specify a port defined on the real server. SLB_PORT_NOT_DEFINED_VS The specified port "%s" is not defined on the virtual server "%s". Please specify a valid port, defined on the virtual server. SLB_PORT_NUMBER_OUT_OF_RANGE The specified port %u is invalid. Please specify a valid value in the range of 1 to 65365.
A List of Error Messages TABLE 109 786 List of error messages Error String Message SLB_REAL_SERVER_DUPLICATE_IP ACL based source NAT not supported for IPv6. SLB_REAL_VIRTUAL_ALREADY_BOUND The specified Real Server Port "%s" is already bound to "%s" virtual port. Please specify a Real Server Port which is not bound to the virtual port. SLB_RESPONSE_STATUS_CODE_IMPROPER The response status code range specified is incorrect. Please specify a proper range of codes. The range is from 0 to 999.
List of Error Messages TABLE 109 A List of error messages Error String Message SLB_RSG_GROUP_CTX_MISMATCH The Group:"%s" does not belong to this context. Please try with a valid context. SLB_RSG_GROUP_EXIST The Group "%s" already exists. Please try with another name. SLB_RSG_GROUP_NOT_FOUND The Real Server group "%s" is not found. Please try with valid Real Server group name SLB_RSG_GRP_ADD_FAILED Addition of Real Server group "%s" failed. Please try again later.
A List of Error Messages TABLE 109 788 List of error messages Error String Message SLB_RSG_RS_MEMBER The Real Server "%s" is already member of other group "%s" SLB_RSG_RS_NO_PORT The Real Server:"%s" and Port:%d is not configured. Please specify an existing Real Server and port. SLB_RSG_RS_NOT_FOUND The Real Server:"%s" does not exist. Please try with valid Real Server SLB_RSG_UNBIND_FAILED The unbinding failed for Virtual Server: "%s", Virtual Port: %d, Group: "%s", Port: %d.
List of Error Messages TABLE 109 A List of error messages Error String Message SLB_RSRVR_NOT_PRIMARY_OF_BACKUP_RSRVR The specified Real Server "%s" is not the primary backup server. Please specify a different Real Server for backup purposes. SLB_RSRVR_PORT_AWAITING_SHUTDOWN The specified Real Server Port "%s":"%s" is currently awaiting shutdown. No additional requests can be processed for the Real Server Port while it awaits shutdown.
A List of Error Messages TABLE 109 List of error messages Error String Message SLB_SNMP_MISSING Cannot find SNMP server %I. Please specify the valid SNMP server. SLB_SNMP_OID_INVALID The SNMP request OID value is out of range. Please specify a valid Interval in the range of %d to %d. SLB_SNMP_OID_MAX MIB Object ID must be less than %d. Please specify the MIB Object ID to be less than %d. SLB_SOURCE_NACT_ACL_ID_INVALID The source NAT ACL ID value is out of range.
List of Error Messages TABLE 109 A List of error messages Error String Message SLB_STATUS_CODE_MIN_OUT_OF_RANGE The specified status code minimum value %d is out of range. Please specify a valid value in the range of %d to %d. SLB_STATUS_CODE_MISMATCH The specified status code pair %d-%d is invalid. The status code minimum value should not be greater than the status code maximum value. SLB_STATUS_CODE_MISSING_MAX The maximum status code value is missing.
A List of Error Messages TABLE 109 792 List of error messages Error String Message SLB_SVR_CNTR_OFFSET_INVAL Offset not recognized SLB_SVR_CNTR_OFFSET_RETRY Resend the last data SLB_SVR_CNTR_SYNC_ERR Sync error SLB_SVR_DOESNT_EXIST The specified server "%s" does not exist. Please specify a different server or create a new server. SLB_SVR_DOESNT_EXIST_EX The specified server name "%s" and the IP address "%s" does not exist. Please specify a different server or create a new server.
List of Error Messages TABLE 109 A List of error messages Error String Message SLB_TRACK_PORT_DEL_FAILED The Port %d is part of another track port group, and cannot be added to two different track port groups. Please specify a valid track port. SLB_UNMATCH_COUNTER_OFFSET The counter offset does not match the specified Virtual Server "%s" %d. Please specify the matching counter offset for the Virtual Server. SLB_URL_HTTP The URL cannot be configured to the specified port %d.
A List of Error Messages TABLE 109 794 List of error messages Error String Message SLB_VIP_RHI_NOT_ENABLED VIP RHI is not enabled for VIP %I. To enable inject-always, the VIP RHI must be configured. SLB_VS_CTX_MISMATCH The Virtual Server:"%s" does not belong to context "%s" Please specify the context in which Virtual Server belongs. SLB_VS_ENABLE_FALLBACK_FAILED Enable Fallback on port "%s" has failed. To enable fallback, the next hop IP address must be configured.
List of Error Messages TABLE 109 A List of error messages Error String Message SNMP_COMMUNITY_STRING_UNSUPPORTED The community string parameter is not supported with the security model "%s" for the host "%s". Please do not specify the community string parameter. SNMP_ENGINE_ID_MAX_LEN_EXCEEDED The specified SNMP engine ID "%s" has exceeded the maximum length. Please specify a valid SNMP engine ID not more than %d characters.
A List of Error Messages TABLE 109 796 List of error messages Error String Message SNMP_MISSING_AUTHENTICATION_TYPE_PARAM The parameter authentication type for the user "%s" is missing. Please specify a valid authentication type parameter. SNMP_MISSING_COMMUNITY_STRING_ACCESS_LEV EL The mandatory parameter accessLevel is missing for the community string "%s". Please specify the mandatory parameter access level. SNMP_MISSING_COMMUNITY_STRING_NAME The community string name is missing.
List of Error Messages TABLE 109 A List of error messages Error String Message SNMP_PRIVACY_PASSWORD_LEN_OUT_OF_RANGE The specified parameter privacy password "%s" with length %d for the user "%s" is out of range. Please specify a valid privacy password in the range of %d to %d characters. SNMP_SECURITY_LEVEL_NOT_SUPPORTED The parameter security level is not supported with the security model "%s" for the group "%s". Please do not specify the security level parameter.
A List of Error Messages TABLE 109 798 List of error messages Error String Message SSL_CERT_FILE_ALREADY_EXIST The specified certificate file "%s" already exists. Please specify a unique certificate file name. SSL_CERT_FILE_DELETE_FAIL Unable to delete the specified certificate file "%s". Please check that the certificate file is valid and not in use. SSL_CERT_FILE_IN_USE The specified certificate file "%s" is being used by one or more SSL profiles.
List of Error Messages TABLE 109 A List of error messages Error String Message SSL_CRL_RECORD_NOT_FOUND The specified CRL record "%s" is not found. Please specify a CRL record that already exists. SSL_CRL_RECORD_REFRESH_INTERVAL_OUT_OF_R ANGE The specified CRL refresh interval is out of range. Please specify a CRL refresh interval value in the range of 0 to 0x7FFFFFFF "%s". SSL_CRL_RECORDS_MAX_REACHED Cannot create a CRL record "%s" as the maximum number of CRL records (%d) is reached.
A List of Error Messages TABLE 109 800 List of error messages Error String Message SSL_FLASH_ERASE_IN_PROGRESS An SSL flash erase is in progress. Please wait for few seconds and try again. SSL_HARDWARE_NOT_DETECED SSL cannot be configured as the SSL hardware is not detected on the system. Ensure that SSL hardware is available on the system SSL_INVALID_CERT_FILE_CONTENT The specified certificate file content is invalid. Please specify valid certificate file content.
List of Error Messages TABLE 109 A List of error messages Error String Message SSL_KEY_FILE_NOT_FOUND The specified key file "%s" is not found. Please specify an existing key file. SSL_KEY_FILE_OPEN_ERR An error was encountered while opening the key file "%s". Please verify whether the key file can be stored. SSL_KEY_FILE_UPLOAD_FAIL An error was encountered while uploading the key file "%s". Please verify whether the specified key file contents and passphrase are valid.
A List of Error Messages TABLE 109 802 List of error messages Error String Message SSL_MISSING_BUFFER_OPTIMIZATION_MODE The mandatory parameter SSL buffer optimization mode is missing. Please specify the mandatory parameter SSL buffer optimization mode. SSL_MISSING_CERT_GENERATION_PARAM The mandatory parameter "%s" is missing. Please specify the mandatory parameter for certificate generation. SSL_MISSING_CERT_NAME The name of a certificate is missing. Please specify a valid certificate name.
List of Error Messages TABLE 109 A List of error messages Error String Message SSL_PROFILE_ALREADY_EXISTS The specified SSL profile "%s" already exists. Please specify a unique SSL profile name. SSL_PROFILE_BINDING_CLIENT_PROFILE_NEEDED The mandatory parameter client profile is missing. Please specify a valid client profile parameter for SSL profile binding. SSL_PROFILE_BINDING_CLIENT_PROFILE_NOT_FOU ND The specified client SSL profile "%s" not found.
A List of Error Messages TABLE 109 804 List of error messages Error String Message SSL_PROFILE_KEY_AND_CERT_MISMATCH The specified key "%s" and certificate "%s" in SSL profile "%s" mismatch. Please delete the specified key and re-add the correct key and certificate. SSL_PROFILE_KEY_FILE_ADDITION_FAIL Failed to add the specified key file "%s" to the SSL profile "%s ". Please specify a valid key file. SSL_PROFILE_KEY_FILE_ALREADY_EXISTS A key file already exists for the specified SSL profile "%s".
List of Error Messages TABLE 109 A List of error messages Error String Message SSL_TCP_PROFILE_INFO_NEEDED The TCP profile information is missing. Please specify a valid TCP profile. SSL_TCP_PROFILE_MSS_OUT_OF_RANGE The specified TCP MSS %u is out of range. Please specify value in the range of 0 to %u for the TCP profile "%s". SSL_TCP_PROFILE_NOT_FOUND The specified TCP profile "%s" was not found. Please specify a TCP profile which already exists.
A List of Error Messages TABLE 109 List of error messages Error String Message SYN_PROXY_MISSING_GLOBAL_CONFIG The parameters for SYN proxy global configuration are missing. Please specify parameters for SYN proxy global configuration. SYN_PROXY_MISSING_GLOBAL_CONFIG_ATTRIBUTE The attributes for clearing SYN proxy global configuration parameters are missing. Please specify at least one attribute of the SYN proxy global configuration parameters.
List of Error Messages TABLE 109 A List of error messages Error String Message SYS_DIRECTORY_CREATION_MAX_LEVEL_SUPPORTE D The specified directory "%s" cannot be created. The system only supports a maximum of %d levels of directory. SYS_DIRECTORY_CREATION_NOT_ALLOWED The specified directory "%s" cannot be created. You cannot create a directory under "%s" . SYS_DIRECTORY_DELETION_ERROR An error occurred while deleting the directory "%s"Please specify an existing and valid directory.
A List of Error Messages TABLE 109 808 List of error messages Error String Message SYS_HA_NOT_CONFIGURED The Server HA is not configured. Please configure HA for retrieving Active/Standby transitions information. SYS_HOST_NAME_OR_IP_MISSING The mandatory parameters "hostName" or "hostIP" are missing. Please specify a valid hostName or hostIP address. SYS_INT_PORT_STRING_INVALID The specified portString "%s" is invalid. Please specify a valid value for portString.
List of Error Messages TABLE 109 A List of error messages Error String Message SYS_INVALID_TEMPERATURE_CONFIG_CARDTYPE_P ARAM The specified module temperature cardType parameter is invalid. Please specify a valid module temperature cardType parameter LINECARD or MANAGEMENT. SYS_INVALID_TIME_PARAM The specified time parameter format is invalid. Please specify a valid value in the format (hh:mm:ss) SYS_INVALID_TOKEN The specified token ID %d is invalid. Please specify a valid token ID.
A List of Error Messages TABLE 109 810 List of error messages Error String Message SYS_MISSING_TEMPERATURE_CONFIG_TEMPERATU RE_PARAM The module temperature parameter is missing. Please specify a valid temperature value parameter. SYS_MISSING_TEMPERATURE_PARAM The module temperature(Degree Centigrade) value is missing. Please specify a valid value. SYS_MODULE_TEMPERATURE_OUT_OF_RANGE The specified module temperature(Degree Centigrade) value %d is out of range.
List of Error Messages TABLE 109 A List of error messages Error String Message SYS_USER_EXISTS The specified user profile "%s" already exists. Please specify a new user profile. SYS_USER_LOCKED_OUT The user has been locked out. Please try again after 30 minutes. SYS_VLAN_ID_OUT_OF_RANGE The specified VLAN ID is out of range. Please specify a valid value in the range of %d to %d. USER_PROFILE_UPDATE_FAILED_FROM_TENANT The update user profile from tenant operation failed.
A 812 List of Error Messages Brocade Virtual ADX XML API Programmer’s Guide 53-1003248-01
Appendix B API Examples In this appendix • “Example: Adding and binding a real server and a VIP” • “Example: Unbinding a real server from a VIP” • “Example - Provisioning real and virtual servers” • “Example - Binding a real server port to a virtual server port and saving to the startup configuration file” Example: Adding and binding a real server and a VIP • “Perl example” • “Java Example” • “C# example” Perl example #!/usr/bin/perl -w # Path to PERL Interpreter - Replace with correct path if differen
B Example: Adding and binding a real server and a VIP if (ref($http_object) eq "HTTP::Request") { # We have a Request object. We need to make it pretty for log readability my $content = $http_object->content; my $twig = XML::Twig->new(pretty_print=>'indented'); $twig->parse($content); $content = $twig->sprint; print LOG "\nSOAP Request\n------------\n" . $content . "\n\n"; } elsif (ref($http_object) eq "HTTP::Response") { # We have a Response object. print LOG "SOAP Response\n-------------\n" .
Example: Adding and binding a real server and a VIP B my $context = ""; # When passed through command line options, overrides the context used in the script # Get the command arguments and check if any of the parameters must be overridden by user specified values # Command Line Usage: # perl Usecase1.
B Example: Adding and binding a real server and a VIP ############################## # Build the SOAP Request Message with the XML Context and Header my @slbsoap_body = (name('configurationInfo')->value([ name('RealServerConfigurationSequence')->value([ name('description')->value('Real Server 001'), name('realServer')->value([ name('IP')->value('100.10.1.
Example: Adding and binding a real server and a VIP B # Get the elapsed time (Time taken for the SOAP Response to arrive after the request was sent) $response_time = &get_elapsed_time($request_time); # Write the Time taken to the Test Case LOG File print LOG "SOAP Response Time for Creating the Real Server Port: $response_time\n"; print LOG "===== Operation Complete =====\n\n"; #### Create a Virtual Server #### ################################# # Build the SOAP Request Message with the XML Context and Hea
B Example: Adding and binding a real server and a VIP # Make the SOAP Call and store the XML result in a variable # Response is stored in "$xml_result" as XML. Further action can be taken based on the Response Content.
Example: Adding and binding a real server and a VIP B # Note the time before making a SOAP Request $request_time = &start_timer; # Make the SOAP Call and store the XML result in a variable # Response is stored in "$xml_result" as XML. Further action can be taken based on the Response Content.
B Example: Adding and binding a real server and a VIP import com.brocade.slb.connector.webservicesapi.CreateVirtualServerWithConfiguration_dat atype; import com.brocade.slb.connector.webservicesapi.GetVersion_datatype; import com.brocade.slb.connector.webservicesapi.L4Port; import com.brocade.slb.connector.webservicesapi.RequestHeader_datatype; import com.brocade.slb.connector.webservicesapi.RuntimeFault_datatype; import com.brocade.slb.connector.webservicesapi.Server; import com.brocade.slb.connector.
Example: Adding and binding a real server and a VIP B stub._setProperty(Stub.PASSWORD_PROPERTY, password); stub._setProperty(MessageContext.HTTP_TRANSPORT_VERSION, HTTPConstants.HEADER_PROTOCOL_V11); System.out.
B Example: Adding and binding a real server and a VIP * * @param realServer * @return * @throws RuntimeFault_datatype * @throws RemoteException */ public ServerPort createRealServerPort(Server realServer) throws RuntimeFault_datatype, RemoteException { L4Port port = new L4Port(realServerPort, null); ServerPort realPort = new ServerPort(realServer, port); CreateRealServerPort_datatype arg0 = new CreateRealServerPort_datatype(realPort); RequestHeader_datatype arg1 = new RequestHeader_datatype(); slbService.
Example: Adding and binding a real server and a VIP B System.out.
B Example: Adding and binding a real server and a VIP // Bind real server port to virtual server port bindTest.bind(virtualPort, realPort); // Save Configuration bindTest.saveConfiguration(); } } C# example using System; using System.Collections.Generic; using System.Text; using ConfigureSLB.slb_service; using ConfigureSLB.sys_service; using System.Net; using System.IO; using System.Management.
Example: Adding and binding a real server and a VIP B ///////////////////////////////////////////////////////////////////////////// protected override WebRequest GetWebRequest(Uri uri) { // call the base class to get the underlying WebRequest object HttpWebRequest req = (HttpWebRequest)base.GetWebRequest(uri); if (null != this.m_HeaderName) { // set the header req.Headers.Add(this.m_HeaderName, this.
B Example: Adding and binding a real server and a VIP protected override WebRequest GetWebRequest(Uri uri) { // call the base class to get the underlying WebRequest object HttpWebRequest req = (HttpWebRequest)base.GetWebRequest(uri); if (null != this.m_HeaderName) { // set the header req.Headers.Add(this.m_HeaderName, this.
Example: Adding and binding a real server and a VIP B ///////////////////////////////////////////////////////////////////////////// public static Utils GetUtilsInstance() { if (m_Utils == null) m_Utils = new Utils(); return m_Utils; } ///////////////////////////////////////////////////////////////////////////// // Name: GetSLBObject // // Description: Returns the SlbService class object. Creates the new object if // this object is null.
B Example: Adding and binding a real server and a VIP { //Check the given device name is valid if (IsValidIP(DeviceName) == false) { throw new Exception("Invalid IP/Device Name. Please enter a valid Device Name.
Example: Adding and binding a real server and a VIP B ///////////////////////////////////////////////////////////////////////////// public bool OpenRCloseLog(bool bOpen) { string sLogPath = ""; //get the full location of the assembly with DaoTests in it string sfullPath = System.Reflection.Assembly.GetAssembly(typeof(Utils)).Location; //get the folder that's in string sDirectory = Path.GetDirectoryName(sfullPath); sLogPath = String.Format("{0}\\ConfigureSLB.
B Example: Adding and binding a real server and a VIP //Update the underlying file. m_StreamWriter.Flush(); } } ///////////////////////////////////////////////////////////////////////////// // Name: Configure-SLB cmdlet // // Description: This cmdlet will be called when the user executes Configure-SLB // in powershell after loading the configureslb.dll.
Example: Adding and binding a real server and a VIP B ///////////////////////////////////////////////////////////////////////////// // Name: ConfigureLoadBalancing // // Description: This function create the virtual server and real server and binds the same // as per the input given by the user // // Parameters: // ///////////////////////////////////////////////////////////////////////////// public void ConfigureLoadBalancing() { string sSaveConfig = null; //Get the utils class object Utils objUtils = Con
B Example: Adding and binding a real server and a VIP sVIPAddress = Console.ReadLine(); WriteObject("\r\nEnter the VIP Port:"); sVIPPort = Console.ReadLine(); ConfigureSLB.slb_service.Server objVIPSvr = new ConfigureSLB.slb_service.Server(); objVIPSvr.IP = sVIPAddress; objVIPSvr.Name = sVIPName; L4Port objL4Prt = new ConfigureSLB.slb_service.L4Port(); objL4Prt.NameOrNumber = sVIPPort; ServerPort objVIPSvrPort = new ConfigureSLB.slb_service.ServerPort(); objVIPSvrPort.srvr = objVIPSvr; objVIPSvrPort.
Example: Adding and binding a real server and a VIP B WriteObject("\r\nRealServer has been created successfully\r\n"); //Display the configuration details of the created real server DisplayRealServerConfiguration(ref objRealSvr); return objRealServerPort; } ///////////////////////////////////////////////////////////////////////////// // Name: DisplayVirtualServerConfiguration // // Description: This function displays the configuration information of the given // virtual server // // Parameters: Server - s
B Example - Provisioning real and virtual servers RealServerConfiguration objRealConfig = null; ConfigureSLB.Utils.GetUtilsInstance().GetSLBObject().getRealServerConfiguration(o bjRealSvr, out objRealConfig); WriteObject("Real Server Configuration"); WriteObject("-------------------------\r\n"); WriteObject("Name\t\t\t: " + objRealConfig.realServer.Name); WriteObject("IP\t\t\t: " + objRealConfig.realServer.IP); WriteObject("Admin State\t\t: " + objRealConfig.
Example - Provisioning real and virtual servers B // // Description: This class is being derived from AdcSysInfo class which is the // autogenerated class after adding sys_service.
B Example - Provisioning real and virtual servers // // Parameters: // ///////////////////////////////////////////////////////////////////////////// public class SlbService : AdcSlb { private String m_HeaderName; private String m_HeaderValue; ///////////////////////////////////////////////////////////////////////////// // Name: GetWebRequest // // Description: Called by the SOAP client class library, GetWebRequest will // add to the underlying request used by the SOAP client when // making the web method
Example - Provisioning real and virtual servers B // ///////////////////////////////////////////////////////////////////////////// public class Utils { private Utils() { } ~Utils() { } private static Utils m_Utils = null; public SlbService m_SLBService = null; public SysService m_SYSService = null; private static StreamWriter m_StreamWriter = null; private static FileStream m_FileStream = null; ///////////////////////////////////////////////////////////////////////////// // Name: GetUtilsInstance // // De
B Example - Provisioning real and virtual servers if (m_SYSService == null) m_SYSService = new SysService(); return m_SYSService; } ///////////////////////////////////////////////////////////////////////////// // Name: OpenConnection // // Description: This function forms the URL based on the given DeviceName // and sets the required parameters to the WSDL SLB Service object // inorder to communicate witht the ADX Box.
Example - Provisioning real and virtual servers B // // Parameters: addr - the ip address which needs to be validated. // // Return Value: Success if true. ///////////////////////////////////////////////////////////////////////////// public bool IsValidIP(string addr) { System.Net.IPAddress ipAddress = null; bool isValidIp = System.Net.IPAddress.
B Example - Provisioning real and virtual servers ///////////////////////////////////////////////////////////////////////////// // Name: WL // // Description: This function to write the log message to the file. // // Parameters: sLogMessage - the log message to be written to the log file.
Example - Provisioning real and virtual servers B //Open the log file to write objUtils.OpenRCloseLog(true); objUtils.WL("Provisioning SLB START", ""); objUtils.WL("Establishing connection with ", DeviceName); //Create the connection object and set the username and password associated to it objUtils.OpenConnection(ref DeviceName, ref UserName, ref Password); //Configure the virtual server and real server ConfigureLoadBalancing(); objUtils.WL("Provisioning SLB END", ""); //Close the log file objUtils.
B Example - Provisioning real and virtual servers objUtils.GetSYSObject().
Example - Provisioning real and virtual servers B //Get the util class object Utils objUtils = Provisioning.Utils.GetUtilsInstance(); ServerPort[] objRealServerPorts = new slb_service.ServerPort[5]; RealServerConfiguration[] objRealServerConfig = new RealServerConfiguration[1]; WriteObject("\r\nEnter the common parameters for real server(s)"); string sRealServerName, sRealServerIP, sRealServerPort, sTemp; WriteObject("\r\nEnter the common port for all real server(s):"); sRealServerPort = Console.
B Example - Provisioning real and virtual servers objUtils.GetSLBObject().
Example - Provisioning real and virtual servers B objRealSvr) { //Retrieves the Virtual Server configuration RealServerConfiguration objRealConfig = null; Provisioning.Utils.GetUtilsInstance().GetSLBObject().getRealServerConfiguration(o bjRealSvr, out objRealConfig); WriteObject("Real Server Configuration"); WriteObject("-------------------------\r\n"); WriteObject("Name\t\t\t: " + objRealConfig.realServer.Name); WriteObject("IP\t\t\t: " + objRealConfig.realServer.
B Example - Provisioning real and virtual servers sRealServer = String.Format("{0} \t{1}", objRealServers[nIter].IP, objRealServers[nIter].Name); WriteObject(sRealServer); } } public void DisableRealServer() { WriteObject("\r\nDo you want to disable the real server(y/n):"); string sTemp = null; sTemp = Console.ReadLine(); if (sTemp == "N" || sTemp == "n") { return; } //Gets the utils object Utils objUtils = Provisioning.Utils.
Example - Binding a real server port to a virtual server port and saving to the startup configuration file B objUtils.GetSLBObject().deleteRealServer(objServer); WriteObject("\r\nDeletion of real server has been completed successfully.
B Example - Binding a real server port to a virtual server port and saving to the startup configuration file ############################## # Build the SOAP Request Message with the XML Context and Header my @slbsoap_body = (name('configurationInfo')->value([ name('RealServerConfigurationSequence')->value([ name('description')->value('Real Server 001'), name('realServer')->value([ name('IP')->value('100.10.1.
Example: Unbinding a real server from a VIP B print "\n $xml_result \n"; #### Write Configuration in Memory to the Startup Config File #### ################################################################## $xml_result = $syssoap->call('urn:writeConfig'); undef $slbsoap; undef $syssoap; Example: Unbinding a real server from a VIP “Perl example” “Java example” “C# example” Perl example #!/usr/bin/perl -w # Path to PERL Interpreter - Replace with correct path if different from the one used above # Open th
B Example: Unbinding a real server from a VIP print LOG "SOAP Response\n-------------\n" . $http_object->content . "\n"; } }]; # Function to record the time at the start of a SOAP Request.
Example: Unbinding a real server from a VIP B # Use the stored values if they are not meant to be overridden # Values can be hard-coded here too, instead of passing in CLI $dut = "10.37.53.
B Example: Unbinding a real server from a VIP ])); print LOG "Unbinding the Real Server Port from the Virtual Server\n"; # Note the time before making a SOAP Request $request_time = &start_timer; # Make the SOAP Call and store the XML result in a variable # Response is stored in "$xml_result" as XML. Further action can be taken based on the Response Content.
Example: Unbinding a real server from a VIP B # Make the SOAP Call and store the XML result in a variable # Response is stored in "$xml_result" as XML. Further action can be taken based on the Response Content.
B Example: Unbinding a real server from a VIP import com.brocade.slb.connector.webservicesapi.RequestHeader_datatype; import com.brocade.slb.connector.webservicesapi.RuntimeFault_datatype; import com.brocade.slb.connector.webservicesapi.Server; import com.brocade.slb.connector.webservicesapi.ServerPort; import com.brocade.slb.connector.webservicesapi.UnbindRealServerPortFromVipPort_datatype ; import com.brocade.slb.connector.webservicesapi.VirtualServerConfiguration; import com.brocade.slb.connector.
Example: Unbinding a real server from a VIP B HTTPConstants.HEADER_PROTOCOL_V11); System.out.println("Sys service successfully created"); } /** * Initializes SLB Service * * @throws MalformedURLException * @throws ServiceException */ public void initSlbService() throws MalformedURLException, ServiceException { slbLocator = new AdcSlbLocator(); URL url = new URL(protocol, hostIP, webServicePort, "/WS/SLB"); slbService = slbLocator.getAdcSlbSOAP(url); System.out.
B Example: Unbinding a real server from a VIP * @return * @throws RuntimeFault_datatype * @throws RemoteException */ public ServerPort createRealServerPort(Server realServer) throws RuntimeFault_datatype, RemoteException { L4Port port = new L4Port(realServerPort, null); ServerPort realPort = new ServerPort(realServer, port); CreateRealServerPort_datatype arg0 = new CreateRealServerPort_datatype( realPort); RequestHeader_datatype arg1 = new RequestHeader_datatype(); slbService.
Example: Unbinding a real server from a VIP B System.out.
B Example: Unbinding a real server from a VIP /** * Delete Real Server * * @throws RuntimeFault_datatype * @throws RemoteException */ public void deleteRealServer(Server realServer) throws RuntimeFault_datatype, RemoteException { // slbService.deleteRealServer(realServer); DeleteRealServer_datatype arg0 = new DeleteRealServer_datatype( realServer); RequestHeader_datatype arg1 = new RequestHeader_datatype(); slbService.deleteRealServer(arg0, arg1); System.out.
Example: Unbinding a real server from a VIP B ServerPort virtualPort = bindTest .createVirtualServerPort(virtualServer); // Bind real server port to virtual server port bindTest.bind(virtualPort, realPort); // Save Configuration bindTest.saveConfiguration(); // Delete Real Server port bindTest.unBindRealServerport(virtualPort, realPort); // Delete Real Server bindTest.deleteRealServer(realServer); // Delete Virtual Server bindTest.deleteVirtualServer(virtualServer); // Save Configuration bindTest.
B Example: Unbinding a real server from a VIP // // Description: Called by the SOAP client class library, GetWebRequest will // add to the underlying request used by the SOAP client when // making the web method call // // Parameters: Uri - the webservice url // ///////////////////////////////////////////////////////////////////////////// protected override WebRequest GetWebRequest(Uri uri) { // call the base class to get the underlying WebRequest object HttpWebRequest req = (HttpWebRequest)base.
Example: Unbinding a real server from a VIP B // add to the underlying request used by the SOAP client when // making the web method call // // Parameters: Uri - the webservice url // ///////////////////////////////////////////////////////////////////////////// protected override WebRequest GetWebRequest(Uri uri) { // call the base class to get the underlying WebRequest object HttpWebRequest req = (HttpWebRequest)base.GetWebRequest(uri); if (null != this.m_HeaderName) { // set the header req.Headers.
B Example: Unbinding a real server from a VIP // // Description: Returns the Utils class object. Creates the object if this // object is not created previously.
Example: Unbinding a real server from a VIP B // Password - The password associated with the ADX Box // ///////////////////////////////////////////////////////////////////////////// public void OpenConnection(ref string DeviceName, ref string UserName, ref string Password) { //Check the given device name is valid if (IsValidIP(DeviceName) == false) { throw new Exception("Invalid IP/Device Name. Please enter a valid Device Name.
B Example: Unbinding a real server from a VIP // Name: OpenRCloseLog // // Description: This function will be called to open or close the log file. // // Parameters: bOpen - true/false // ///////////////////////////////////////////////////////////////////////////// public bool OpenRCloseLog(bool bOpen) { string sLogPath = ""; //get the full location of the assembly with DaoTests in it string sfullPath = System.Reflection.Assembly.GetAssembly(typeof(Utils)).
Example: Unbinding a real server from a VIP B if (false == OpenRCloseLog(true)) return; } m_StreamWriter.Write("\r\n"); m_StreamWriter.WriteLine("{0}: --{1} {2}--", DateTime.Now, sLogMessage, sLogMessage1); //Update the underlying file. m_StreamWriter.Flush(); } } ///////////////////////////////////////////////////////////////////////////// // Name: Unbind-RS cmdlet // // Description: This cmdlet will be called when the user executes Unbind-RS // in powershell after loading the unbinding.dll.
B Example: Unbinding a real server from a VIP //Close the log file objUtils.OpenRCloseLog(false); } catch (Exception ex) { objUtils.WL("EXCEPTION Raised in UnbindRSfromVIP", ex.Message); //Close the log file objUtils.OpenRCloseLog(false); WriteObject(ex.Message); } } ///////////////////////////////////////////////////////////////////////////// // Name: ShowAllVirtualServers // // Description: Displays all the virtual servers present in the given ADX BOX.
Example: Unbinding a real server from a VIP B // virtual server // // Parameters: // ///////////////////////////////////////////////////////////////////////////// public ServerPort ShowAllVirtualServerPorts() { //Get the utils class object Utils objUtils = Unbinding.Utils.GetUtilsInstance(); string sVIPName, sVIPAddress, sVIPPort; WriteObject("\r\nEnter the VIP Name:"); sVIPName = Console.ReadLine(); WriteObject("\r\nEnter the VIP Address:"); sVIPAddress = Console.ReadLine(); slb_service.
B Example: Unbinding a real server from a VIP WriteObject("\r\nUnbinding operation successfully completed.\r\n"); return 1; } slb_service.ServerPort[] realServerPortArray; slb_service.ServerPort realServerPort = null; string sRealServer, sRealServerIP, sPort; objUtils.GetSLBObject().getAllRealServerPortsOnVirtualServerPort(objVirtualServer Port, 0, true, 100, true, out realServerPortArray); if (realServerPortArray.
