mmolloy/nscertkeycreate
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

initial

Browse Source
This commit is contained in:
deamonkai
2026-01-23 12:11:21 -06:00
commit fc94008530
16494 changed files with 2974672 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
docs/Reference Docs/mas_nitro-rest_14.1-60.54/configuration.html Normal file
View File

@@ -0,0 +1,40 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<title>NetScaler Console NITRO API Documentation - Error Messages</title>
<link href="rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="index.css" rel="stylesheet" type="text/css" />
</head>
<body class="ns_body">
<p class="ns_wp_header">Configuration</p>
<p><b>Analytics</b></p>
<p>Provides easy and scalable way to look in to the various insights of the NetScaler's data to describe, predict, and improve application's performance.</p>
<p><b>Applications</b></p>
<p>Strengthens the application-centric approach to help you address various application delivery challenges.</p>
<p><b>Configuration Audit</b></p>
<p>Monitors configuration changes across managed ADCs, troubleshoot configuration errors, and recover unsaved configurations after a sudden system shutdown.</p>
<p><b>Configuration Jobs</b></p>
<p>Helps in proper replication of configuration changes, system upgrades, and other maintenance activities across multiple ADCs in the network.</p>
<p><b>Device SSL Certificates</b></p>
<p>Streamlines every aspect of certificate management.</p>
<p><b>Events</b></p>
<p>Configuration APIs for events.</p>
<p><b>Instances</b></p>
<p>Configuration APIs to manage instances on NetScaler Console.</p>
<p><b>Licenses</b></p>
<p>Configuration APIs to manage licenses.</p>
<p><b>Network Functions</b></p>
<p>Configuration APIs to monitor the state of the entities configured on NetScalers.</p>
<p><b>Network Reporting</b></p>
<p>Network Reporting APIs can be used to optimize resource usage.</p>
<p><b>Orchestration</b></p>
<p>Configuration APIs to enable integration of NetScaler products with OpenStack platform.</p>
<p><b>Stylebooks</b></p>
<p>Configuration APIs for StyleBooks which simplify the task of managing complex ADC configurations for your applications.</p>
<p><b>System</b></p>
<p>Configuration APIs to configure the system settings of NetScaler Console.</p>
<p><b>Tools</b></p>
<p>Configuration APIs for tools to migrate your ADC devices from other vendors to NetScaler.</p>
</body>
</html>

907
docs/Reference Docs/mas_nitro-rest_14.1-60.54/doc/errorlisting.html Normal file
View File

@@ -0,0 +1,907 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US" xml:lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<title>NetScaler Console NITRO API Documentation - Error Messages</title>
<link href="../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../index.css" rel="stylesheet" type="text/css" />
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
</head>
<body class="ns_body">
<div class="content"><table cellpadding="0" cellspacing="0"><tr class="ns_wp_header"><td>Error Messages</td></tr><tr><td><br></td></tr><tr><td><tr><td><div><b>ERRORS</b></div></td></tr><tr><td><br></td></tr><tr><td><table class="ns_st_body" cellspacing="0">
<thead>
<th>Error Code</th>
<th>Error Code</th>
<th>Error Message</th>
</thead>
<tbody>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_PORT_SETTING_FAILED</td>
<td class="ns_st_body_alternate_row_color">15013</td>
<td class="ns_st_body_alternate_row_color">Failed to modify port settings</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_DISK_LOCATE_FAILED</td>
<td class="ns_st_body_alternate_row_color">20201</td>
<td class="ns_st_body_alternate_row_color">Failed to locate disk</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_SERVICE_UNAVAILABLE</td>
<td class="ns_st_body_alternate_row_color">60010</td>
<td class="ns_st_body_alternate_row_color">Service is not available</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_XAPI_GET_VLAN</td>
<td class="ns_st_body_alternate_row_color">400017</td>
<td class="ns_st_body_alternate_row_color">Failed to get VLAN</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_INVALID_PORT</td>
<td class="ns_st_body_alternate_row_color">15010</td>
<td class="ns_st_body_alternate_row_color">Invalid port</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_MANDATORY_PARAM_MISSING</td>
<td class="ns_st_body_alternate_row_color">10006</td>
<td class="ns_st_body_alternate_row_color">Mandatory parameter missing</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_CONFIG_INPROGRESS</td>
<td class="ns_st_body_alternate_row_color">11001</td>
<td class="ns_st_body_alternate_row_color">Configuration in progress</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_DEFAULT_ENTITY</td>
<td class="ns_st_body_alternate_row_color">11005</td>
<td class="ns_st_body_alternate_row_color">Default entity can not be modified/deleted</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_APPLY_LICENSES</td>
<td class="ns_st_body_alternate_row_color">11004</td>
<td class="ns_st_body_alternate_row_color">Failed to apply licenses</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_GUESTVM_BACKUP_CONFIG</td>
<td class="ns_st_body_alternate_row_color">40005</td>
<td class="ns_st_body_alternate_row_color">Failed to backup configuration</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_UNLOCK_INVENTORY</td>
<td class="ns_st_body_alternate_row_color">50010</td>
<td class="ns_st_body_alternate_row_color">Failed to unlock inventory</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_MISSING_ACTION</td>
<td class="ns_st_body_alternate_row_color">10004</td>
<td class="ns_st_body_alternate_row_color">Action not specified for this request</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_SET_STATUS_CALLHOME</td>
<td class="ns_st_body_alternate_row_color">20052</td>
<td class="ns_st_body_alternate_row_color">Failed to enable/disable CallHome in NetScaler Instance</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_GUESTVM_DOWNGRADE</td>
<td class="ns_st_body_alternate_row_color">400015</td>
<td class="ns_st_body_alternate_row_color">Failed to downgrade</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_GET_CONFIG_DIFF</td>
<td class="ns_st_body_alternate_row_color">20047</td>
<td class="ns_st_body_alternate_row_color">Failed to get configuration diff from NetScaler Instance</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_ADD_SET_NSIP</td>
<td class="ns_st_body_alternate_row_color">20011</td>
<td class="ns_st_body_alternate_row_color">Failed to add/set nsip</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_DOCKERAPI_CONTAINER_CREATE</td>
<td class="ns_st_body_alternate_row_color">50023</td>
<td class="ns_st_body_alternate_row_color">Failed to create docker container</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_CHANGE_PASSWORD_SVM</td>
<td class="ns_st_body_alternate_row_color">11000</td>
<td class="ns_st_body_alternate_row_color">Fail to change password</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_ADD_CHANNEL_PROPERTIES</td>
<td class="ns_st_body_alternate_row_color">40009</td>
<td class="ns_st_body_alternate_row_color">Error while adding channel to VM</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_TIMEZONE_SET</td>
<td class="ns_st_body_alternate_row_color">50014</td>
<td class="ns_st_body_alternate_row_color">Failed to set timezone</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_EXPORT_REPORT</td>
<td class="ns_st_body_alternate_row_color">50008</td>
<td class="ns_st_body_alternate_row_color">Failed to Export report</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_XAPI_GET_TASK</td>
<td class="ns_st_body_alternate_row_color">15006</td>
<td class="ns_st_body_alternate_row_color">Failed to get Task</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_SNMP_CONFIG</td>
<td class="ns_st_body_alternate_row_color">20045</td>
<td class="ns_st_body_alternate_row_color">Failed to do SNMP configuration</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NTP_SERVER_ADD</td>
<td class="ns_st_body_alternate_row_color">50011</td>
<td class="ns_st_body_alternate_row_color">Failed to add NTP Server</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_XAPI_GET_CPU</td>
<td class="ns_st_body_alternate_row_color">15002</td>
<td class="ns_st_body_alternate_row_color">Failed to get CPU</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_GET_HANODE</td>
<td class="ns_st_body_alternate_row_color">20019</td>
<td class="ns_st_body_alternate_row_color">Failed to get ha node</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_SFTP_UPLOAD</td>
<td class="ns_st_body_alternate_row_color">16002</td>
<td class="ns_st_body_alternate_row_color">SFTP failed to upload</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_USER_LOCKED</td>
<td class="ns_st_body_alternate_row_color">10021</td>
<td class="ns_st_body_alternate_row_color">Account Locked for user</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_GET_NSSSLCERT</td>
<td class="ns_st_body_alternate_row_color">20040</td>
<td class="ns_st_body_alternate_row_color">Failed to get SSL certificates from NetScaler Instance</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_RESOURCE_CONVERSION</td>
<td class="ns_st_body_alternate_row_color">10002</td>
<td class="ns_st_body_alternate_row_color">Resource conversion failed</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_ADD_DOMAINID</td>
<td class="ns_st_body_alternate_row_color">500032</td>
<td class="ns_st_body_alternate_row_color">Failed to add observation domain ID</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_XAPI_DELETE_NETWORK</td>
<td class="ns_st_body_alternate_row_color">150017</td>
<td class="ns_st_body_alternate_row_color">Failed to delete Network</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_ALREADY_EXISTS</td>
<td class="ns_st_body_alternate_row_color">10010</td>
<td class="ns_st_body_alternate_row_color">Already Exists</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_SVM_REBOOT</td>
<td class="ns_st_body_alternate_row_color">20000</td>
<td class="ns_st_body_alternate_row_color">Failed to reboot Management Service</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NO_VSERVER_LICENSE</td>
<td class="ns_st_body_alternate_row_color">60008</td>
<td class="ns_st_body_alternate_row_color">Selected Vserver Marked as UnLicensed</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_ADD_SET_SYS_USER</td>
<td class="ns_st_body_alternate_row_color">20012</td>
<td class="ns_st_body_alternate_row_color">Failed to add/set system user</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_SET_CALLHOME</td>
<td class="ns_st_body_alternate_row_color">20051</td>
<td class="ns_st_body_alternate_row_color">Failed to configure CallHome in NetScaler Instance</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_ADD_KEYMANAGERPROXY</td>
<td class="ns_st_body_alternate_row_color">20056</td>
<td class="ns_st_body_alternate_row_color">Failed to add keymanager proxy</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_PORT_RESTORE_DEFAULT_FAILED</td>
<td class="ns_st_body_alternate_row_color">15012</td>
<td class="ns_st_body_alternate_row_color">Failed to restore defaults for port</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_XAPI_GET_HOST</td>
<td class="ns_st_body_alternate_row_color">15003</td>
<td class="ns_st_body_alternate_row_color">Failed to get Host</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_GUESTVM_UPGRADE_TOOLS</td>
<td class="ns_st_body_alternate_row_color">40002</td>
<td class="ns_st_body_alternate_row_color">Failed to upgrade sdxtools</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_VALIDATION_FAILED</td>
<td class="ns_st_body_alternate_row_color">10014</td>
<td class="ns_st_body_alternate_row_color">Validation failed</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_MODIFICATION_INPROGRESS</td>
<td class="ns_st_body_alternate_row_color">11009</td>
<td class="ns_st_body_alternate_row_color">Modification in progress</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_CREATE_BOND</td>
<td class="ns_st_body_alternate_row_color">40011</td>
<td class="ns_st_body_alternate_row_color">Error while creating bond on XenServer</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_BIND_UNBIND_CHANNEL_PROPERTIES</td>
<td class="ns_st_body_alternate_row_color">40010</td>
<td class="ns_st_body_alternate_row_color">Error while doing bind-unbind for a channel in VM</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_LOGIN_FAILED</td>
<td class="ns_st_body_alternate_row_color">10001</td>
<td class="ns_st_body_alternate_row_color">Invalid username/password</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_DELETE_BOND</td>
<td class="ns_st_body_alternate_row_color">40012</td>
<td class="ns_st_body_alternate_row_color">Error while deleting bond on XenServer</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_DECIMAL_THROUGHOUT</td>
<td class="ns_st_body_alternate_row_color">11007</td>
<td class="ns_st_body_alternate_row_color">Throughput can not be assigned in decimals</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_ADD_ULFDSERVER</td>
<td class="ns_st_body_alternate_row_color">60006</td>
<td class="ns_st_body_alternate_row_color">Failed to add ULFD server</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_XAPI_GET_VIF</td>
<td class="ns_st_body_alternate_row_color">15007</td>
<td class="ns_st_body_alternate_row_color">Failed to get VIF</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_GET_SAVEDCONFIG</td>
<td class="ns_st_body_alternate_row_color">20004</td>
<td class="ns_st_body_alternate_row_color">Failed to get saved configuration</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_DOCKERAPI_CONTAINER_STOP</td>
<td class="ns_st_body_alternate_row_color">50019</td>
<td class="ns_st_body_alternate_row_color">Failed to stop docker container</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_XAPI_GET_VDI</td>
<td class="ns_st_body_alternate_row_color">150022</td>
<td class="ns_st_body_alternate_row_color">Failed to get VDI</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_DISK_FORMAT_FAILED</td>
<td class="ns_st_body_alternate_row_color">20200</td>
<td class="ns_st_body_alternate_row_color">Failed to format disk</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_XAPI_ADD_VM</td>
<td class="ns_st_body_alternate_row_color">15001</td>
<td class="ns_st_body_alternate_row_color">Failed to add VM</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_SESSION_NOT_EXIST</td>
<td class="ns_st_body_alternate_row_color">444</td>
<td class="ns_st_body_alternate_row_color">Session expired or cancelled. Please login again</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_XAPI_GET_VBD</td>
<td class="ns_st_body_alternate_row_color">150019</td>
<td class="ns_st_body_alternate_row_color">Failed to get VBD</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_GUESTVM_UPGRADE</td>
<td class="ns_st_body_alternate_row_color">40001</td>
<td class="ns_st_body_alternate_row_color">Failed to upgrade</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_ENFORCE_PASSWORD_CHANGE</td>
<td class="ns_st_body_alternate_row_color">60011</td>
<td class="ns_st_body_alternate_row_color">Change nsroot user default password</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_ADD_SET_SYS_CMDPOLICY</td>
<td class="ns_st_body_alternate_row_color">20013</td>
<td class="ns_st_body_alternate_row_color">Failed to add/set system command policy</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_UNKNOWN</td>
<td class="ns_st_body_alternate_row_color">10012</td>
<td class="ns_st_body_alternate_row_color">Request can not be processed</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_GET_NS_CHANNEL_INFO</td>
<td class="ns_st_body_alternate_row_color">40014</td>
<td class="ns_st_body_alternate_row_color">Error while getting channel information from NetScaler</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NOT_SUPPORTED_IN_THIS_VERSION_OF_XEN</td>
<td class="ns_st_body_alternate_row_color">10017</td>
<td class="ns_st_body_alternate_row_color">Feature not supported for this version of XenServer</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_GUESTVM_RE_INIT</td>
<td class="ns_st_body_alternate_row_color">400019</td>
<td class="ns_st_body_alternate_row_color">Failed to reinitialize configuration</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_SET_VSERVER_APPFLOW_CONFIG</td>
<td class="ns_st_body_alternate_row_color">20043</td>
<td class="ns_st_body_alternate_row_color">Failed to set vserver appflow configuration at NetScaler</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_GUESTVM_RESTORE_CONFIG</td>
<td class="ns_st_body_alternate_row_color">40004</td>
<td class="ns_st_body_alternate_row_color">Failed to retore configuration</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_RM_ULFDSERVER</td>
<td class="ns_st_body_alternate_row_color">60007</td>
<td class="ns_st_body_alternate_row_color">Failed to rm ULFD server</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_RM_ROUTE</td>
<td class="ns_st_body_alternate_row_color">20009</td>
<td class="ns_st_body_alternate_row_color">Failed to remove route</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_GET_TLEMETRY_SERVER</td>
<td class="ns_st_body_alternate_row_color">60012</td>
<td class="ns_st_body_alternate_row_color">Failed to get Telemetry Server Info</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_XAPI_TECHSUPPORT</td>
<td class="ns_st_body_alternate_row_color">15009</td>
<td class="ns_st_body_alternate_row_color">Failed to generate Technical support archive</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_DEVICE_NOT_FOUND</td>
<td class="ns_st_body_alternate_row_color">10009</td>
<td class="ns_st_body_alternate_row_color">Device not found</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NO_THROUGHOUT</td>
<td class="ns_st_body_alternate_row_color">11006</td>
<td class="ns_st_body_alternate_row_color">Throughput can not be assigned, Please get the licenses.</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_SET_L2VLANCONFIG</td>
<td class="ns_st_body_alternate_row_color">20044</td>
<td class="ns_st_body_alternate_row_color">Failed to set L2VLAN config</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NOT_FOUND_IN_SELECTED_DURATION</td>
<td class="ns_st_body_alternate_row_color">60009</td>
<td class="ns_st_body_alternate_row_color">No result found in selected duration.</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_PARAM_MISSING</td>
<td class="ns_st_body_alternate_row_color">10007</td>
<td class="ns_st_body_alternate_row_color">Parameter missing</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_GET_STATNS</td>
<td class="ns_st_body_alternate_row_color">20022</td>
<td class="ns_st_body_alternate_row_color">Failed to get statistics of NetScaler Instance</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_VPX_PART_OF_CLUSTER</td>
<td class="ns_st_body_alternate_row_color">30035</td>
<td class="ns_st_body_alternate_row_color">VPX Instance part of Cluster Instance</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NITRO_BLOCKED</td>
<td class="ns_st_body_alternate_row_color">50018</td>
<td class="ns_st_body_alternate_row_color">Nitro access blocked</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NTP_SERVER_MODIFY</td>
<td class="ns_st_body_alternate_row_color">50012</td>
<td class="ns_st_body_alternate_row_color">Failed to modify NTP Server</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_SAVE_CONFIG</td>
<td class="ns_st_body_alternate_row_color">20015</td>
<td class="ns_st_body_alternate_row_color">Failed to save configuration</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_SCP_DOWNLOAD</td>
<td class="ns_st_body_alternate_row_color">16001</td>
<td class="ns_st_body_alternate_row_color">SCP failed to upload</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_XAPI_ADVVMS</td>
<td class="ns_st_body_alternate_row_color">150026</td>
<td class="ns_st_body_alternate_row_color">Failed to Advertise VM UUID</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_XAPI_ADD_VLAN</td>
<td class="ns_st_body_alternate_row_color">400018</td>
<td class="ns_st_body_alternate_row_color">Failed to add VLAN</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_CBSDX_UPGRADE</td>
<td class="ns_st_body_alternate_row_color">50022</td>
<td class="ns_st_body_alternate_row_color">Failed to upgrade CBSDX</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_REMOVE_CLUSTER</td>
<td class="ns_st_body_alternate_row_color">30038</td>
<td class="ns_st_body_alternate_row_color">Failed to remove cluster instance from VPX</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_RM_INTERNAL_ARP</td>
<td class="ns_st_body_alternate_row_color">20054</td>
<td class="ns_st_body_alternate_row_color">Failed to remove internal arp</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_SET_MODE</td>
<td class="ns_st_body_alternate_row_color">20053</td>
<td class="ns_st_body_alternate_row_color">Failed to set mode</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_INSTALL_CERT</td>
<td class="ns_st_body_alternate_row_color">20002</td>
<td class="ns_st_body_alternate_row_color">Failed to install SSL certificates</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_SEND_INVENTORY_MESSAGE</td>
<td class="ns_st_body_alternate_row_color">500004</td>
<td class="ns_st_body_alternate_row_color">Failed to send message to inventory</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_PORT_DETAILS_FAILED</td>
<td class="ns_st_body_alternate_row_color">15011</td>
<td class="ns_st_body_alternate_row_color">Failed to get port details</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_UPGRADE</td>
<td class="ns_st_body_alternate_row_color">20005</td>
<td class="ns_st_body_alternate_row_color">Failed to upgrade NetScaler Instance</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_ADD_DEVICE</td>
<td class="ns_st_body_alternate_row_color">30032</td>
<td class="ns_st_body_alternate_row_color">Failed to Add Device</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_CLU_NOT_SUPPORTED</td>
<td class="ns_st_body_alternate_row_color">30033</td>
<td class="ns_st_body_alternate_row_color">Cluster not supported on VPX</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_ADD_SET_SNMP_COMMUNITY</td>
<td class="ns_st_body_alternate_row_color">20007</td>
<td class="ns_st_body_alternate_row_color">Failed to add/set snmp community</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_INVALID_RESOURCE</td>
<td class="ns_st_body_alternate_row_color">10005</td>
<td class="ns_st_body_alternate_row_color">Invalid Resource</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_GUESTVM_TECH_SUPPORT</td>
<td class="ns_st_body_alternate_row_color">40006</td>
<td class="ns_st_body_alternate_row_color">Error getting techsupport bundle</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_ADM_UPGRADE</td>
<td class="ns_st_body_alternate_row_color">20001</td>
<td class="ns_st_body_alternate_row_color">Failed to upgrade NetScaler Console</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_GET_RUNNINGCONFIG</td>
<td class="ns_st_body_alternate_row_color">20003</td>
<td class="ns_st_body_alternate_row_color">Failed to get running configuration</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_SSH_REQUEST</td>
<td class="ns_st_body_alternate_row_color">16004</td>
<td class="ns_st_body_alternate_row_color">SSH failed to execute request</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_XAPI_VIRTUAL_NMI</td>
<td class="ns_st_body_alternate_row_color">150027</td>
<td class="ns_st_body_alternate_row_color">Failed to generate Crash dump on NetScaler VPX</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_MIGRATION_IN_PROGRESS</td>
<td class="ns_st_body_alternate_row_color">50017</td>
<td class="ns_st_body_alternate_row_color">Migration In Progress</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_MAX_NSVPX</td>
<td class="ns_st_body_alternate_row_color">11002</td>
<td class="ns_st_body_alternate_row_color">Maximum NetScaler Instances reached</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_GET_BOND</td>
<td class="ns_st_body_alternate_row_color">40013</td>
<td class="ns_st_body_alternate_row_color">Error while getting bonds from XenServer</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_SSL_HANDSHAKE_FAILURE</td>
<td class="ns_st_body_alternate_row_color">50015</td>
<td class="ns_st_body_alternate_row_color">SSL Handshake Failed</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NTP_SERVER_DELETE</td>
<td class="ns_st_body_alternate_row_color">50013</td>
<td class="ns_st_body_alternate_row_color">Failed to delete NTP Server</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_ADD_FORWARDINGSESSION</td>
<td class="ns_st_body_alternate_row_color">20037</td>
<td class="ns_st_body_alternate_row_color">Failed to add Forwarding Sessions on NetScaler Instance</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_GET_NSCONFIG</td>
<td class="ns_st_body_alternate_row_color">20016</td>
<td class="ns_st_body_alternate_row_color">Failed to get NetScaler config</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_ENABLING_CLUSTER</td>
<td class="ns_st_body_alternate_row_color">30039</td>
<td class="ns_st_body_alternate_row_color">Failed to enable cluster feature on VPX</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">DONE</td>
<td class="ns_st_body_alternate_row_color">0</td>
<td class="ns_st_body_alternate_row_color">Done</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_SVM_UPGRADE</td>
<td class="ns_st_body_alternate_row_color">20001</td>
<td class="ns_st_body_alternate_row_color">Failed to upgrade Management Service</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_INSTANCE_UNMANAGED</td>
<td class="ns_st_body_alternate_row_color">50029</td>
<td class="ns_st_body_alternate_row_color">Manage Instance Error</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_RM_SSL_CERTKEY</td>
<td class="ns_st_body_alternate_row_color">20041</td>
<td class="ns_st_body_alternate_row_color">Failed to remove ssl certkey from NetScaler Instance</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_DOCKERAPI_CONTAINER_REBOOT</td>
<td class="ns_st_body_alternate_row_color">50025</td>
<td class="ns_st_body_alternate_row_color">Failed to reboot docker container</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_GET_HOSTNAME</td>
<td class="ns_st_body_alternate_row_color">20017</td>
<td class="ns_st_body_alternate_row_color">Failed to get hostname</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_XAPI_DEL_VBD</td>
<td class="ns_st_body_alternate_row_color">150021</td>
<td class="ns_st_body_alternate_row_color">Failed to delete VBD</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_XAPI_GET_NETWORK</td>
<td class="ns_st_body_alternate_row_color">15004</td>
<td class="ns_st_body_alternate_row_color">Failed to get Network</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_SYSTEM_NOT_INITIALIZED</td>
<td class="ns_st_body_alternate_row_color">50016</td>
<td class="ns_st_body_alternate_row_color">System not initialized</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_INVALID_HOST_TYPE</td>
<td class="ns_st_body_alternate_row_color">10003</td>
<td class="ns_st_body_alternate_row_color">Invalid host type</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_XAPI_DEL_VDI</td>
<td class="ns_st_body_alternate_row_color">150024</td>
<td class="ns_st_body_alternate_row_color">Failed to delete VDI</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_XAPI_GET_SR</td>
<td class="ns_st_body_alternate_row_color">150018</td>
<td class="ns_st_body_alternate_row_color">Failed to get SR</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_GET_NSVERSION</td>
<td class="ns_st_body_alternate_row_color">20020</td>
<td class="ns_st_body_alternate_row_color">Failed to get NetScaler instance version</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_DOCKERAPI_CONTAINER_START</td>
<td class="ns_st_body_alternate_row_color">50024</td>
<td class="ns_st_body_alternate_row_color">Failed to start docker container</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_DEVICE_NOT_REACHABLE</td>
<td class="ns_st_body_alternate_row_color">500002</td>
<td class="ns_st_body_alternate_row_color">Failed to reach device</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_SCP_UPLOAD</td>
<td class="ns_st_body_alternate_row_color">16000</td>
<td class="ns_st_body_alternate_row_color">SCP failed to upload</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_XAPI_DEL_VIF</td>
<td class="ns_st_body_alternate_row_color">150015</td>
<td class="ns_st_body_alternate_row_color">Failed to delete VIF</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NOT_EXISTS</td>
<td class="ns_st_body_alternate_row_color">10011</td>
<td class="ns_st_body_alternate_row_color">Resource does not exist</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_INVALID_PARAM</td>
<td class="ns_st_body_alternate_row_color">10008</td>
<td class="ns_st_body_alternate_row_color">Invalid Parameter</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_XAPI_RESET_NS_INTF</td>
<td class="ns_st_body_alternate_row_color">400020</td>
<td class="ns_st_body_alternate_row_color">Failed to reset NetScaler interfaces</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_XAPI_RESET_VM</td>
<td class="ns_st_body_alternate_row_color">400021</td>
<td class="ns_st_body_alternate_row_color">Failed to reset VM</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_REMOVE_CHANNEL_PROPERTIES</td>
<td class="ns_st_body_alternate_row_color">40008</td>
<td class="ns_st_body_alternate_row_color">Error while removing channel from VM</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_FORM_CLUSTER</td>
<td class="ns_st_body_alternate_row_color">30036</td>
<td class="ns_st_body_alternate_row_color">Failed to form cluster on VPX</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_SNMP_TRAP_CONFIG</td>
<td class="ns_st_body_alternate_row_color">20046</td>
<td class="ns_st_body_alternate_row_color">Failed to do SNMP trap configuration</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NOT_AUTHORIZED</td>
<td class="ns_st_body_alternate_row_color">10013</td>
<td class="ns_st_body_alternate_row_color">Not authorized to perform this operation</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_SESSION_TIMEOUT_VALIDATION_FAILED</td>
<td class="ns_st_body_alternate_row_color">10019</td>
<td class="ns_st_body_alternate_row_color">Invalid login session timeout</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_MAX_SSLCORES</td>
<td class="ns_st_body_alternate_row_color">11003</td>
<td class="ns_st_body_alternate_row_color">Maximum SSL cores reached</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_BULK_OPERATION</td>
<td class="ns_st_body_alternate_row_color">30000</td>
<td class="ns_st_body_alternate_row_color">Error in bulk operation</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_GUESTVM_SET_LICENSE</td>
<td class="ns_st_body_alternate_row_color">40003</td>
<td class="ns_st_body_alternate_row_color">Failed to set license</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_BACKUPRESTORE_INPROGRESS</td>
<td class="ns_st_body_alternate_row_color">11012</td>
<td class="ns_st_body_alternate_row_color">System maintenance in progress. Please try after some time</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_PLUGIN_CALL_FAILED</td>
<td class="ns_st_body_alternate_row_color">10018</td>
<td class="ns_st_body_alternate_row_color">Plugin call failed</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_XAPI_ADD_VIF</td>
<td class="ns_st_body_alternate_row_color">15008</td>
<td class="ns_st_body_alternate_row_color">Failed to add VIF</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_SET_CHANNEL_PROPERTIES</td>
<td class="ns_st_body_alternate_row_color">40007</td>
<td class="ns_st_body_alternate_row_color">Error while setting channel properties</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_DISK_STOP_LOCATE_FAILED</td>
<td class="ns_st_body_alternate_row_color">20202</td>
<td class="ns_st_body_alternate_row_color">Failed to stop disk locate</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_GET_ROUTE</td>
<td class="ns_st_body_alternate_row_color">20021</td>
<td class="ns_st_body_alternate_row_color">Failed to get route</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_GET_NSIP</td>
<td class="ns_st_body_alternate_row_color">20018</td>
<td class="ns_st_body_alternate_row_color">Failed to get NetScaler Instance IP Address</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_DOCKERAPI_CONTAINER_DELETE</td>
<td class="ns_st_body_alternate_row_color">50020</td>
<td class="ns_st_body_alternate_row_color">Failed to delete docker container</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_XAPI_ADD_VBD</td>
<td class="ns_st_body_alternate_row_color">150020</td>
<td class="ns_st_body_alternate_row_color">Failed to add VBD</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_XAPI_GET_VM</td>
<td class="ns_st_body_alternate_row_color">15000</td>
<td class="ns_st_body_alternate_row_color">Failed to get VM</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_BACKUP_PARTIAL</td>
<td class="ns_st_body_alternate_row_color">30031</td>
<td class="ns_st_body_alternate_row_color">Backup partially completed</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_XAPI_CREATE_NETWORK</td>
<td class="ns_st_body_alternate_row_color">150016</td>
<td class="ns_st_body_alternate_row_color">Failed to create Network</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_ADD_TRAP</td>
<td class="ns_st_body_alternate_row_color">500003</td>
<td class="ns_st_body_alternate_row_color">Failed to add trap destination</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_LOCK_INVENTORY</td>
<td class="ns_st_body_alternate_row_color">50009</td>
<td class="ns_st_body_alternate_row_color">Failed to lock inventory</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_REBOOT</td>
<td class="ns_st_body_alternate_row_color">11010</td>
<td class="ns_st_body_alternate_row_color">Failed to reboot</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_XAPI_GET_PIF</td>
<td class="ns_st_body_alternate_row_color">15005</td>
<td class="ns_st_body_alternate_row_color">Failed to get PIF</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_XAPI_ADD_VDI</td>
<td class="ns_st_body_alternate_row_color">150023</td>
<td class="ns_st_body_alternate_row_color">Failed to add VDI</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_XAPI_SET_LOOPBACK</td>
<td class="ns_st_body_alternate_row_color">400022</td>
<td class="ns_st_body_alternate_row_color">Failed to configure loopback settings</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_SDX_UPGRADE</td>
<td class="ns_st_body_alternate_row_color">50005</td>
<td class="ns_st_body_alternate_row_color">Failed to upgrade SDX</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_GUESTVM_INIT_CONFIG</td>
<td class="ns_st_body_alternate_row_color">400016</td>
<td class="ns_st_body_alternate_row_color">Failed to do initial configuration</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_ADD_SET_ROUTE</td>
<td class="ns_st_body_alternate_row_color">20010</td>
<td class="ns_st_body_alternate_row_color">Failed to add/set route</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_JOIN_CLUSTER</td>
<td class="ns_st_body_alternate_row_color">30037</td>
<td class="ns_st_body_alternate_row_color">Failed to add VPX node to cluster</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_BACKUP</td>
<td class="ns_st_body_alternate_row_color">30030</td>
<td class="ns_st_body_alternate_row_color">Error in backup operation</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_CLU_NOT_ENABLED</td>
<td class="ns_st_body_alternate_row_color">30034</td>
<td class="ns_st_body_alternate_row_color">Cluster feature not enabled on VPX</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_XAPI_ADD_NSTRACE</td>
<td class="ns_st_body_alternate_row_color">150025</td>
<td class="ns_st_body_alternate_row_color">Failed to add NetScaler trace uuid</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_GET_VSERVER_APPFLOW_CONFIG</td>
<td class="ns_st_body_alternate_row_color">20042</td>
<td class="ns_st_body_alternate_row_color">Failed to get vserver appflow configuration from NetScaler</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_PARAM_MISMATCH</td>
<td class="ns_st_body_alternate_row_color">10016</td>
<td class="ns_st_body_alternate_row_color">Build and Documentation file version mismatch</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_GET_SDX_CONFIG</td>
<td class="ns_st_body_alternate_row_color">500001</td>
<td class="ns_st_body_alternate_row_color">Failed to get SDX configuration</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_SET_HOSTNAME</td>
<td class="ns_st_body_alternate_row_color">20006</td>
<td class="ns_st_body_alternate_row_color">Failed to set hostname</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_MAX_THROUGHOUT</td>
<td class="ns_st_body_alternate_row_color">11008</td>
<td class="ns_st_body_alternate_row_color">Maximum Throughput reached</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_INVALID_POLICY</td>
<td class="ns_st_body_alternate_row_color">15014</td>
<td class="ns_st_body_alternate_row_color">Invalid policy</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_APPLYING_CONFIG_FAILED</td>
<td class="ns_st_body_alternate_row_color">60009</td>
<td class="ns_st_body_alternate_row_color">Failed to applying config.</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_INVALID_ACTION</td>
<td class="ns_st_body_alternate_row_color">10015</td>
<td class="ns_st_body_alternate_row_color">Invalid Action</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_ADD_SET_INTERNAL_ARP</td>
<td class="ns_st_body_alternate_row_color">20055</td>
<td class="ns_st_body_alternate_row_color">Failed to add/set internal arp</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_SESSION_LIMIT_VALIDATION_FAILED</td>
<td class="ns_st_body_alternate_row_color">10020</td>
<td class="ns_st_body_alternate_row_color">User session limit is exceeded</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_SFTP_DOWNLOAD</td>
<td class="ns_st_body_alternate_row_color">16003</td>
<td class="ns_st_body_alternate_row_color">SFTP failed to download</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_CERT_CREATE_FAILED</td>
<td class="ns_st_body_alternate_row_color">20203</td>
<td class="ns_st_body_alternate_row_color">Failed to create certificate</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_DOCKERAPI_CONTAINERID_NOTFOUND</td>
<td class="ns_st_body_alternate_row_color">50021</td>
<td class="ns_st_body_alternate_row_color">Failed to find container ID on host</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_SET_NSCONFIG</td>
<td class="ns_st_body_alternate_row_color">20008</td>
<td class="ns_st_body_alternate_row_color">Failed to set NetScaler config</td>
</tr>
<tr>
<td class="ns_st_body_alternate_row_color">ERR_NS_BIND_SYS_USER</td>
<td class="ns_st_body_alternate_row_color">20014</td>
<td class="ns_st_body_alternate_row_color">Failed to bind system user</td>
</tr>
</tbody>
</table></td></tr>
<tr><td><br></td></tr></table></div>
</body>
</html>

BIN
docs/Reference Docs/mas_nitro-rest_14.1-60.54/doc/getting_started_guide_rest.pdf Normal file
View File

Binary file not shown.

22
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/account_takeover_config.html Normal file
View File

File diff suppressed because one or more lines are too long

31
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/adm_learn_profile.html Normal file
View File

File diff suppressed because one or more lines are too long

18
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/advanced_analytics_config.html Normal file
View File

File diff suppressed because one or more lines are too long

18
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/af_config_info.html Normal file
View File

File diff suppressed because one or more lines are too long

17
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/af_cpx_support.html Normal file
View File

@@ -0,0 +1,17 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>af_cpx_support</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">af_cpx_support</p>
<P>Configuration for AF CPX Support resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">enable<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">AF CPX Support enable value.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#modify" class="operation">modify</a><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="modify">modify</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/af_cpx_support/</span></p><p class="key">HTTPS Method:<span class="value">PUT</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"af_cpx_support":{<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"enable":&lt;Boolean_value&gt;</font>}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "af_cpx_support":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"enable":&lt;Boolean_value&gt;</font>}]}</p><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/af_cpx_support</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/af_cpx_support<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of af_cpx_support resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/af_cpx_support<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the af_cpx_support resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/af_cpx_support<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of af_cpx_support resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "af_cpx_support":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"enable":&lt;Boolean_value&gt;</font>}]}</p>
</body>
</html>

17
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/af_database_cleanup.html Normal file
View File

@@ -0,0 +1,17 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>af_database_cleanup</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">af_database_cleanup</p>
<P>Configuration for AF Database cleanup resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">enable<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">AF Database cleanup enable value.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><a href="#modify" class="operation">modify</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/af_database_cleanup</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/af_database_cleanup<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of af_database_cleanup resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/af_database_cleanup<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the af_database_cleanup resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/af_database_cleanup<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of af_database_cleanup resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "af_database_cleanup":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"enable":&lt;Boolean_value&gt;</font>}]}</p><p class="heading"><a name="modify">modify</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/af_database_cleanup/</span></p><p class="key">HTTPS Method:<span class="value">PUT</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"af_database_cleanup":{<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"enable":&lt;Boolean_value&gt;</font>}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "af_database_cleanup":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"enable":&lt;Boolean_value&gt;</font>}]}</p>
</body>
</html>

17
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/af_database_duration.html Normal file
View File

@@ -0,0 +1,17 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>af_database_duration</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">af_database_duration</p>
<P>Configuration for AF Database duration to keep DB data resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">days<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">AF Database days duration to keep data..<br> Minimum value = 2<br> Maximum value = </p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><a href="#modify" class="operation">modify</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/af_database_duration</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/af_database_duration<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of af_database_duration resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/af_database_duration<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the af_database_duration resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/af_database_duration<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of af_database_duration resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "af_database_duration":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"days":&lt;Integer_value&gt;</font>}]}</p><p class="heading"><a name="modify">modify</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/af_database_duration/</span></p><p class="key">HTTPS Method:<span class="value">PUT</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"af_database_duration":{<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"days":&lt;Integer_value&gt;</font>}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "af_database_duration":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"days":&lt;Integer_value&gt;</font>}]}</p>
</body>
</html>

17
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/af_database_index.html Normal file
View File

@@ -0,0 +1,17 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>af_database_index</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">af_database_index</p>
<P>Configuration for AF Database Index resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">enable<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">AF Database Index enable value.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#modify" class="operation">modify</a><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="modify">modify</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/af_database_index/</span></p><p class="key">HTTPS Method:<span class="value">PUT</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"af_database_index":{<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"enable":&lt;Boolean_value&gt;</font>}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "af_database_index":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"enable":&lt;Boolean_value&gt;</font>}]}</p><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/af_database_index</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/af_database_index<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of af_database_index resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/af_database_index<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the af_database_index resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/af_database_index<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of af_database_index resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "af_database_index":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"enable":&lt;Boolean_value&gt;</font>}]}</p>
</body>
</html>

20
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/af_persistant_stat_info.html Normal file
View File

File diff suppressed because one or more lines are too long

21
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/af_vserver_policy.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>af_vserver_policy</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">af_vserver_policy</p>
<P>Configuration for Virtual server Policy resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Number of records.</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is type of policy rule.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">vserver_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">virtual server type.<br> Maximum length = 255</p>
<p class="property_name">servicetype<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Type of Service.</p>
<p class="property_name">policy_rule<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Policy rule.<br> Maximum length = 255</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/af_vserver_policy</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "af_vserver_policy":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vserver_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"servicetype":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"policy_rule":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

18
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/agent_web_traffic_distribution.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>agent_web_traffic_distribution</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">agent_web_traffic_distribution</p>
<P>Configuration for Getting Web Traffic Distribution based on number of webinsight enabled vservers resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">agent_id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Agent Id.</p>
<p class="property_name">traffic_dist_multiplier<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Traffic Distribution Multiplier.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/agent_web_traffic_distribution</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/agent_web_traffic_distribution<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of agent_web_traffic_distribution resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/agent_web_traffic_distribution<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the agent_web_traffic_distribution resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/agent_web_traffic_distribution<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of agent_web_traffic_distribution resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "agent_web_traffic_distribution":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"agent_id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"traffic_dist_multiplier":&lt;Double_value&gt;</font>}]}</p>
</body>
</html>

18
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/analytics_policy_to_profile.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>analytics_policy_to_profile</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">analytics_policy_to_profile</p>
<P>Configuration for API to convert analytics appflow config from policy to profile based resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">devices<span class="property_type">&lt;String[]&gt;</span></p><p class="property_description">List of Devices.</p>
<p class="property_name">act_id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Activity ID that is used by GUI to track the polling status..</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#update" class="operation">update</a><p class="heading"><a name="update">update</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/analytics_policy_to_profile/</span></p><p class="key">HTTPS Method:<span class="value">PUT</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"analytics_policy_to_profile":{<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"act_id":&lt;String_value&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"devices":&lt;String_value[]&gt;</font>}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "analytics_policy_to_profile":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"devices":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"act_id":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

22
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/anomaly_item.html Normal file
View File

@@ -0,0 +1,22 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>anomaly_item</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">anomaly_item</p>
<P>Configuration for anomaly_item Resource resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">parent_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">.</p>
<p class="property_name">counter<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of the anomalous counter.</p>
<p class="property_name">timestamp<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Timestamp of the anomalous counter.</p>
<p class="property_name">value<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Value of the anomalous counter.</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">.</p>
<p class="property_name">parent_id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/anomaly_item</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/anomaly_item<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of anomaly_item resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/anomaly_item<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the anomaly_item resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/anomaly_item<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of anomaly_item resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "anomaly_item":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"parent_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"counter":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"timestamp":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"value":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"parent_id":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

20
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/app_config_error.html Normal file
View File

@@ -0,0 +1,20 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>app_config_error</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">app_config_error</p>
<P>Configuration for Provides info about app configuration resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">category<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Category.</p>
<p class="property_name">appname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Application name.</p>
<p class="property_name">total_apps<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Total Apps.</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Report Sample time (epoch time).</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/macro/v1/app/app_config_error</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "app_config_error":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"category":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"appname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_apps":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

24
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/app_devices_info.html Normal file
View File

File diff suppressed because one or more lines are too long

21
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/app_health.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>app_health</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">app_health</p>
<P>Configuration for Provides the metrics about app health resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Report Sample time (epoch time).</p>
<p class="property_name">ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">IP Address.</p>
<p class="property_name">vservername<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Vservername.</p>
<p class="property_name">appname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Application name.</p>
<p class="property_name">health_score<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Health Score of the app.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/macro/v1/app/app_health</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "app_health":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vservername":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"appname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"health_score":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

19
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/app_latency.html Normal file
View File

@@ -0,0 +1,19 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>app_latency</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">app_latency</p>
<P>Configuration for Provides the metrics causing app latency resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Report Sample time (epoch time).</p>
<p class="property_name">application_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Application Name.</p>
<p class="property_name">category<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Category.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/macro/v1/app/app_latency</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "app_latency":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"application_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"category":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

19
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/app_server_error.html Normal file
View File

@@ -0,0 +1,19 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>app_server_error</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">app_server_error</p>
<P>Configuration for Provides the metrics causing app server error resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">category<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Category.</p>
<p class="property_name">appname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Application name.</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Report Sample time (epoch time).</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/macro/v1/app/app_server_error</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "app_server_error":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"category":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"appname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

19
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/app_ssl_config_error.html Normal file
View File

@@ -0,0 +1,19 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>app_ssl_config_error</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">app_ssl_config_error</p>
<P>Configuration for Provides info about app SSL configuration resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">category<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Category.</p>
<p class="property_name">appname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Application name.</p>
<p class="property_name">total_apps<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Total Apps.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/macro/v1/app/app_ssl_config_error</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "app_ssl_config_error":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"category":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"appname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_apps":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

27
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/appsec_profile_config.html Normal file
View File

File diff suppressed because one or more lines are too long

19
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/db_cache.html Normal file
View File

File diff suppressed because one or more lines are too long

24
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/diagnostics_details.html Normal file
View File

@@ -0,0 +1,24 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>diagnostics_details</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">diagnostics_details</p>
<P>Configuration for Diagnostics Record Details resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">action<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Diagnosis Message.<br> Maximum length = 128</p>
<p class="property_name">hostname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Hostname.</p>
<p class="property_name">ns_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">NetScaler IP Address.</p>
<p class="property_name">msg<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Diagnosis Message.<br> Maximum length = 128</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is system generated PRIMARY_KEY.</p>
<p class="property_name">feature<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Feature being diagnosed for.</p>
<p class="property_name">vsrvr_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">VServer Name.</p>
<p class="property_name">issue_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Category of issue that occured.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/diagnostics_details</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/diagnostics_details<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of diagnostics_details resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/diagnostics_details<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the diagnostics_details resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/diagnostics_details<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of diagnostics_details resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "diagnostics_details":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"job_id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"action":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"status":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"hostname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ns_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"msg":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"sub_issue_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"feature":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vsrvr_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"issue_type":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

19
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/gateway_error.html Normal file
View File

@@ -0,0 +1,19 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>gateway_error</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">gateway_error</p>
<P>Configuration for Provides info about Gateway errors resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">metric<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Metric.</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Report Sample time (epoch time).</p>
<p class="property_name">username<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Username.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/macro/v1/gateway/gateway_error</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "gateway_error":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"metric":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"username":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

26
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/geo_user_info.html Normal file
View File

@@ -0,0 +1,26 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>geo_user_info</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">geo_user_info</p>
<P>Configuration for Provides info about Gateway users resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">total_apps<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Total Apps.</p>
<p class="property_name">ctnsappname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Application name.</p>
<p class="property_name">total_bytes<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Total Bytes.</p>
<p class="property_name">total_sessions<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Total Sessions.</p>
<p class="property_name">total_countries<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Total Countries.</p>
<p class="property_name">username<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Username.</p>
<p class="property_name">total_users<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Total Users.</p>
<p class="property_name">country_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Country Name.</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Report Sample time (epoch time).</p>
<p class="property_name">session_id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Session Id.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/macro/v1/gateway/geo_user_info</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "geo_user_info":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_apps":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ctnsappname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_sessions":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_countries":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"username":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_users":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"country_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"session_id":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

18
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/ica_session_timeout.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>ica_session_timeout</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ica_session_timeout</p>
<P>Configuration for ICA session timeout resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">timeout_value<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Ica session timeout value.<br> Minimum value = 2</p>
<p class="property_name">gateway_session_timeout<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Gateway session timeout value.<br> Minimum value = 2</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><a href="#modify" class="operation">modify</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/ica_session_timeout</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/ica_session_timeout<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of ica_session_timeout resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/ica_session_timeout<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the ica_session_timeout resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/ica_session_timeout<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of ica_session_timeout resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "ica_session_timeout":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"timeout_value":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gateway_session_timeout":&lt;Integer_value&gt;</font>}]}</p><p class="heading"><a name="modify">modify</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/ica_session_timeout/</span></p><p class="key">HTTPS Method:<span class="value">PUT</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"ica_session_timeout":{<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"timeout_value":&lt;Integer_value&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gateway_session_timeout":&lt;Integer_value&gt;</font>}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "ica_session_timeout":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"timeout_value":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gateway_session_timeout":&lt;Integer_value&gt;</font>}]}</p>
</body>
</html>

40
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/insight_threshold.html Normal file
View File

File diff suppressed because one or more lines are too long

20
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/log_datarecord.html Normal file
View File

File diff suppressed because one or more lines are too long

21
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/model_settings_info.html Normal file
View File

File diff suppressed because one or more lines are too long

17
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/multihop_feature.html Normal file
View File

File diff suppressed because one or more lines are too long

19
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/ns_app_config_group.html Normal file
View File

@@ -0,0 +1,19 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>ns_app_config_group</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_app_config_group</p>
<P>Configuration for Reference object to logically group a NetScaler and Application name for Appsec config profile group resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">ctnsappname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">ctnsappname.<br> Minimum length = 1<br> Maximum length = 32</p>
<p class="property_name">ns_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">NetScaler IP Address.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">display_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">display_name for NetScaler .<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/ns_app_config_group</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/ns_app_config_group<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of ns_app_config_group resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/ns_app_config_group<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the ns_app_config_group resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/ns_app_config_group<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of ns_app_config_group resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "ns_app_config_group":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ctnsappname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ns_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"display_name":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

25
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/nssslvserver_aplus_commands.html Normal file
View File

@@ -0,0 +1,25 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>nssslvserver_aplus_commands</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">nssslvserver_aplus_commands</p>
<P>Configuration for SSL Server Non A-Plus Details resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">command<span class="property_type">&lt;String&gt;</span></p><p class="property_description">command.</p>
<p class="property_name">ns_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">NetScaler IP Address.</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is system generated PRIMARY_KEY.</p>
<p class="property_name">rollback_command<span class="property_type">&lt;String&gt;</span></p><p class="property_description">rollback_command.</p>
<p class="property_name">vsrvr_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">VServer Name.</p>
<p class="property_name">index<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Command index.</p>
<p class="heading">Read only properties</p>
<p class="property_name">display_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Display Name.</p>
<p class="property_name">application_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">application_name.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/nssslvserver_aplus_commands</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/nssslvserver_aplus_commands<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of nssslvserver_aplus_commands resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/nssslvserver_aplus_commands<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the nssslvserver_aplus_commands resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/nssslvserver_aplus_commands<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of nssslvserver_aplus_commands resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "nssslvserver_aplus_commands":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"display_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"command":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ns_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"application_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rollback_command":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vsrvr_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"index":&lt;Integer_value&gt;</font>}]}</p>
</body>
</html>

25
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/nssslvserver_rating.html Normal file
View File

@@ -0,0 +1,25 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>nssslvserver_rating</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">nssslvserver_rating</p>
<P>Configuration for SSL Server A-Plus Summary resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">ns_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">NetScaler IP Address.</p>
<p class="property_name">protocol_score<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">protocol_score ( out of 100 ).</p>
<p class="property_name">ciphersuite_score<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">cipher_score ( out of 100 ).</p>
<p class="property_name">vsrvr_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">VServer Name.</p>
<p class="property_name">a_plus<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">a_plus.</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is system generated PRIMARY_KEY.</p>
<p class="property_name">ssl_rating<span class="property_type">&lt;String&gt;</span></p><p class="property_description">ssl_rating.</p>
<p class="heading">Read only properties</p>
<p class="property_name">display_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Display Name.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/nssslvserver_rating</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/nssslvserver_rating<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of nssslvserver_rating resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/nssslvserver_rating<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the nssslvserver_rating resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/nssslvserver_rating<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of nssslvserver_rating resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "nssslvserver_rating":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ns_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"protocol_score":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ciphersuite_score":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"display_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vsrvr_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"a_plus":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ssl_rating":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

26
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/nssslvserver_rating_details.html Normal file
View File

@@ -0,0 +1,26 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>nssslvserver_rating_details</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">nssslvserver_rating_details</p>
<P>Configuration for SSL Server Non A-Plus Details resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">vsrvr_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">VServer Name.</p>
<p class="property_name">msg<span class="property_type">&lt;String&gt;</span></p><p class="property_description">This property is no longer used&ltbr&gtDiagnosis Message.<br> Maximum length = 128</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is system generated PRIMARY_KEY.</p>
<p class="property_name">action<span class="property_type">&lt;String&gt;</span></p><p class="property_description">This property is no longer used&ltbr&gtDiagnosis Message.<br> Maximum length = 128</p>
<p class="property_name">ns_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">NetScaler IP Address.</p>
<p class="property_name">issue_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">This property is no longer used&ltbr&gtCategory of issue that occured.</p>
<p class="heading">Read only properties</p>
<p class="property_name">issue_ids<span class="property_type">&lt;String&gt;</span></p><p class="property_description">issue_id.</p>
<p class="property_name">issue_type_id<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">issue_type_id.</p>
<p class="property_name">display_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Display Name.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/nssslvserver_rating_details</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/nssslvserver_rating_details<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of nssslvserver_rating_details resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/nssslvserver_rating_details<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the nssslvserver_rating_details resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/nssslvserver_rating_details<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of nssslvserver_rating_details resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "nssslvserver_rating_details":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vsrvr_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"msg":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"issue_ids":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"action":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ns_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"issue_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"issue_type_id":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"display_name":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

26
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/nssslvserver_rating_job_mapping.html Normal file
View File

@@ -0,0 +1,26 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>nssslvserver_rating_job_mapping</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">nssslvserver_rating_job_mapping</p>
<P>Configuration for SSL Server A-Plus Job Mapping resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">latest_configjob_timestamp<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">latest_configjob_timestamp.</p>
<p class="property_name">ns_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">NetScaler IP Address.</p>
<p class="property_name">latest_configjob_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">latest_configjob_name.</p>
<p class="property_name">job_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">job_type.</p>
<p class="property_name">app_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">app_name.</p>
<p class="property_name">vsrvr_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">VServer Name.</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is system generated PRIMARY_KEY.</p>
<p class="property_name">job_success<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">job_success.</p>
<p class="heading">Read only properties</p>
<p class="property_name">display_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Display Name.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/nssslvserver_rating_job_mapping</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/nssslvserver_rating_job_mapping<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of nssslvserver_rating_job_mapping resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/nssslvserver_rating_job_mapping<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the nssslvserver_rating_job_mapping resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/nssslvserver_rating_job_mapping<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of nssslvserver_rating_job_mapping resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "nssslvserver_rating_job_mapping":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"latest_configjob_timestamp":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ns_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"latest_configjob_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"job_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"display_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"app_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vsrvr_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"job_success":&lt;Boolean_value&gt;</font>}]}</p>
</body>
</html>

25
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/nssslvserver_revert_commands.html Normal file
View File

@@ -0,0 +1,25 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>nssslvserver_revert_commands</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">nssslvserver_revert_commands</p>
<P>Configuration for SSL Server Non A-Plus Details resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">vsrvr_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">VServer Name.</p>
<p class="property_name">index<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Command index.</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is system generated PRIMARY_KEY.</p>
<p class="property_name">rollback_command<span class="property_type">&lt;String&gt;</span></p><p class="property_description">rollback_command.</p>
<p class="property_name">command<span class="property_type">&lt;String&gt;</span></p><p class="property_description">command.</p>
<p class="property_name">ns_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">NetScaler IP Address.</p>
<p class="heading">Read only properties</p>
<p class="property_name">application_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">application_name.</p>
<p class="property_name">display_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Display Name.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/nssslvserver_revert_commands</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/nssslvserver_revert_commands<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of nssslvserver_revert_commands resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/nssslvserver_revert_commands<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the nssslvserver_revert_commands resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/nssslvserver_revert_commands<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of nssslvserver_revert_commands resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "nssslvserver_revert_commands":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vsrvr_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"index":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rollback_command":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"application_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"display_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"command":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ns_ip_address":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

24
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/protection_info.html Normal file
View File

File diff suppressed because one or more lines are too long

19
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/ssl_aplus_config.html Normal file
View File

@@ -0,0 +1,19 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>ssl_aplus_config</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ssl_aplus_config</p>
<P>Configuration for SSL Vserver A+ Config resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">application_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Application Name.<br> Maximum length = 255</p>
<p class="property_name">act_id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Activity ID that is used by GUI to track the polling status..</p>
<p class="property_name">operation<span class="property_type">&lt;String&gt;</span></p><p class="property_description">operation.<br> Maximum length = 255</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#update" class="operation">update</a><p class="heading"><a name="update">update</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/ssl_aplus_config/</span></p><p class="key">HTTPS Method:<span class="value">PUT</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"ssl_aplus_config":{<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"operation":&lt;String_value&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"act_id":&lt;String_value&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"application_name":&lt;String_value&gt;</font>}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "ssl_aplus_config":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"application_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"act_id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"operation":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

19
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/ssl_aplus_config_batch.html Normal file
View File

@@ -0,0 +1,19 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>ssl_aplus_config_batch</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ssl_aplus_config_batch</p>
<P>Configuration for SSL Vserver A+ Config resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">operation<span class="property_type">&lt;String&gt;</span></p><p class="property_description">operation.<br> Maximum length = 255</p>
<p class="property_name">act_id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Activity ID that is used by GUI to track the polling status..</p>
<p class="property_name">applications<span class="property_type">&lt;String[]&gt;</span></p><p class="property_description">List of Application Names.<br> Maximum length = 255</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#update" class="operation">update</a><p class="heading"><a name="update">update</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/ssl_aplus_config_batch/</span></p><p class="key">HTTPS Method:<span class="value">PUT</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"ssl_aplus_config_batch":{<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"applications":&lt;String_value[]&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"act_id":&lt;String_value&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"operation":&lt;String_value&gt;</font>}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "ssl_aplus_config_batch":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"operation":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"act_id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"applications":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

39
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/threshold.html Normal file
View File

File diff suppressed because one or more lines are too long

21
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/threshold_breach_count.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>threshold_breach_count</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">threshold_breach_count</p>
<P>Configuration for Af report for threshold breach count for individual metric resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">category<span class="property_type">&lt;String&gt;</span></p><p class="property_description">All Resource Type for which threshold is violated would be displayed in category e.g. APP, DEVICE, URL.</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Number of records.</p>
<p class="property_name">threshold_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">threshold breach count for particular metric.</p>
<p class="property_name">threshold_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">threshold name.</p>
<p class="property_name">entity<span class="property_type">&lt;String&gt;</span></p><p class="property_description">threshold violated entity e.g outlook.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/threshold_breach_count</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>type</b></p><p class="key"><span class="value">Use this query-parameter to specify the type.</span></p><p class="key"><span class="value">Possible Values:<span class="value">HDX, WEB</span></span></p><p class="key"><b>report_end_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the end time until where summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>report_start_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the start time from which the summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>cr_enabled</b></p><p class="key"><span class="value">Use this query-parameter to indicate cr is enabled or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">0, 1</span></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "threshold_breach_count":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"category":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"threshold_count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"threshold_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"entity":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

23
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/threshold_breach_timeline.html Normal file
View File

@@ -0,0 +1,23 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>threshold_breach_timeline</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">threshold_breach_timeline</p>
<P>Configuration for Af report for Threshold breach timeline resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">breach_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">breach_count..</p>
<p class="property_name">breach_metric<span class="property_type">&lt;String&gt;</span></p><p class="property_description">all violated metric configured for entity.</p>
<p class="property_name">breach_entity_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">threshold violated entity_type e.g App, Device.</p>
<p class="property_name">breach_value<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">threshold breached value.</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Number of records.</p>
<p class="property_name">breach_entity<span class="property_type">&lt;String&gt;</span></p><p class="property_description">threshold violated entity e.g outlook.</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Timestamp of record.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/threshold_breach_timeline</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>sla_enabled</b></p><p class="key"><span class="value">Use this query-parameter to indicate sla is enabled or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">0, 1</span></span></p><p class="key"><b>report_start_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the start time from which the summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>report_end_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the end time until where summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>cr_enabled</b></p><p class="key"><span class="value">Use this query-parameter to indicate cr is enabled or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">0, 1</span></span></p><p class="key"><b>type</b></p><p class="key"><span class="value">Use this query-parameter to specify the type.</span></p><p class="key"><span class="value">Possible Values:<span class="value">ica_rtt, timeline_user_count, license_in_use</span></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "threshold_breach_timeline":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"breach_count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"breach_metric":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"breach_entity_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"breach_value":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"breach_entity":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>}]}</p>
</body>
</html>

22
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/threshold_config_timeline.html Normal file
View File

@@ -0,0 +1,22 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>threshold_config_timeline</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">threshold_config_timeline</p>
<P>Configuration for Af report for Threshold config timeline resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">configure_metric<span class="property_type">&lt;String&gt;</span></p><p class="property_description">configure_metric.</p>
<p class="property_name">entity_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">entity_type.</p>
<p class="property_name">configure_value<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">threshold configure_value.</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="property_name">enable_flag<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">enable_flag..</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/threshold_config_timeline</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "threshold_config_timeline":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"configure_metric":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"entity_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"configure_value":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"enable_flag":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>}]}</p>
</body>
</html>

20
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/threshold_expression.html Normal file
View File

File diff suppressed because one or more lines are too long

18
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/threshold_group_list.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>threshold_group_list</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">threshold_group_list</p>
<P>Configuration for Group List e.g. HDX, WEB, WAN resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">feature<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Feature.</p>
<p class="property_name">group_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Group Name.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/threshold_group_list</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/threshold_group_list<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of threshold_group_list resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/threshold_group_list<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the threshold_group_list resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/threshold_group_list<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of threshold_group_list resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "threshold_group_list":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"feature":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"group_name":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

19
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/threshold_key_list.html Normal file
View File

@@ -0,0 +1,19 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>threshold_key_list</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">threshold_key_list</p>
<P>Configuration for reference key list resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">prop_key<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Prop Key.</p>
<p class="property_name">resource_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Resource Type.</p>
<p class="property_name">prop_value<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Prop Value.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/threshold_key_list</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/threshold_key_list<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of threshold_key_list resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/threshold_key_list<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the threshold_key_list resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/threshold_key_list<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of threshold_key_list resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "threshold_key_list":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"prop_key":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"resource_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"prop_value":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

19
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/threshold_metric_list.html Normal file
View File

@@ -0,0 +1,19 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>threshold_metric_list</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">threshold_metric_list</p>
<P>Configuration for metric list resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">prop_key<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Prop Key.</p>
<p class="property_name">prop_value<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Prop Value.</p>
<p class="property_name">resource_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Resource Type.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/threshold_metric_list</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/threshold_metric_list<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of threshold_metric_list resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/threshold_metric_list<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the threshold_metric_list resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/threshold_metric_list<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of threshold_metric_list resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "threshold_metric_list":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"prop_key":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"prop_value":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"resource_type":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

19
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/threshold_resource_list.html Normal file
View File

@@ -0,0 +1,19 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>threshold_resource_list</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">threshold_resource_list</p>
<P>Configuration for Resource List resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">group_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Group Name.</p>
<p class="property_name">prop_key<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Prop Key.</p>
<p class="property_name">prop_value<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Prop Value.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/threshold_resource_list</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/threshold_resource_list<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of threshold_resource_list resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/threshold_resource_list<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the threshold_resource_list resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/threshold_resource_list<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of threshold_resource_list resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "threshold_resource_list":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"group_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"prop_key":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"prop_value":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

18
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/toggle_monitor_mode.html Normal file
View File

@@ -0,0 +1,18 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>toggle_monitor_mode</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">toggle_monitor_mode</p>
<P>Configuration for toggle_monitor_mode resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">profile_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">appsec profile name.</p>
<p class="property_name">enable_monitor_mode<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">Enable Monitor mode toggle.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#update" class="operation">update</a><p class="heading"><a name="update">update</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/toggle_monitor_mode/</span></p><p class="key">HTTPS Method:<span class="value">PUT</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"toggle_monitor_mode":{<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"profile_name":&lt;String_value&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"enable_monitor_mode":&lt;Boolean_value&gt;</font>}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "toggle_monitor_mode":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"profile_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"enable_monitor_mode":&lt;Boolean_value&gt;</font>}]}</p>
</body>
</html>

29
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Common Resources/unified_appsec_profile.html Normal file
View File

File diff suppressed because one or more lines are too long

20
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Gateway Insight/uber_dashboard_config.html Normal file
View File

File diff suppressed because one or more lines are too long

39
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Gateway Insight/vpn_active_sessions.html Normal file
View File

@@ -0,0 +1,39 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>vpn_active_sessions</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">vpn_active_sessions</p>
<P>Configuration for Af report for VPN Session resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">total_bytes_received<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total Bytes Received.</p>
<p class="property_name">session_end_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">vpn session end time.</p>
<p class="property_name">state<span class="property_type">&lt;String&gt;</span></p><p class="property_description">State (Active/Idle/Terminated).<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">bandwidth<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Avg Bandwidth..</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is VPN Session ID.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">up_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Session Up Time.</p>
<p class="property_name">os_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">OS type.<br> Maximum length = 128</p>
<p class="property_name">server_ip<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Server IP Address..<br> Maximum length = 64</p>
<p class="property_name">city_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">City.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">vpn_user_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of VPN User.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">region_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Region.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="property_name">client_ip<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Client IP Address..<br> Maximum length = 64</p>
<p class="property_name">session_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Session type.<br> Maximum length = 128</p>
<p class="property_name">gateway_ipaddress<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Gateway IPAddress.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">gateway_fqdn<span class="property_type">&lt;String&gt;</span></p><p class="property_description">FQDN of Gateway.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">logout_mode<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Logout Reason.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">device_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Device IP Address..<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">session_setup_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">vpn session start time.</p>
<p class="property_name">total_bytes<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total Bytes.</p>
<p class="property_name">country_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Country.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="property_name">total_bytes_sent<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total Bytes Sent.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/vpn_active_sessions</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>report_start_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the start time from which the summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>report_end_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the end time until where summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "vpn_active_sessions":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes_received":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"session_end_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"state":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"bandwidth":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"up_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"os_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"server_ip":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"city_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vpn_user_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"region_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"client_ip":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"session_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gateway_ipaddress":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gateway_fqdn":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"logout_mode":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"session_setup_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"country_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes_sent":&lt;Double_value&gt;</font>}]}</p>
</body>
</html>

30
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Gateway Insight/vpn_app_info.html Normal file
View File

@@ -0,0 +1,30 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>vpn_app_info</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">vpn_app_info</p>
<P>Configuration for Af report for VPN Apps resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">device_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Device IP Address..<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">active_session<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Number of active sessions launched this application.</p>
<p class="property_name">gateway_ipaddress<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Gateway IPAddress.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">gateway_fqdn<span class="property_type">&lt;String&gt;</span></p><p class="property_description">FQDN of Gateway.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="property_name">username<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of VPN User.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">total_bytes<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total bytes in sampled timeframe used by all users..</p>
<p class="property_name">bandwidth<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Avg Bandwidth..</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is ICA User Name.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">session_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Number of sessions launched this application.</p>
<p class="property_name">app_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Application Type.</p>
<p class="property_name">app_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of appname.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">app_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Number of times this app got launched.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/vpn_app_info</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>report_start_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the start time from which the summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>report_end_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the end time until where summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "vpn_app_info":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"active_session":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gateway_ipaddress":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gateway_fqdn":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"username":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"bandwidth":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"session_count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"app_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"app_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"app_count":&lt;Double_value&gt;</font>}]}</p>
</body>
</html>

21
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Gateway Insight/vpn_error_counts.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>vpn_error_counts</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">vpn_error_counts</p>
<P>Configuration for Af report for ICA User resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">error_counts<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Error Counts.</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is not dicided yet.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="property_name">flag<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Flag.</p>
<p class="property_name">error_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Error Type.<br> Maximum length = 256</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/vpn_error_counts</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>report_start_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the start time from which the summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>report_end_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the end time until where summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "vpn_error_counts":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"error_counts":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"flag":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"error_type":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

45
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Gateway Insight/vpn_error_details.html Normal file
View File

File diff suppressed because one or more lines are too long

20
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Gateway Insight/vpn_error_details_timeline.html Normal file
View File

@@ -0,0 +1,20 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>vpn_error_details_timeline</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">vpn_error_details_timeline</p>
<P>Configuration for Af report for ICA User resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample Time..</p>
<p class="property_name">error_counts<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Failure counts..</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is not dicided yet.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/vpn_error_details_timeline</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>cr_enabled</b></p><p class="key"><span class="value">Use this query-parameter to indicate cr is enabled or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">0, 1</span></span></p><p class="key"><b>report_start_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the start time from which the summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>report_end_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the end time until where summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>sla_enabled</b></p><p class="key"><span class="value">Use this query-parameter to indicate sla is enabled or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">0, 1</span></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "vpn_error_details_timeline":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"error_counts":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

24
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Gateway Insight/vpn_error_reports.html Normal file
View File

@@ -0,0 +1,24 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>vpn_error_reports</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">vpn_error_reports</p>
<P>Configuration for Af report for VPN Error details resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">vpn_fqdn<span class="property_type">&lt;String&gt;</span></p><p class="property_description">VPN FQDN.<br> Maximum length = 128</p>
<p class="property_name">hits<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Error Code.</p>
<p class="property_name">entity_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Entity Type.<br> Maximum length = 128</p>
<p class="property_name">exporter_id<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Exporter ID.</p>
<p class="property_name">entity<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Entity.</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">rpt_sample_time.</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="property_name">username<span class="property_type">&lt;String&gt;</span></p><p class="property_description">VPN username.<br> Maximum length = 128</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/vpn_error_reports</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>report_start_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the start time from which the summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>report_end_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the end time until where summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>order_by</b></p><p class="key"><span class="value">Use this query-parameter to get the result that is ordered by the given property.</span></p><p class="key"><span class="value">Possible Values:<span class="value">rpt_sample_time</span></span></p><p class="key"><b>asc</b></p><p class="key"><span class="value">Use this query-parameter to specify whether the results should be in ascending order or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">yes, no</span></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "vpn_error_reports":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vpn_fqdn":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"hits":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"entity_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"exporter_id":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"entity":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"username":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

27
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Gateway Insight/vpn_gateway_info.html Normal file
View File

@@ -0,0 +1,27 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>vpn_gateway_info</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">vpn_gateway_info</p>
<P>Configuration for Af report for VPN Gateway resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">active_session<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Number of active sessions launched by user.</p>
<p class="property_name">gateway_ipaddress<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Gateway IPAddress.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">gateway_fqdn<span class="property_type">&lt;String&gt;</span></p><p class="property_description">FQDN of Gateway.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="property_name">device_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Device IP Address..<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">total_bytes<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total bytes in sampled timeframe used by all users..</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="property_name">bandwidth<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Avg Bandwidth..</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">session_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Number of sessions launched by user.</p>
<p class="property_name">gateway_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of Gateway.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/vpn_gateway_info</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>report_end_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the end time until where summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>report_start_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the start time from which the summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "vpn_gateway_info":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"active_session":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gateway_ipaddress":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gateway_fqdn":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"bandwidth":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"session_count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gateway_name":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

26
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Gateway Insight/vpn_info.html Normal file
View File

@@ -0,0 +1,26 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>vpn_info</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">vpn_info</p>
<P>Configuration for Af report for ICA User resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">gateways<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">#Gateways.</p>
<p class="property_name">active_users<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">#Active Users.</p>
<p class="property_name">bandwidth<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Avg Bandwidth..</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is not dicided yet.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">session_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Number of sessions launched this application.</p>
<p class="property_name">active_sessions<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">#Active Session.</p>
<p class="property_name">total_bytes<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total bytes.</p>
<p class="property_name">applications<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">#Applications.</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/vpn_info</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>report_start_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the start time from which the summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>report_end_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the end time until where summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "vpn_info":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gateways":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"active_users":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"bandwidth":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"session_count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"active_sessions":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"applications":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>}]}</p>
</body>
</html>

30
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Gateway Insight/vpn_user.html Normal file
View File

@@ -0,0 +1,30 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>vpn_user</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">vpn_user</p>
<P>Configuration for vpn user report resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="property_name">client_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Client Source IP Address.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">http_req_method_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">HTTP Request Method..<br> Maximum length = 30</p>
<p class="property_name">operating_system_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Client Operating System Name..<br> Maximum length = 30</p>
<p class="property_name">total_requests<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total Requests for this device in given sampled timeframe..</p>
<p class="property_name">total_bytes<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total bytes accounted by this URL in sampled timeframe..</p>
<p class="property_name">max_transaction_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Last Transaction Time for this URL in the sampled timeframe..</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">vpn user name.<br> Maximum length = 255</p>
<p class="property_name">user_agent_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">User Agent Name..<br> Maximum length = 30</p>
<p class="property_name">name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">vpn user name..<br> Maximum length = 255</p>
<p class="property_name">device_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">NetScaler IP Address..<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">http_resp_status_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">HTTP Response Status Method..<br> Maximum length = 30</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="property_name">server_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Server Source IP Address.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/vpn_user</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "vpn_user":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"client_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"http_req_method_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"operating_system_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_requests":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"max_transaction_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"user_agent_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"http_resp_status_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"server_ip_address":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

26
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Gateway Insight/vpn_user_info.html Normal file
View File

@@ -0,0 +1,26 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>vpn_user_info</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">vpn_user_info</p>
<P>Configuration for Af report for VPN User resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is ICA User Name.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">session_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Number of sessions launched by user.</p>
<p class="property_name">bandwidth<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Avg Bandwidth..</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="property_name">active_session<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Number of active sessions launched by user.</p>
<p class="property_name">name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of ICA User.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">session_used<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Number of sessions used by user.</p>
<p class="property_name">logon_duration<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Logon duration of user in seconds.</p>
<p class="property_name">total_bytes<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total bytes in sampled timeframe used by all users..</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/vpn_user_info</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>report_end_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the end time until where summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>report_start_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the start time from which the summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "vpn_user_info":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"session_count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"bandwidth":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"active_session":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"session_used":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"logon_duration":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>}]}</p>
</body>
</html>

70
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/active_ica_session.html Normal file
View File

File diff suppressed because one or more lines are too long

41
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/hdx_desktop.html Normal file
View File

File diff suppressed because one or more lines are too long

96
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/hdx_desktop_session.html Normal file
View File

File diff suppressed because one or more lines are too long

92
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/hdx_desktop_session_inactive.html Normal file
View File

File diff suppressed because one or more lines are too long

37
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/hdx_desktop_timeline.html Normal file
View File

File diff suppressed because one or more lines are too long

39
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/ica_app.html Normal file
View File

File diff suppressed because one or more lines are too long

29
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/ica_app_active.html Normal file
View File

@@ -0,0 +1,29 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>ica_app_active</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ica_app_active</p>
<P>Configuration for Af report for ICA App Active resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of ICA Device.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">usage_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">ica app usages time..</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="property_name">app_terminate_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Application terminate time..</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is ICA App Name.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">app_start_time_local<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Application start time in local timezone..</p>
<p class="property_name">active_app_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">ica active_app_count..</p>
<p class="property_name">state<span class="property_type">&lt;String&gt;</span></p><p class="property_description">App state..</p>
<p class="property_name">is_active<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Is Active..</p>
<p class="property_name">active_session_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">active_session_count..</p>
<p class="property_name">app_start_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Application start time..</p>
<p class="property_name">launch_duration<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">ICA App launch duration..</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/ica_app_active</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>report_start_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the start time from which the summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>type</b></p><p class="key"><span class="value">Use this query-parameter to specify the type.</span></p><p class="key"><span class="value">Possible Values:<span class="value">active_session_count</span></span></p><p class="key"><b>asc</b></p><p class="key"><span class="value">Use this query-parameter to specify whether the results should be in ascending order or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">yes, no</span></span></p><p class="key"><b>cr_enabled</b></p><p class="key"><span class="value">Use this query-parameter to indicate cr is enabled or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">0, 1</span></span></p><p class="key"><b>report_end_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the end time until where summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>sla_enabled</b></p><p class="key"><span class="value">Use this query-parameter to indicate sla is enabled or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">0, 1</span></span></p><p class="key"><b>order_by</b></p><p class="key"><span class="value">Use this query-parameter to get the result that is ordered by the given property.</span></p><p class="key"><span class="value">Possible Values:<span class="value">active_session_count</span></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "ica_app_active":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"usage_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"app_terminate_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"app_start_time_local":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"active_app_count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"state":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"is_active":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"active_session_count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"app_start_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"launch_duration":&lt;Double_value&gt;</font>}]}</p>
</body>
</html>

37
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/ica_app_timeline.html Normal file
View File

File diff suppressed because one or more lines are too long

27
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/ica_channel.html Normal file
View File

@@ -0,0 +1,27 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>ica_channel</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ica_channel</p>
<P>Configuration for Af report for ICA Channel resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">ica_user_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of ICA User.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">channel_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">no_of_channels..</p>
<p class="property_name">bandwidth<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Avg Bandwidth..</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is ICA Channel.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">description<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Description of ICA Channel.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="property_name">ica_device_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">ICA Device IP Address..<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">total_bytes<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total bytes accounted by ICA Channel in sampled timeframe..</p>
<p class="property_name">name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of ICA Channel.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="property_name">ica_app_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of ICA app.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/ica_channel</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>order_by</b></p><p class="key"><span class="value">Use this query-parameter to get the result that is ordered by the given property.</span></p><p class="key"><span class="value">Possible Values:<span class="value">bandwidth, total_bytes</span></span></p><p class="key"><b>cr_enabled</b></p><p class="key"><span class="value">Use this query-parameter to indicate cr is enabled or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">0, 1</span></span></p><p class="key"><b>report_end_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the end time until where summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>sla_enabled</b></p><p class="key"><span class="value">Use this query-parameter to indicate sla is enabled or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">0, 1</span></span></p><p class="key"><b>type</b></p><p class="key"><span class="value">Use this query-parameter to specify the type.</span></p><p class="key"><span class="value">Possible Values:<span class="value">bandwidth, total_bytes</span></span></p><p class="key"><b>asc</b></p><p class="key"><span class="value">Use this query-parameter to specify whether the results should be in ascending order or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">yes, no</span></span></p><p class="key"><b>report_start_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the start time from which the summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "ica_channel":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ica_user_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"channel_count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"bandwidth":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ica_device_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ica_app_name":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

26
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/ica_client_user_agent.html Normal file
View File

@@ -0,0 +1,26 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>ica_client_user_agent</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ica_client_user_agent</p>
<P>Configuration for Af report for ICA client user agent resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">ica_user_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of ICA User.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">bandwidth<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Avg Bandwidth..</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is ICA Clinet user agent Name.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="property_name">total_bytes<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total bytes accounted by this URL in sampled timeframe..</p>
<p class="property_name">ica_device_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">ICA Device IP Address..<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of ICA client user agent.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">user_agent_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">no_of_user_agents..</p>
<p class="property_name">ica_app_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of ICA app.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/ica_client_user_agent</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>cr_enabled</b></p><p class="key"><span class="value">Use this query-parameter to indicate cr is enabled or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">0, 1</span></span></p><p class="key"><b>report_end_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the end time until where summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>sla_enabled</b></p><p class="key"><span class="value">Use this query-parameter to indicate sla is enabled or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">0, 1</span></span></p><p class="key"><b>order_by</b></p><p class="key"><span class="value">Use this query-parameter to get the result that is ordered by the given property.</span></p><p class="key"><span class="value">Possible Values:<span class="value">bandwidth, total_bytes</span></span></p><p class="key"><b>report_start_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the start time from which the summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>type</b></p><p class="key"><span class="value">Use this query-parameter to specify the type.</span></p><p class="key"><span class="value">Possible Values:<span class="value">bandwidth, total_bytes</span></span></p><p class="key"><b>asc</b></p><p class="key"><span class="value">Use this query-parameter to specify whether the results should be in ascending order or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">yes, no</span></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "ica_client_user_agent":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ica_user_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"bandwidth":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ica_device_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"user_agent_count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ica_app_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>}]}</p>
</body>
</html>

32
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/ica_device.html Normal file
View File

@@ -0,0 +1,32 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>ica_device</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ica_device</p>
<P>Configuration for Af report for ICA Device resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">app_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">ica_app_no_of_apps.</p>
<p class="property_name">user_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">ica ica_user_no_of_users..</p>
<p class="property_name">ica_user_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of ICA User.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">ica_rtt<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">ICA rtt..</p>
<p class="property_name">type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Device Type.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">ICA Device IP Address..<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">active_session_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">active_session_count..</p>
<p class="property_name">app_launch_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">App launch count..</p>
<p class="property_name">active_app_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">ica active_app_count..</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is ICA Device IPAddress.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">total_bytes<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total bytes accounted ICA Device..</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="property_name">ica_app_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of ICA app.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of ICA Device.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">active_launches<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">ica active_launches.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/ica_device</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>type</b></p><p class="key"><span class="value">Use this query-parameter to specify the type.</span></p><p class="key"><span class="value">Possible Values:<span class="value">user_count, active_launches, app_launch_count</span></span></p><p class="key"><b>asc</b></p><p class="key"><span class="value">Use this query-parameter to specify whether the results should be in ascending order or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">yes, no</span></span></p><p class="key"><b>report_start_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the start time from which the summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>order_by</b></p><p class="key"><span class="value">Use this query-parameter to get the result that is ordered by the given property.</span></p><p class="key"><span class="value">Possible Values:<span class="value">user_count, active_launches, app_launch_count</span></span></p><p class="key"><b>cr_enabled</b></p><p class="key"><span class="value">Use this query-parameter to indicate cr is enabled or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">0, 1</span></span></p><p class="key"><b>report_end_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the end time until where summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>sla_enabled</b></p><p class="key"><span class="value">Use this query-parameter to indicate sla is enabled or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">0, 1</span></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "ica_device":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"app_count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"user_count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ica_user_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ica_rtt":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"active_session_count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"app_launch_count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"active_app_count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ica_app_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"active_launches":&lt;Double_value&gt;</font>}]}</p>
</body>
</html>

33
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/ica_device_active.html Normal file
View File

File diff suppressed because one or more lines are too long

28
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/ica_device_session_hop_detail.html Normal file
View File

@@ -0,0 +1,28 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>ica_device_session_hop_detail</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ica_device_session_hop_detail</p>
<P>Configuration for Af report for ICA Device Session hop detail resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="property_name">license<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Feature License for NetScaler Instance, needs to be set while provisioning (standard, enterprise, platinum).<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">server_latency<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">ica session server latency..</p>
<p class="property_name">instance_state<span class="property_type">&lt;String&gt;</span></p><p class="property_description">State of device, UP only if device accessible.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">version<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Device Version.<br> Minimum length = 1<br> Maximum length = 256</p>
<p class="property_name">device_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">ICA Device IP Address..<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of ICA Device.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">ica_user_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of ICA User.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">ica_session_id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is ICA Session ID.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">client_latency<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">ica session client latency..</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is ICA Device IPAddress.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">is_gateway<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">Is this device acting as Gateway..</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/ica_device_session_hop_detail</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "ica_device_session_hop_detail":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"license":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"server_latency":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"instance_state":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"version":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ica_user_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ica_session_id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"client_latency":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"is_gateway":&lt;Boolean_value&gt;</font>}]}</p>
</body>
</html>

24
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/ica_device_skip_flow.html Normal file
View File

@@ -0,0 +1,24 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>ica_device_skip_flow</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ica_device_skip_flow</p>
<P>Configuration for Skip flow Information resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">ica_device_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">ICA Device IP Address..<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">skipflow_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Skip flow count...</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="property_name">skipflow_reason_id<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Skip flow reason id..</p>
<p class="property_name">group_reason_id<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Skip flow group reason id..</p>
<p class="property_name">skipflow_description<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Reason for skip flow..<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of ICA Device..<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is ICA Device IPAddress.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/ica_device_skip_flow</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>type</b></p><p class="key"><span class="value">Use this query-parameter to specify the type.</span></p><p class="key"><span class="value">Possible Values:<span class="value">skipflow_count</span></span></p><p class="key"><b>asc</b></p><p class="key"><span class="value">Use this query-parameter to specify whether the results should be in ascending order or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">yes, no</span></span></p><p class="key"><b>report_start_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the start time from which the summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>order_by</b></p><p class="key"><span class="value">Use this query-parameter to get the result that is ordered by the given property.</span></p><p class="key"><span class="value">Possible Values:<span class="value">skipflow_count</span></span></p><p class="key"><b>cr_enabled</b></p><p class="key"><span class="value">Use this query-parameter to indicate cr is enabled or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">0, 1</span></span></p><p class="key"><b>report_end_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the end time until where summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>sla_enabled</b></p><p class="key"><span class="value">Use this query-parameter to indicate sla is enabled or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">0, 1</span></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "ica_device_skip_flow":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ica_device_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"skipflow_count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"skipflow_reason_id":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"group_reason_id":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"skipflow_description":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

57
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/ica_device_skip_flow_details.html Normal file
View File

File diff suppressed because one or more lines are too long

26
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/ica_edt.html Normal file
View File

@@ -0,0 +1,26 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>ica_edt</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ica_edt</p>
<P>Configuration for Af report for ICA EDT resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">ica_user_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of ICA User.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">bandwidth<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Avg Bandwidth..</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is ICA edt.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">edt_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">no_of_user_agents..</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="property_name">ica_device_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">ICA Device IP Address..<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">total_bytes<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total bytes accounted by this URL in sampled timeframe..</p>
<p class="property_name">name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of ICA client user agent.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="property_name">ica_app_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of ICA app.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/ica_edt</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>order_by</b></p><p class="key"><span class="value">Use this query-parameter to get the result that is ordered by the given property.</span></p><p class="key"><span class="value">Possible Values:<span class="value">bandwidth, total_bytes</span></span></p><p class="key"><b>report_end_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the end time until where summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>cr_enabled</b></p><p class="key"><span class="value">Use this query-parameter to indicate cr is enabled or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">0, 1</span></span></p><p class="key"><b>sla_enabled</b></p><p class="key"><span class="value">Use this query-parameter to indicate sla is enabled or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">0, 1</span></span></p><p class="key"><b>type</b></p><p class="key"><span class="value">Use this query-parameter to specify the type.</span></p><p class="key"><span class="value">Possible Values:<span class="value">bandwidth, total_bytes</span></span></p><p class="key"><b>asc</b></p><p class="key"><span class="value">Use this query-parameter to specify whether the results should be in ascending order or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">yes, no</span></span></p><p class="key"><b>report_start_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the start time from which the summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "ica_edt":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ica_user_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"bandwidth":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"edt_count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ica_device_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ica_app_name":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

24
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/ica_l7_latency_update.html Normal file
View File

@@ -0,0 +1,24 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>ica_l7_latency_update</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ica_l7_latency_update</p>
<P>Configuration for Af report for ICA Session resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">l7_threshold_max_client_breach<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">L7 Threshold MAX Client Breach Value.</p>
<p class="property_name">l7_threshold_configure_value<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">L7 Threshold value.</p>
<p class="property_name">l7_threshold_max_server_breach<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">L7 Threshold MAX Server Breach Value.</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is ICA Session ID.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">l7_threshold_avg_client_breach<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">L7 Threshold AVG Client Breach Value.</p>
<p class="property_name">l7_threshold_avg_server_breach<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">L7 Threshold AVG Server Breach Value.</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/ica_l7_latency_update</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>type</b></p><p class="key"><span class="value">Use this query-parameter to specify the type.</span></p><p class="key"><span class="value">Possible Values:<span class="value">bandwidth</span></span></p><p class="key"><b>cr_enabled</b></p><p class="key"><span class="value">Use this query-parameter to indicate cr is enabled or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">0, 1</span></span></p><p class="key"><b>report_start_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the start time from which the summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>report_end_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the end time until where summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>sla_enabled</b></p><p class="key"><span class="value">Use this query-parameter to indicate sla is enabled or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">0, 1</span></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "ica_l7_latency_update":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"l7_threshold_max_client_breach":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"l7_threshold_configure_value":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"l7_threshold_max_server_breach":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"l7_threshold_avg_client_breach":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"l7_threshold_avg_server_breach":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>}]}</p>
</body>
</html>

23
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/ica_license.html Normal file
View File

@@ -0,0 +1,23 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>ica_license</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ica_license</p>
<P>Configuration for Af report for ica_license resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Ip Address..<br> Maximum length = 255</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="property_name">threshold<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">threshold..</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id IP Address.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="property_name">total_license<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">total_license..</p>
<p class="property_name">license_in_use<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">license_in_use..</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/ica_license</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "ica_license":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"threshold":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_license":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"license_in_use":&lt;Double_value&gt;</font>}]}</p>
</body>
</html>

37
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/ica_server_session_hop_detail.html Normal file
View File

@@ -0,0 +1,37 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>ica_server_session_hop_detail</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ica_server_session_hop_detail</p>
<P>Configuration for Af report for ICA Server session hop detail resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">serverside_cb<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">serverside cb.</p>
<p class="property_name">launch_duration<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">ica session launch duration..</p>
<p class="property_name">edt_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">edt_type.</p>
<p class="property_name">serverside_0_win<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">server side 0 window count..</p>
<p class="property_name">ica_user_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of ICA User.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is ICA Session ID.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">server_side_ns_delay<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Server to Client NetScaler delay..</p>
<p class="property_name">state<span class="property_type">&lt;String&gt;</span></p><p class="property_description">ICA Session state..</p>
<p class="property_name">l7_serverside_latency<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">L7 serverside latency.</p>
<p class="property_name">session_end_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">ICA Session end time..</p>
<p class="property_name">server_latency<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">ica session server latency..</p>
<p class="property_name">server_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Server IP Address..<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="property_name">serverside_rto<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">serverside rto..</p>
<p class="property_name">session_setup_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">ICA Session setup time..</p>
<p class="property_name">serverside_packet_retransmits<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Server side packet retransmits..</p>
<p class="property_name">server_jitter<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">ICA User server jitter..</p>
<p class="property_name">server_srtt<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">server Smothen RTT..</p>
<p class="property_name">session_rtt<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">ICA Session rtt..</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="property_name">host_delay<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Server induced delay..</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/ica_server_session_hop_detail</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "ica_server_session_hop_detail":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"serverside_cb":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"launch_duration":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"edt_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"serverside_0_win":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ica_user_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"server_side_ns_delay":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"state":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"l7_serverside_latency":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"session_end_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"server_latency":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"server_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"serverside_rto":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"session_setup_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"serverside_packet_retransmits":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"server_jitter":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"server_srtt":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"session_rtt":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"host_delay":&lt;Double_value&gt;</font>}]}</p>
</body>
</html>

94
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/ica_session.html Normal file
View File

File diff suppressed because one or more lines are too long

25
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/ica_session_hop_detail.html Normal file
View File

@@ -0,0 +1,25 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>ica_session_hop_detail</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ica_session_hop_detail</p>
<P>Configuration for Af report for ICA Session hop detail resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">edt_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">EDT type.</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is ICA Session ID.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Number of records..</p>
<p class="property_name">dc_latency<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">ica session dc latency..</p>
<p class="property_name">ica_device_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">ICA Device IP Address..<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">ica_device_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of ICA device.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">hop_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">ica session hop count..</p>
<p class="property_name">hop_location<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">ica session hop location..</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/ica_session_hop_detail</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "ica_session_hop_detail":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"edt_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"dc_latency":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ica_device_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ica_device_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"hop_count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"hop_location":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>}]}</p>
</body>
</html>

92
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/ica_session_inactive.html Normal file
View File

File diff suppressed because one or more lines are too long

59
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/ica_user.html Normal file
View File

File diff suppressed because one or more lines are too long

43
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/ica_user_session_hop_detail.html Normal file
View File

@@ -0,0 +1,43 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>ica_user_session_hop_detail</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ica_user_session_hop_detail</p>
<P>Configuration for Af report for ICA User Session Hop resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">client_srtt<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">client Smothen RTT..</p>
<p class="property_name">launch_duration<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">ica session launch duration..</p>
<p class="property_name">client_jitter<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">ICA User client jitter..</p>
<p class="property_name">ica_user_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of ICA User.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">edt_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">edt_type.</p>
<p class="property_name">region_code<span class="property_type">&lt;String&gt;</span></p><p class="property_description">region_code.</p>
<p class="property_name">client_version<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Client Version.<br> Maximum length = 1024</p>
<p class="property_name">state<span class="property_type">&lt;String&gt;</span></p><p class="property_description">ICA Session state..</p>
<p class="property_name">client_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Client IP Address..<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">session_end_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">ICA Session end time..</p>
<p class="property_name">client_latency<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">ica session client latency..</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is ICA Session ID.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">clientside_rto<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">clientside rto..</p>
<p class="property_name">region<span class="property_type">&lt;String&gt;</span></p><p class="property_description">region.</p>
<p class="property_name">city<span class="property_type">&lt;String&gt;</span></p><p class="property_description">city.</p>
<p class="property_name">session_setup_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">ICA Session setup time..</p>
<p class="property_name">country_code<span class="property_type">&lt;String&gt;</span></p><p class="property_description">country_code.</p>
<p class="property_name">clientside_packet_retransmits<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Client side packet retransmits..</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="property_name">client_side_ns_delay<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Client to Server NetScaler delay..</p>
<p class="property_name">client_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Client Type.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">session_rtt<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">ICA Session rtt..</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="property_name">clientside_cb<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">clientside cb.</p>
<p class="property_name">clientside_0_win<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Client side 0 window count..</p>
<p class="property_name">l7_clientside_latency<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">L7 clientside latency.</p>
<p class="property_name">country<span class="property_type">&lt;String&gt;</span></p><p class="property_description">country.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/ica_user_session_hop_detail</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "ica_user_session_hop_detail":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"client_srtt":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"launch_duration":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"client_jitter":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ica_user_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"edt_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"region_code":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"client_version":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"state":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"client_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"session_end_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"client_latency":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"clientside_rto":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"region":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"city":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"session_setup_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"country_code":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"clientside_packet_retransmits":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"client_side_ns_delay":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"client_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"session_rtt":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"clientside_cb":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"clientside_0_win":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"l7_clientside_latency":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"country":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

49
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/ica_user_timeline.html Normal file
View File

File diff suppressed because one or more lines are too long

54
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/inactive_ica_session.html Normal file
View File

File diff suppressed because one or more lines are too long

74
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/related_desktop_session.html Normal file
View File

File diff suppressed because one or more lines are too long

79
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/related_ica_session.html Normal file
View File

File diff suppressed because one or more lines are too long

26
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/HDX Insight/session_hop_distribution.html Normal file
View File

@@ -0,0 +1,26 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>session_hop_distribution</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">session_hop_distribution</p>
<P>Configuration for Session Hop Distribution Report resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">latency<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">ica session client latency..</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">ReportSampletime..</p>
<p class="property_name">source<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Text to display for the source [e.g.: User name, NetScaler IP, Server IP, etc.].<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">target<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Text to display for the target [e.g.: User name, NetScaler IP, Server IP, etc.].<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is ICA Session ID.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">source_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Type of the source, this will decide the icon to show in the UI for source [Client, NetScaler, Server, etc.] .<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">hop_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Index of the hop [1, 2, 3, etc.] .</p>
<p class="property_name">exporter_id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Exported ID..</p>
<p class="property_name">target_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Type of the source, this will decide the icon to show in the UI for source [Client, NetScaler, Server, etc.].<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/session_hop_distribution</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "session_hop_distribution":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"latency":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"source":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"target":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"source_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"hop_count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"exporter_id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"target_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>}]}</p>
</body>
</html>

23
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Security Insight/app_authentication_summary.html Normal file
View File

@@ -0,0 +1,23 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>app_authentication_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">app_authentication_summary</p>
<P>Configuration for Application Authentication Summary resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">auth_failures<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Authentication Failure..</p>
<p class="property_name">total_requests<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total Requests.</p>
<p class="property_name">ind_id<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Indicator Id.</p>
<p class="property_name">ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">IP Address.</p>
<p class="property_name">auth_successes<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Authentication Success..</p>
<p class="property_name">ctnsappname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">AppName.</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/macro/v1/security/app_authentication_summary</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>report_start_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the start time from which the summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value"></span></span></p><p class="key"><b>type</b></p><p class="key"><span class="value">Use this query-parameter to specify the type of report.</span></p><p class="key"><span class="value">Possible Values:<span class="value">detail, timeseries, summary</span></span></p><p class="key"><b>report_end_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the end time until where summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value"></span></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "app_authentication_summary":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"auth_failures":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_requests":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ind_id":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"auth_successes":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ctnsappname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>}]}</p>
</body>
</html>

21
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Security Insight/bot_log_expression.html Normal file
View File

@@ -0,0 +1,21 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>bot_log_expression</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">bot_log_expression</p>
<P>Configuration for Bot Logexpression resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">bot_log_expr_value<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Log Expression Value.</p>
<p class="property_name">bot_attack_offset<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Attack Offset.</p>
<p class="property_name">bot_attack_offset_len<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Attack Offset Length.</p>
<p class="property_name">bot_log_expr_comment<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Log Expression Comment.</p>
<p class="property_name">bot_log_expr_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Log Expression Name.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/macro/v1/security/bot_log_expression</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>transaction_id</b></p><p class="key"><span class="value">Use this query-parameter to specify the transaction id of the bot violation record for which the expression is generated.</span></p><p class="key"><span class="value">Possible Values:<span class="value">transaction id number</span></span></p><p class="key"><b>report_start_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the start time from which the summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value"></span></span></p><p class="key"><b>report_end_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the end time until where summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value"></span></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "bot_log_expression":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"bot_log_expr_value":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"bot_attack_offset":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"bot_attack_offset_len":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"bot_log_expr_comment":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"bot_log_expr_name":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

50
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Security Insight/bot_violation.html Normal file
View File

File diff suppressed because one or more lines are too long

25
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Security Insight/bot_violation_summary.html Normal file
View File

@@ -0,0 +1,25 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>bot_violation_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">bot_violation_summary</p>
<P>Configuration for Bot Violation Summary resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">total_bots<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Total Bots.</p>
<p class="property_name">total_violations<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total Violations.</p>
<p class="property_name">bot_human_ratio<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Bot Human Ratio.</p>
<p class="property_name">host_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">HostName.</p>
<p class="property_name">appname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">App Name.</p>
<p class="property_name">backend_vserver<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Backend Vserver Name.</p>
<p class="property_name">backend_appname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Backend App Name.</p>
<p class="property_name">ctnsappname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">AppName.</p>
<p class="property_name">ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">IP Address.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/macro/v1/security/bot_violation_summary</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>report_start_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the start time from which the summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value"></span></span></p><p class="key"><b>report_end_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the end time until where summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value"></span></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "bot_violation_summary":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bots":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_violations":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"bot_human_ratio":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"host_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"appname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"backend_vserver":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"backend_appname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ctnsappname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ip_address":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

36
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Security Insight/client_details.html Normal file
View File

@@ -0,0 +1,36 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>client_details</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">client_details</p>
<P>Configuration for Client Details resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">email_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Email Address.</p>
<p class="property_name">ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">IP Address.</p>
<p class="property_name">login_failures<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Login Failures.</p>
<p class="property_name">confidence<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Confidence.</p>
<p class="property_name">response_bytes<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Response Bytes.</p>
<p class="property_name">user_agent<span class="property_type">&lt;String&gt;</span></p><p class="property_description">User Agent.</p>
<p class="property_name">client_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Client IP Address.</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="property_name">ind_id<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Indicator ID.</p>
<p class="property_name">detection_reason<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Detection Reason.</p>
<p class="property_name">total_requests<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total Requests.</p>
<p class="property_name">ctnsappname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">AppName.</p>
<p class="property_name">ind_detection_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Indicator detection time..</p>
<p class="property_name">curr_clients<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Curr Clients.</p>
<p class="property_name">login_successes<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Login Successes.</p>
<p class="property_name">vsvr_rspbytes_rate<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">VServer Response Rate.</p>
<p class="property_name">vsvr_req_rate<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">VServer Requeste Rate.</p>
<p class="property_name">last_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Last Name.</p>
<p class="property_name">first_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">First Name.</p>
<p class="property_name">request_bytes<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Request Bytes.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/macro/v1/security/client_details</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>report_start_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the start time from which the summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value"></span></span></p><p class="key"><b>type</b></p><p class="key"><span class="value">Use this query-parameter to specify the type of report.</span></p><p class="key"><span class="value">Possible Values:<span class="value">detail, timeseries, summary, timeseries_client, timeseries_by_ip, timeseries_aggr</span></span></p><p class="key"><b>report_end_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the end time until where summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value"></span></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "client_details":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"email_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"login_failures":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"confidence":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"response_bytes":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"user_agent":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"client_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ind_id":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"detection_reason":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_requests":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ctnsappname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ind_detection_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"curr_clients":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"login_successes":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vsvr_rspbytes_rate":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vsvr_req_rate":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"last_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"first_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"request_bytes":&lt;Double_value&gt;</font>}]}</p>
</body>
</html>

32
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Security Insight/client_session_details.html Normal file
View File

@@ -0,0 +1,32 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>client_session_details</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">client_session_details</p>
<P>Configuration for Client Session Details resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">session_id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Session ID.</p>
<p class="property_name">error_trans_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Empty Transaction Count.</p>
<p class="property_name">empty_referrers_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Empty Referrers Count.</p>
<p class="property_name">ind_detection_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Indicator detection time..</p>
<p class="property_name">ctnsappname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">AppName.</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="property_name">client_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Client IP Address.</p>
<p class="property_name">web_page_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Web Page Count.</p>
<p class="property_name">ind_id<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Indicator ID.</p>
<p class="property_name">trans_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Transaction Count.</p>
<p class="property_name">urls_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">URL Count.</p>
<p class="property_name">script_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Script Count.</p>
<p class="property_name">ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">IP Address.</p>
<p class="property_name">image_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Image Count.</p>
<p class="property_name">confidence<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Confidence.</p>
<p class="property_name">user_agent<span class="property_type">&lt;String&gt;</span></p><p class="property_description">User Agent.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/macro/v1/security/client_session_details</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>type</b></p><p class="key"><span class="value">Use this query-parameter to specify the type of report.</span></p><p class="key"><span class="value">Possible Values:<span class="value">detail, timeseries, summary</span></span></p><p class="key"><b>report_start_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the start time from which the summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value"></span></span></p><p class="key"><b>report_end_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the end time until where summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value"></span></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "client_session_details":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"session_id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"error_trans_count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"empty_referrers_count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ind_detection_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ctnsappname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"client_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"web_page_count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ind_id":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"trans_count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"urls_count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"script_count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"image_count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"confidence":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"user_agent":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

26
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Security Insight/client_url_details.html Normal file
View File

@@ -0,0 +1,26 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>client_url_details</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">client_url_details</p>
<P>Configuration for Client URL Details resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">user_agent<span class="property_type">&lt;String&gt;</span></p><p class="property_description">User Agent.</p>
<p class="property_name">confidence<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Confidence.</p>
<p class="property_name">ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">IP Address.</p>
<p class="property_name">ctnsappname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">AppName.</p>
<p class="property_name">ind_detection_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Indicator detection time..</p>
<p class="property_name">url<span class="property_type">&lt;String&gt;</span></p><p class="property_description">URL.</p>
<p class="property_name">ind_id<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Indicator ID.</p>
<p class="property_name">client_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Client IP Address.</p>
<p class="property_name">decision_criteria<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Decision Criteria.</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/macro/v1/security/client_url_details</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>report_end_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the end time until where summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value"></span></span></p><p class="key"><b>report_start_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the start time from which the summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value"></span></span></p><p class="key"><b>type</b></p><p class="key"><span class="value">Use this query-parameter to specify the type of report.</span></p><p class="key"><span class="value">Possible Values:<span class="value">detail, timeseries, summary</span></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "client_url_details":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"user_agent":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"confidence":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ctnsappname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ind_detection_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ind_id":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"client_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"decision_criteria":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>}]}</p>
</body>
</html>

25
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Analytics/Security Insight/dns_details.html Normal file
View File

@@ -0,0 +1,25 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../../index.css" rel="stylesheet" type="text/css" />
<title>dns_details</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">dns_details</p>
<P>Configuration for DNS Details resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">mem_usage_bytes<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Mem Usage Bytes.</p>
<p class="property_name">metric_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Metric Name.</p>
<p class="property_name">cpuusagepcnt<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">CPU Usage Count.</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="property_name">dns_tot_queries<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">DNS TOT Queries.</p>
<p class="property_name">ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">IP Address.<br> Maximum length = 512</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="property_name">metric_value<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Metric Value.</p>
<p class="property_name">dns_tot_neg_nxdmn_entries<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">DNS Total Negative nxdmn entries.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/dns_details</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>report_end_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the end time until where summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>report_start_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the start time from which the summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>type</b></p><p class="key"><span class="value">Use this query-parameter to specify the type.</span></p><p class="key"><span class="value">Possible Values:<span class="value">total_requests, load_time, render_time</span></span></p><p class="key"><b>asc</b></p><p class="key"><span class="value">Use this query-parameter to specify whether the results should be in ascending order or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">yes, no</span></span></p><p class="key"><b>order_by</b></p><p class="key"><span class="value">Use this query-parameter to get the result that is ordered by the given property.</span></p><p class="key"><span class="value">Possible Values:<span class="value">total_requests, load_time, render_time</span></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value&lt;String&gt;</span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "dns_details":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"mem_usage_bytes":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"metric_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"cpuusagepcnt":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"dns_tot_queries":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"metric_value":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"dns_tot_neg_nxdmn_entries":&lt;Double_value&gt;</font>}]}</p>
</body>
</html>

Some files were not shown because too many files have changed in this diff Show More