Professional Documents
Culture Documents
AppViewX
User Guide V10.3.X
12/15/2013
This transmission may contain information that is privileged. If you are not the intended recipient, you
are hereby notified that any disclosure, copying, distribution, or use of the information contained
herein (including any reliance thereon) is STRICTLY PROHIBITED.
Copyright Payoda Technologies 2013.
Table of Contents
How to navigate within the guide? ............................................................................................................................ 6
Introduction ........................................................................................................................................................................ 7
How it helps enterprise?................................................................................................................................................ 7
What it has?......................................................................................................................................................................... 7
How to login?...................................................................................................................................................................... 8
Device .................................................................................................................................................................................... 9
Device Management ................................................................................................................................................... 9
Control Bar ................................................................................................................................................................ 9
Device detail grid ................................................................................................................................................. 10
Device Status Log ................................................................................................................................................. 11
Add New Device.................................................................................................................................................... 12
Discover New Devices ........................................................................................................................................ 15
General controls ................................................................................................................................................... 17
Credential ................................................................................................................................................................ 18
Import Devices ...................................................................................................................................................... 18
Backup & Restore................................................................................................................................................. 19
iHealth ...................................................................................................................................................................... 31
Device Group .............................................................................................................................................................. 37
Control Bar ............................................................................................................................................................. 37
Add New Device Group ...................................................................................................................................... 37
General controls ................................................................................................................................................... 40
Software Upgrade ..................................................................................................................................................... 41
Imported Images/Hotfix ................................................................................................................................... 41
Selected Images .................................................................................................................................................... 42
Devices ..................................................................................................................................................................... 43
Account .............................................................................................................................................................................. 44
Users .............................................................................................................................................................................. 44
Control Bar ............................................................................................................................................................. 45
User detail grid...................................................................................................................................................... 45
Add New User ........................................................................................................................................................ 45
General controls ................................................................................................................................................... 48
Import a set of Users........................................................................................................................................... 48
Roles ............................................................................................................................................................................... 49
Control bar .............................................................................................................................................................. 49
Page 2 of 190
Page 5 of 190
If you are viewing the .pdf version of the document using a PDF reader, please navigate to
Bookmarks section to navigate through the document
If you are viewing the .docx version of the document using a Microsoft Word as a reader, please
navigate to View and enable Document Map to navigate through the document
Page 6 of 190
Introduction
AppViewX is an Innovative ADC (Application Delivery Control) management software which
facilitates Management, Monitoring, Statistics, Alerting and Reporting to customers who have a
overhead managing multi vendor ADC network hardware and software in an enterprise.
AppViewX smartly interacts with APIs provided by the various ADC vendors to present the
application view irrespective of vendor specific ADCs that are used.
Therefore, if you are not using an Application-Centric monitoring tool like AppViewX on your
ADN (Application Delivery Network) you might be flying half-blind.
What it has?
AppViewX is modularized software which has the following core feature set which is explained
in detail in the guide
Device
Account
Dashboard
Control Center
Configuration
Reports
Alerts
Security
Certificate
Hint: If the product version you have does not support all the features, it could be a restricted
feature of the product. Please contact our support for information.
Page 7 of 190
How to login?
AppViewX can be accessed using the AppViewX login page. To access the login page enter the
URL of the application in the web browser
The URL might look like this: http://HOSTNAME:PORTNUMBER/AppViewXNGWeb, where
HOSTNAME and PORTNUMBER are configured by the designated AppViewX administrator in
the enterprise.
Components
Specification
Web Browsers
Hint: If you have trouble logging into the application, please contact your enterprise AppViewX
administrator (or) support.
Page 8 of 190
Device
This module provides the primary functionality of adding, managing and grouping of
ADC network devices. Devices added through this module will only be available for mapping
role based access permission and managing using AppViewX.
Sub modules of device are:
Device Management
Device Group
Software Upgrade
Device Management
The landing screen of device management screen provides two sections of control,
Control bar
Device detail grid
Control Bar
Control Name
Control Description
Add
Discover
Modify
Page 9 of 190
Delete
Credential
Enable
Disable
Import
Backup & Restore
iHealth
ConfigSync
Refresh
Hint: Search bar is used to perform quick search across devices configured and performs
search with exact match criteria.
The grid displays the high level details of the devices configured to the application
Field Name
Field Description
Device Name
Failover Device
IP Address
Sub System
Device Type
Vendor
Version
No of Objects
Load Balancer
Type of primary device
Supported Device Type:
- LTM
- GTM
Vendor of sub system
Supported Vendors:
- F5
- Cisco
- Citrix
F5 supported versions:
- V10.X
- V11.X
CISCO supported versions:
- V5.X
- ADC
CITRIX supported versions:
- V9.X
Objects identified and monitored for the sub system
Page 10 of 190
Data Center
Device Group
Credential Type
Access Type
Page 11 of 190
This control provides the option of adding a new device to the application.
The landing screen of add new devices screen provides three options
Device Details
Device Group
Template Association
Device Details
This section provides the option to add a new device of network to be monitored with
AppViewX.
Page 12 of 190
Actions:
Click Save to save the data or click Cancel to clear the data and exit the Add New User page.
Field Name
Device Vendor
Sub System
Field Description
Choose the Device Vendor
Supported Vendors:
- F5
- Cisco
- Citrix
Specify the functionality of the primary device
Supported Sub System:
Load Balancer
Modules
Configure the modules of the device vendor to be accessed
F5:
- LTM (Local Traffic Manager)
- ASM (Application Security Manager)
- GTM (Global Traffic Manager)
Cisco:
- SLB (Server Load Balancer)
- GSS (Global Site Selector)
Citrix:
- SLB (Server Load Balancer)
- GSLB (Global Server Load Balancer)
Device Name
The name of the device with which it is represented and
identified in the network.
Hint: The device name has to be entered exactly as defined in
the Vendor device to find and map the failover device.
Data Center
Data center to which the network device is associated with
Device Version
Specify the supported vendor software version of the primary
device, based on which connection is established with the
device
Discover Certificates (for Enabling this selection will allow all the application to monitor
F5)
and manage the certificate of the device through certificate
management module
IP Address
IP address of the primary device to which the connection will
be established
Hint: HA Pair Name and HA Pair IP have to mentioned for
Cisco/Citrix devices
Credential Type
Displays the mode of connection to the primary device
Credential type supported:
- Manual Entry (Connection to the device is established by
collecting the credential each time the device is accessed)
- User Credentials (Connection to the device is established
with preconfigured details)
- Credential list (Connection to the device is established
with the preconfigured details based on the credential
template already created)
Access Type
Specify the Access profile (SNMP or API)
SNMP
Enter the Community String and SNMP Version
API
Enter the Username and Password
Page 13 of 190
Device Group
This section allows the device to be added to a group already defined using device group
module.
Hint: Adding devices to the group helps managing devices under group to set threshold,
configuration backup & restore and QKView generation using Device Group module.
Template Association
This section allows device to be associated to predefined configuration template.
Hint: Association of template to a device can also be done in Configuration Template module.
Where new configuration(s) can be created based on templates associated to the device and
schedule configuration push to the device.
Page 14 of 190
Field Name
Field Description
Available
Added
Actions:
Click >> Add All to add all the available templates to the newly created device.
Click << Remove All to remove all the added templates.
This control provides the option of discovering a range of devices available in the
network to be added in bulk to the application.
The landing screen of Discover screen has two Discovery Mode selected through radio button.
Range
Subnet
Page 15 of 190
Range
This section provides the option to search a set of devices in the network with a start and
ending range of IP address and add them in bulk to be monitored with AppViewX.
Field Name
Field Description
Start IP
End IP
Access Type
Community String
Available Devices
Actions:
Click Discover to perform discovery of devices based on defined details
Click Reset to refresh the screen to original state
Click Add to add the selected details to AppViewX
Page 16 of 190
Subnet
This section provides the option to search a set of devices in the network with a start and IP
address falling under the subnet allowed range and add them in bulk to be monitored with
AppViewX.
General controls
This control provides the option to change the details of an existing device which was
added using Add New Device option.
This control allows to permanently remove the selected device from managing and
monitoring capabilities from the application after delete confirmation is received.
Unmanaged to
Managed
Unmanaged from
Managed
state.
or
This control allows extracting vendor device latest configuration manually, apart
from the configuration update happening as a scheduled process by AppViewX application.
This control allows performing a refresh of the current state which brings back the
latest details of devices configured in device detail grid.
Page 17 of 190
Credential
Hint: Using credential template helps managing authentication easier when more than one
device uses the same credential to authenticate
Field Name
Field Description
Credential Name
Access Type
Import Devices
This control provides the option of adding group of devices available in the network in
bulk using the .CSV file upload to the application.
Page 18 of 190
Download the sample file and enter the details of the devices to be added. Click Upload a File
option to upload the .csv file to application which will display the devices available to be
imported.
Validate the details and select the devices to be imported. Click Import to add the devices which
will display the status of devices successfully imported and failed.
Actions:
Add more than one value using (;) in specific columns of bulk upload .CSV file
Click Cancel to return back to previous state
Page 19 of 190
Detail Grid
Field Name
Field Description
File Name
File Path
Last Modified
Size
Download
Page 20 of 190
Hint: Search option is available at each field allowing the user to find the archives by
name/path/ last modified time stamp/size
Select Archive
Select Archive section displays the archived ucs file based on its date and time of generation.
The following actions can be performed with the archives.
Download
Compare
Object Restore
Device Restore
Backup Now
Delete
Download
Clicking on the button Download saves the selected ucs backup archive and stores the file in the
selected location (as mentioned in the detail grid).
Actions:
Click OK after selecting any of the two radio button to proceed and choose Cancel to go to the
previous screen.
Page 21 of 190
Compare
Compare button allows file level comparison of any two selected archives. By default the
selected archive and the previous archive is displayed in the landing screen.
Field Name
Field Description
Search Bar
Archive 1
Archive 2
Change Summary
Page 22 of 190
Actions:
Click
Page 23 of 190
Object Restore
This button allows object level restore.
Field Name
Field Description
Object Selection
Available Objects
Selected Objects
Search
Total Records
Restore Sub-Objects
Actions:
Click Proceed which opens a screen Confirm Object Restore to proceed with the restore of
objects or choose Cancel to go to the previous screen.
Page 24 of 190
Actions:
Clicking on
Field Name
Field Description
Latest Backup
Configuration to be
restored
Actions:
Click Restore to restore object.
Page 25 of 190
Implementation Inprogress
Implementation Success
Rollback InProgress
Rolledback
On choosing Restore, the process follows a defined Work Order. Refer Configuration
Management -> Work Order Process
Configuration Log can be seen at any time by choosing the Status in Configuration Management
detail grid.
User can View Workorder which allows to rollback the restore process.
Page 26 of 190
Actions:
Click Rollback to replace with the old configuration. Specify the Reason for Rollback to display
in the log.
Device Restore
This button allows entire device restore. This is similar to Object restore.
Field Name
Field Description
Search
Latest Backup
Configuration to be
restored
Change Summary
Identical
Archive 1 and 2 are identical that no changes are made
Modified
There are three states which is highlighted in specific
colour code:
To be Added That particular file is added to the archive
To be Modified Small change is made in the archive
Actions:
Click Restore to start the process and choose Cancel to go to the previous screen.
Implementation Inprogress
Implementation Success
Rollback InProgress
Rolledback
Page 28 of 190
Settings
The settings for taking backup and restore functionalities are done here.
Page 29 of 190
Field
Field Description
No. of Archives
Supports 1 to 16 archives
Scheduler
Daily
Weekly
Monthly
Yearly
iHealth
This control generates the QKView file which provides a running snapshot of BIG-IP
system with up-to-the-minute configuration and diagnostic information.
The landing screen displays two options.
Diagnostic Report
Settings
Diagnostic Report
This section displays the QKView files as archives which are generated as per the settings by
date and time and also displays the corresponding diagnostic reports.
Page 31 of 190
Select Archive
Select Archive section displays the QKView files based on its date and time of generation.
Actions:
Click Delete QKView to delete the selected archive by comfirming.
Detail Grid
For each of the QKView files, the relevant Diagnostic report is generated and displayed below in
the grid. It depicts the issues present in the device categorized based on its level of severity as
mentioned in F5 box.
The four categories of issues referred by F5 are,
Critical
High
Medium
Low
Field Name
Field Description
Search Bar
Title
Description
More Details
Page 32 of 190
Actions:
Click
The action View All Details displays the entire Diagnostic report with the recommended
configurations to fix the issue (if any).
Page 33 of 190
Actions:
Show All displays the entire report in Detailed View
Hide All redo the Show All action thus displaying only the name of the Issue
Click
Settings
This section allows to enable or disable QKView file generation with further actions.
Page 34 of 190
Field
Field Description
No. of Archives
Scheduler
Page 35 of 190
Daily
Weekly
Monthly
Yearly
Actions:
Click Save button to save the changes and Cancel to return to the previous page
Page 36 of 190
Device Group
The landing screen of device management screen provides three sections of control
Control bar
Device group detail
Control Bar
Control Name
Control Description
Add
Modify
Delete
Refresh
This control provides the option of adding a new device group to the application.
Page 37 of 190
Page 38 of 190
Field Name
Field Description
Group Name
Description
Available
Assigned
Add Search String
Remove All
Threshold Management
This feature allows to manage the no of connections is allowed to a device for a specific time
period in hours available under the device group
Frequency(Hours)
Frequency indicates how often the application checks the
connection limit.
Connection Limit
Connection Limit specifies the maximum number of
connections the device(s) in the device group is allowed.
Scheduler
This feature allows to schedule maintenance operation against the group of devices
Configuration Backup
This control provides scheduling periodic process of
creating backup copy of configuration settings of the device
which could be used in restoring the configurations from
the archived configurations
QKView Generation Schedule This control provides scheduling periodic process of
generating qkview files which will be useful for diagnosing
threats.
Page 39 of 190
Actions:
Click >> Add Search String displays the available devices to be added. Individual devices can
be added by clicking on the device once
Click <<Remove All to remove the assigned devices from the group
Each parameter of the Scheduler can be configured to specific date and time using a schedule
period of Daily, Weekly and Specific Date
General controls
This control provides the option to change the details of an existing device group which
was added using Add New Device option.
This control allows to permanently remove the selected device group from managing and
monitoring capabilities from the application after delete confirmation is received.
This control allows performing a refresh of the current state which brings back the
latest details of devices group configured in device group detail grid.
Page 40 of 190
Software Upgrade
This module allows upgrade of device versions including
images and hotfixes in a single go.
Imported Images/Hotfix
This lists all available hotfixes/images from F5 support.
Hint: User has to download the hotfixes/images from the F5 website and save it in the path
/home/appviewx/AppViewX/properties/softwareUpgrade which is listed in the Imported
Images/Hotfix.
Page 41 of 190
Field Name
Field Description
Total Records
Selected Records
Software Image
Order
Type
Version
Build
Upload Time
Size
Checksum
Actions:
Click Delete to delete the selected software image
Click Confirm Selection to add the image to Selected Images in the right side where further
actions on upgrade is carried out.
Selected Images
This screen allows to push the images to the device.
Selected Images as mentioned above lists the images/hotfix selected from the imported
mages/hotfix.
Page 42 of 190
Devices
Field Name
Field Description
Devices
Search Bar
Device Name
HD (Hard Disk)
Status
Actions:
Click Refresh to reload the changes
Click Push Image after selecting the device check box to start the process.
at the top displays the progress state.
Click Activate & Reboot after the progress is completed which activates the new upgrade.
Page 43 of 190
Account
This module provides functionality to create and manage user details, user credentials,
roles and user groups.
Sub modules of account are:
Users
Roles
User Groups
Hint: User(s) associated with User group having more than one role will be able to access
combined features of the roles.
Users
Control bar
User detail grid
Page 44 of 190
Control Bar
Control Name
Control Description
Add
Modify
Delete
Enable
Disable
Import
Refresh
Hint: Search bar is used to perform quick search across user details and performs search with
exact match criteria.
User detail grid
Control Name
Control Description
Username
Full Name
The full name of the user is displayed (first name , last name )
Preferred Contact
Status
This control provides the option to create a new user. The landing screen provides
three sub tabs.
User Information
Roles
User Group
User Information
This tab enables to specify the user details and the credentials. Only when the mandatory fields
highlighted in bold are filled, the Roles and User Groups sub tab gets enabled.
Page 45 of 190
Control Name
Control Description
Username
Password
Confirm Password
Authenticate Externally
First Name
Last Name
Description
Email Address
Phone Number
Preferred Mode of Contact
Actions: Click Save to save the data or click Cancel to clear the data and exit the Add New
User page
Roles
Roles are a set of authorized functions and device or device objects access control defined by the
administrator which can be assigned to the user to have specific access and perform specific
actions. User can be assigned to more than one role where it inherits the permissions of both
the roles.
Hint: Roles can be managed and configured in the Roles tab
User Group
User Groups allows users to be assigned with more or more role to be easily assigned and
managed. User can be assigned to none (or) one (or) multiple user group from the available list.
Hint: User Groups can be managed and configured in the User Group tab
Page 47 of 190
General controls
This control provides the option to change the details of an existing user which was
added using Add New User option.
This control allows to permanently remove the selected user from accessing the
application based on confirmation.
Disabled to
Enabled state.
This control allows performing a refresh of the current state which brings back the
latest details of user configured in user detail grid.
This control provides the option of adding group of users to the application in bulk using
the .CSV file upload to the application.
Page 48 of 190
Download the sample file and enter the details of the users to be added. Click Upload a File
option to upload the .csv file to application which will display the users available to be imported.
Validate the details and select the users to be imported. Click Import to add the devices which
will display the status of users successfully imported and failed.
Roles
Role is a set of authorized functions and device or device objects access control rights given to
user. A user can be associated to more than one role. The landing screen of Roles screen
provides three sections of control
Control bar
Roles detail grid
Control bar
Control Name
Control Description
Add
Modify
Delete
Refresh
Page 49 of 190
This control provides the option to create a new role. The landing screen provides three sub
tabs.
Information
Authorized Functions
Access Control
Information tab
This tab enables to specify the role name and the description for which the role will be used for.
Only when the mandatory fields highlighted in bold are filled, the authorized functions and
access control sub tab gets enabled.
Authorized Functions
This tab enables to specify the roles authorized function which enables permission to what
modules the user can access when logged into AppViewX application.
Page 50 of 190
The list of primary and sub authorized functions which can be assigned to a role are given below
Control Name
Control Description
Alert
Certificate Management
Configuration Management
Device Alert
AppViewX Alert
Threshold Alert
Application Alert
Configure Settings
Clear Alerts
Views
Certificate view
Device View
VIP
Create using template
Create without template
Modify existing config
Wide IP
Create using template
Page 51 of 190
Dashboard
Device Group
Device Management
Logging
Operation
Roles
Security Policy
Statistics
Template Management
UserGroup
Users
Access Control
This tab enables to specify the roles access control which enables granular level permission
and restriction to ensure controlled permission is provided within the AppViewX application
across following where permission definition are independent of each other.
Device
Device Object
Certificate
Page 53 of 190
Device
This tab enables to specify the roles device access control permission which can be accessed
within the AppViewX by the users assigned the role.
Field Name
Field Description
This section displays the list of available devices which are in
managed and unmanaged status
Available
Assigned
Actions:
Click Read Only
to assign view only capabilities on the device(s) permission provided for
the user assigned the role.
Click Read/Write
to assign view and modify capabilities on the device(s) permission
provided for the user assigned the role.
Page 54 of 190
Actions:
>> - Add one device
<< - Remove one device
>> Add Search string Add all the devices (or) add regular expression based search
<< Remove All Remove all the devices from the Assigned section
Device object
This tab enables to specify the roles device object access control permission which can be
accessed within the AppViewX by the users assigned the role. This provides ability to provide
permission to much granular level of access at individual object level.
Page 55 of 190
Certificate
This tab enables to specify the roles certificate access control permission which can be accessed
within the AppViewX by the users assigned the role. This feature is enabled only if certificate
management feature is enabled with the application.
General controls
This control provides the option to change the details of an existing device , device
object and certificate which was added using Add New Role option.
This control allows to permanently remove the selected Role from managing and
monitoring capabilities from the application after delete confirmation is received.
This control allows performing a refresh of the current state which brings back the
latest details of roles configured in role detail grid.
Page 56 of 190
User Groups
The landing screen of User Groups screen provides these sections of control
Control bar
User group detail grid
Control Bar
Control Name
Control Description
Add
Modify
Delete
Enable
Disable
Refresh
This control provides the option to create a new user group. The landing screen
provides two sub tabs.
User Group
Roles
Page 57 of 190
User Group
This tab enables to specify the user group name and the description for which the user group
will be used for. Only when the mandatory fields highlighted in bold are filled, the roles sub tab
gets enabled.
Field Name
Field Description
Description
Threshold management
The section under user group allows administrators to define threshold limits for the users
associated to the user group to perform number of service calls to the managed devices as per
the defined frequency of hours.
Hint: This feature allows administrators to ensure the devices managed are not open for n
number of connections which could bring down the performance of the device.
Field Name
Frequency
Service Call Limit
Field Description
Define the no of hours the limitation is applicable for
This defines no of connection attempts allowed for the overall devices
for the frequency defined
Roles
The User group allows the user to select the roles which can be assigned to the group. Where
multiple roles can be associated to the user group by selecting the check box.
Page 58 of 190
General controls
This control provides the option to change the details of an existing user group which
was added using Add New User Group option.
This control allows to permanently remove the selected user group from managing and
monitoring capabilities from the application after delete confirmation is received.
Disabled to
Disabled from
Active state.
Active state.
This control allows performing a refresh of the current state which brings back the
latest details of user groups configured in user group detail grid.
Page 59 of 190
Dashboard
This module is powerful and customizable feature in AppViewX which gives the users
ability to monitor traffic statistics and ability to perform actions on objects. AppViewX loads
with dashboard as the default page.
Control bar
Dashboard work space
Control Bar
Control Name
Control Description
Dashboard list
Application list
Create Dashboard
Save
Delete
Delete a dashboard
Share the dashboard to another user with read (or) write
option
Align the widgets in the dashboard
Share
Align
Page 60 of 190
Control Name
Control Description
Dashboard list
Application list
Create Dashboard
Save
Delete
Delete a dashboard
Share the dashboard to another user with read (or) write
option
Align the widgets in the dashboard
Share
Align
Hint: By default the dashboard that the user last viewed is displayed when the user logs in
Page 61 of 190
Field Name
Field Description
Dashboard Name
Widget Type
Select any one of the widgets options from the dropdown box
- Application View
- Traffic Statistics
- Script Execution
- Traffic Grid
- Class Management
Specify name for the widget to be displayed in the dashboard
Widget Name
Traffic statistics is a line graph displaying the statistics of the device and device objects. Traffic
Statistics widget can be added by selecting the Add widget list and then clicking on the Traffic
Statistics component.
Page 62 of 190
This setting provides functionality to generate a user defined traffic statistics for the
selected applications.
Applications can be selected from the Application List option available in the control bar.
User can Select the required Object type from the drop down box and the necessary
statistics from the drop down box
Field Name
Field Description
Type
Interval
Vendor
object type
Statistics
F5 supported objects
Citrix supported objects
- WideIp
- GSLB Virtual Server
- WideIp Pool
- GSLB Service
- WideIp Pool Member
- SLB Virtual Server
- Server
- Service
- Pool
- Ltm Pool Member
- Virtual Server
Specify the particular statistics that needs to be displayed.
F5 supported Statistics
- Persist
- Preferred
- Alternate
- Fallback
- Total Dropped
Connections
- Explicit Ip
- Return to DNS
Customized statistics will be listed based on the vendor device selected which can be added
or deleted according to the user preference
Field Name
Field Description
Type
Interval
Vendor
Page 64 of 190
object type
The list of object type will be displayed. When the object type is
selected cloned components will also be created.
F5 supported objects
- WideIp
- Virtual Server
Object
Devices and device objects assigned to that user in roles tab will
be displayed.
Hint: Regular expression based search is supported
Statistics
Actions: Click Save to save the changes. A confirmation message appears if the action was
successful or failed
Page 65 of 190
Create Group
Objects can be grouped together and actions can be configured into the groups.
User can create actions for multiple objects under one group.
Two levels of sub-groups can be created, where a user can configure sub-groups to the
parent group by selecting the corresponding group name to a parent group
In the Settings window select the CreateGroup option from the drop down list
Hint: A Group which is created first will remain as the parent group for all the objects
configured in the application
Modify Group
Group can be modified by selecting the ModifyGroup option from the drop down list.
Click Save to save any changes made to the setting and to apply them to the component.
Page 66 of 190
In the Settings window select the AddObjectsToGroup option from the drop down list.
Page 67 of 190
Field Name
Field Description
Group
Vendor
Object Type
Hierarchy
F5 Object Type
Citrix Object types
Cisco Object types
- WideIp
- GSLB Virtual
- GSS Answer
- WideIp Pool
Server
Group
- WideIpPool Member - GSLB Service
- Answer
- Server
- SLB Virtual Server
- Virtual Server
- Service
- Server Farm
- Pool
- Ltm Pool Member
- RealServer
- Virtual Server
Specifies the order for the visibility of the objects under the parent
F5
-
All
All Pools
All Pool Members
WideIp Only
none
Citrix
- All
- All GSLB Services
- VIP Only
- none
Cisco
- All Answers
- Answer
Group Only
- None
Modify Objects
Select ModifyObjects from the dropdown list to modify the configuration for the required
objects.
Click Save when any changes have been made to apply them to the component.
Page 68 of 190
Create Actions
In the Settings window select the Create Actions option from the drop down list.
Actions provide functionality to control over the devices in the dashboard at each device
object level where actions supported by the vendor device can only be performed.
Control Name
Control Description
Name
Action
Confirmation message
Hint When an action is created and it is checked it is applied to all groups and sub-groups.
Page 69 of 190
Modify Actions
Select Modify Action from the dropdown list to modify the configuration for the required
actions. Click Save when any changes have been made to apply them to the component.
Control Description
Collapse/Expand
Refresh
Click this option to collapse the widget where only title bar
would be displayed or expand the widget to the normal mode
when collapsed.
Click this option to refresh the widget
Copy To
Move To
Hint: Colour indicated on the Dashboard is replicated from the vendor devices indicating its
status based Colour codes
Page 70 of 190
Applications List
The application list helps the users to dynamically add and change the device objects to be
represented in the dashboard widget for a maximum of 5 device objects.
Page 71 of 190
Traffic Grid Widget allows the user to monitor and control the Traffic
Percentage of the Applications across Data Centres. The user also has the option to view the
Status, State and Statistics for the Applications.
Traffic Grid widget can be added by selecting the Add widget button and then clicking on the
Traffic Grid component.
The Settings control allows to configure the Applications and Data Centres as required.
Applications
User can enter the application(s) as required. Applications are listed row wise in the grid.
Data Centres
User can add the Data Centre(s) which are displayed column-wise
Hint: Only users with Access control will be able to modify the settings
Page 72 of 190
Availability Status
Actions:
Click on the Legend icon and mouse over the colour indication to know the different
combinations of statuses and states of the corresponding Application.
Colors
Status
Description
Green - Available
Red - Offline
Yellow - Offline but may become
available again
Blue - Unknown
Pale Yellow - Mixture of Offline but At least one object is Offline but may
Page 73 of 190
State
Disabled state
Description
All objects disabled
Availability status
of the application
Settings control
Statistics value of
Application
Hint: The percentage value indicates the Ratio of Load Balancing which is displayed only if the
Load Balancing method is of the type Ratio.
The Settings control provides the option to configure the Individual blocks/cells for each of
the application and Data centres configured.
Page 74 of 190
Availability Status
This section allows the user to add various objects based on which the Availability Status and
State for the Application is determined. This is indicated by the colour which appears on the
block. The colour combination is mentioned in the previous table.
Hint: If the Load balancing method given to object is not of Ratio type then the NA- Not
Applicable indication will be shown
Field Name
Field Description
Vendor
Object Type
Object Name
Actions:
Click Add to add the object. Added objects will be displayed in the table below
Click Update to update any the modifications.
Click Delete to delete any objects added.
Traffic Percentage
This section allows the user to determine the Percentage of Traffic that flows through an
Application across its various Data Centres.
Page 75 of 190
Field Name
Field Description
Vendor
Object Type
Object Name
Statistics
This section allows the user to configure the setting to displays the overall Statistics value for
the Application in a Data Centre
Field Name
Field Description
Display Name
Vendor
Object Type
Object Name
Statistics Type
- Pool
- PoolMember
- Server
- Virtual Server
- LTMPool
- LTMPoolMember
Choose the Object from the list of populated Objects currently
available in the device
This field populates the different types of statistics based on the
object type selected.
Rules
Rule Type: Warning, Restriction
This option allows user to configure the settings for the various kinds of Rules to monitor and
control the Traffic Percentage for each of the Application and Data Centre.
Field Name
Field Description
Rule Type
Order
Message
Field Name
Field Description
Rule Type
Vendor
Object Type
Object Name
Action Type
Page 78 of 190
Class Management Widget allows users to view and modify the classes
associated to an iRule. Class Management widget can be added by selecting the Add widget tab
and then clicking on the Class Management component.
The Settings control provides functionalities to configure the Class Management Widget
Create Group
Classes can be grouped together and actions can be configured into the groups.
User can create actions for multiple Classes under one group.
Two levels of sub-groups can be created, where a user can configure sub-groups to the
parent group by selecting the corresponding group name to a parent group
Modify Group
Group can be modified by selecting the ModifyGroup option from the drop down list.
Click Save to save any changes made to the setting and to apply them to the component.
Create Action
Two types of Actions are available for the Create Action option. Select the required action
from the dropdown box.
This Action allows the user - View only action on the class.
Select the Group under which the class needs to be associated and provide a Name
The List of Classes will be populated under the Class box.
For the particular Class to be selected, specify the required device from the Retrieve From
Page 79 of 190
Actions:
Click Add to add the selections made. Click Save to save the changes made to the widget
Hint: Selecting the Runtime Value Check box, allows user to modify the value during
Runtime
Action: Modify Class
This Action allows the user to modify and execute the class on the widget.
Select the Group under which the class needs to be associated and provide a Name
For the particular Class to be selected, specify the required device from the Retrieve From
drop down box.
Page 80 of 190
Specify the String in the String box and Specify the corresponding Value in the Value box
List of Available values will be populated in the table. By default all the values will be
Selected and will appear in the Selected Value table
Device Association
Once the String Value Association is completed, specify the Device to which the class needs
to be associated with.
List of Devices which has the corresponding class will be listed in the Available devices
table. By default all the Devices will be selected
The list of all the actions created will be present in the table below
Page 81 of 190
Execution of Class
When a group is of type View Action, then all the attributes will be populated in the table
When a group is of type Modify Action, it will have two additional options for View Log
and Rollback
The View Log option displays the logs of the actions performed on the class
Rollback option provides options to roll back the changes done on the class
On clicking the action, a pop up appears which depends on the values that have been
selected as runtime in the widget setting option
If runtime is selected, the user can change the class name, and can select the device from the
dropdown box
If runtime is unchecked, then the data entered by user in settings will be taken
Page 82 of 190
On clicking Execute, a pop up showing the string values of the class will be appear
On clicking the action, a pop up appears which depends on the values that have been
selected as runtime in settings
If runtime is selected, the user can change the class name, and can select the device from
the dropdown box
Once the device is selected, the Selected String Values box will be auto
populated with the string values in that class
User can define class string values in the String Values box and push it to
Selected String Values box
The Available Device will show a list of devices which have the selected class
On clicking Execute, the action will be executed and log will be created
Page 83 of 190
View Log
Selecting the View Log option allows the user to view all the actions that have been
performed in the widget.
Page 84 of 190
Rollback
Rollback allows user the rollback the changes made in the action.
Page 85 of 190
The Settings control provides functionalities to associate and enter the script for execution
Field Name
Field Description
Label
Status Script
Action
Execution Script
Actions:
Click Add to add the object. Added objects will be displayed in the table below
Click Update to update any the modifications.
Execution of Script
The status script associated with last executed action will run for above step.
The View Log option displays the logs of the actions performed on the widget
For those scripts for which a back-end process is running, loading icon appears
Hint: The status colour and results that are shown in the widget are from the latest cache. The
status is grey for first time and result is empty when no action is executed
Page 87 of 190
Hint: The label will derive the colour from the action and a single line status of the action after
execution.
A widget can have a maximum of 10 labels. A label can have a maximum of 15 actions
View Logs
This option is available for all the actions performed in the ScriptExecution Widget. User can
click on the label to View this option and select View log to view the recent logs.
Page 88 of 190
Save Dashboard
When the dashboard is configured completely, Click Save to save the Dashboard. The
application requests a dashboard name. Enter a dashboard name and Click Save.
Share Dashboard
To make the Dashboard available to other users, the Dashboard must be shared.
Select Share to share a dashboard with users who have roles assigned to them which
facilitates them to view only (or) edit and modify the dashboard based on share rights
provided
Align Dashboard
Align button can be used to set the Components in a proper side by side view.
Modifying a Dashboard
Open the dashboard to be modified from the Dashboard drop down list.
All the widgets that have been configured to the dashboard can be viewed in the pane.
Click the settings button on each component to make changes to the component. Click Save
to apply changes to the component.
Page 89 of 190
Deleting a Dashboard
Open the dashboard to be deleted from the Dashboard drop down list.
Hint: If a Dashboard is shared with ReadOnly permission to other users/user groups, then it
will be deleted from all the roles. If it is shared with Read/Write permission to any of the user/
user group, then it will be deleted only from the current users view.
Page 90 of 190
Control Center
Search Bar
Search Information
Frequent Searches
Orphan Objects link
Search Bar
The Search bar allows the user to view all the devices and device objects present. This supports
keyword/regular expression search.
Page 91 of 190
This control provides user hints to optimize search criteria in order to get better search
results. On clicking the button, various hints appear that allow the user to get better search
results.
The hints provided for search are for the corresponding categories.
If the name contains special characters !,@,#,$,%,^,&,*,space,<,>,?,- provide the text within
double quotes.
Syntax: <Value>/<Value>
Example: Payoda / "Payoda-AppViewX"
Page 92 of 190
Keyword Search
Following keywords can be used to filter search for better results
Device_Name
VirtualServer_IP
VirtualServer_Port
VirtualServer_Name
Pool_Name
Pool_Monitor
PM_Name
PM_IP
PM_Port
PM_Monitor
Rules
Profiles
Syntax: <Key>:<Value>
Example: VirtualServer_Name:payoda.com
Pool_Monitor:"All
tcp"PM_IPPort:"192.168.1.232:25
AND
OR
NOT
!
+
*
?
~
Page 93 of 190
Syntax: <key>*
Example: test*
Searches for tester, testing, etc.
Single Character Search
Syntax: <character>?<character>
Example: te?t
Searches for test, text, etc.
Fuzzy Search
Syntax: <character>~
Example: roam~
Searches all keywords occurring with the characters like roma, foam, roam1, etc
Example: Combination of all types of search ("wideip.com" OR ltm*) AND !"All firepass"
Searches for all entries for wideip.com
OR keywords starting with ltm AND entries
that does not contain All firepass
Frequent Searches
Frequent searches displays the most hit applications/objects/ most used keywords. It gets
updated automatically. Another feature here is the Orphan Objects link which is explained in
detail in the next section.
Page 94 of 190
App-centric Visibility
The landing page of Control Center after selecting any of the object contains the following
sections.
Search Bar
Search Information Icon
Refresh
Grid View/List View
Actions: Click
Click Refresh
Grid View
The default landing page of Control Center is the grid view.
Once the Search is complete a list associated with the search criteria gets listed and it provides
functionalities to perform on the objects.
The grid view displays all the related searches in a more detailed manner displaying the parent
object, pool and pool members associated along with the status.
Page 95 of 190
Status of objects
Status
Description
F5
Objects in disabled state
Objects in enabled state
Colour Code
Citrix
Object is in enabled-up state
Object is in enabled-down state
Object is in disabled (out of service) state.
List View
Similar to grid view, list view also displays the corresponding results.
Page 96 of 190
Control Name
Control Description
This button is used to enable the device.
This button is used to disable the device
On clicking Expand button, the full configuration of the device
object is displayed.
This button is used to shut down the device stopping the
current process
Hint: The ENABLE/DISABLE feature is available only for administrator and other users who
have been assigned R/W permission.
Clicking on any of the object name opens up the topological view.
Topology View
An additional feature that AppViewX gives its users is the Topology View which is available both
in Grid View and List View. The Topology view shows the hierarchy in which the current object
is connected to. It allows to perform the following actions directly by right clicking on the object.
Actions available
Description
Enable/disable the objects
Shuts down the object, thus stopping the current
process
Displays the current configuration of all the
levels of the device object
Displays the server connections for 1 day/1
week/1 month/3 months
Displays the log history of the selected object.
By prefilling and filtering object details column of
the logging module page. Filter can be cleared to
view all logs
Allows to take back up of the device
Allows to restore the object configuration
Displays the alerts related to the current object.
Allows to add/remove pool members
Page 97 of 190
Actions: Objects configuration details and its functionalities can be performed by clicking on
the object
Once the operation is selected the topological view with the corresponding nodes and pool
appear with its hierarchy. Topology is displayed with colour code that indicates the availability
and server status that indicate the enabled or disabled status for each node.
Hint: Colour code and status information are obtained from the application database or the
BIG-IP/CISCO/Citrix device, which is a configurable parameter within the application.
If the device is not in Active state and if HAPair device is configured then colour code and status
information will be obtained from HAPair device.
Page 98 of 190
The application allows three levels of zoom. Each level provides an additional set of
configuration details about all the nodes displayed in the topology. Zooming can be done by the
following methods.
Mouse scroll
Zoom bar provided on the top left
Layers
Layer is an interactive feature that allows the users to modify the content visibility of the
current node.
Click
icon placed at the right hand corner of the topology page and the following drop down
box appears
Mouse over the Layers icon on the top right of the topology page and a menu appears.
Status - Allows the user see the status of the device (or not).
Details
Statistics Used to check the number of active connections on the node.
Data Center Indicates whether a Data Centre is attached to the current node. It shows
the name of the data center if there is one associated with it.
Page 99 of 190
Hint: User can view Orphan Objects in Report -> Orphan Objects Report which also has the
link to the above page
Configuration
This module provides functionality to create device object configuration template,
create and manage device specific configuration to be pushed to the device as a manual (or)
scheduled operation and perform set of defined validation to ensure device object configuration
is successful which significantly reduces the configuration management overhead.
Sub modules of configuration are:
Template Management
Configuration Management
Validation Management
Configuration Migration
Template Management
This module provides the functionality of various template
operations like creating, modifying, deleting, enabling, disabling, importing new set of XML
definitions and exporting current set of XML Definition for LTM & GTM.
A Template is defined as a form or a pattern used as a pre-defined rule / guide to create a most
commonly used configuration.
The landing screen of template has two sections,
Control bar
Device detail grid
The available template count is displayed at the right corner of the landing screen.
Control Bar
Control Name
Control Description
Create
Modify
Delete
Enable
Disable
Export
Refresh
Hint: Search bar is used to perform quick search across devices configured and performs
search with exact match criteria.
Field Description
Template Name
Template Type
Associated Devices
Associated DeviceGroups
Validated Objects
Status
Actions:
User shall filter the results in the table using Filter option(drop down box). Search is available
in some columns.
Hint: User is allowed to perform these actions only if that access is specified while specifying
roles. Refer Accounts-> Roles -> Add/Modify -> Authorised Functions -> Template
Create Template
This option allow user to define configuration details of a object to be used as a template in
configuration management.
On clicking Global Load Balancer, a pop up window appears asking for Device Vendor selection.
Click Ok to proceed. Template Configuration is supported only for F5 devices.
Topology Creation
Parameter Configuration
Device Association
Actions:
Click Save when done.
Click Cancel to go back to the previous window.
Click Next to proceed to the next step of configuring templates.
Pool or Pool Member that are added can be removed by clicking the cross icon at the right top
corner of the respective pool or pool member.
Hint: Clicking the hint icon displays a brief description of the respective field.
Field Name
Description
Name
Description
Partition
State
Alias List
IPv6 NoError Response
IPv6 NoError TTL
iRule
Load Balancing Method
Persistance
Last Resort Pool
Specifies whether the system can use this wide IP and its
resources for load balancing
Specifies alternate domain names for the web site content you
are load balancing
Specifies if the system returns a NoError response to IPv6 wide
IP requests
Specifies the NoError caching TTL values of the specified wide
IPs
Displays the name of the iRule
Specifies the load balancing method used to select a pool in this
wide IP
Specifies, when enabled, that when a local DNS makes
repetitive requests, the system reconnects the client to the
same resource
Specifies which pool, as listed in Pool List for the system to use
as the last resort pool for the Wide IP
Actions: Two or more Add/Delete operations on Partitions, Alias list, iRule, Add New pool can
be done by clicking on the add and delete icon respectively.
Pool Template Details
Pool Configurations are specified by clicking on the Pool (specific number) arrow at the right
end.
Field Name
Description
Name
State
Partition
Health Monitors
Availability Requirements
Limit Settings
Manual Resume
TTL
CNAME
Ratio
DynamicRatio
Maximum Address
Returned
Actions: Similar configuration is carried out with all the other pools under the wide IP.
Field Name
Description
Virtual Server
Partition
IP Address
Service Port
Translation
Translation Service Port
State
Order
Ratio
Health Monitors
Limit Settings
Dependency List
Field Name
Field Description
Available
Added
. If
Actions: Click >> Add All to add all the available templates to the newly created device.
Click << Remove All to remove all the added templates.
Topology Creation
Parameter Configuration
Device Association
Actions:
Click Save when done.
Click Cancel to go back to the previous window.
Click Next to proceed to the next step of configuring templates.
Pool or Pool Member that are added can be removed by clicking the cross icon at the right top
corner of the respective pool or pool member.
Field Name
Field Description
Name
Partition
SIP Profile
Description
Type
Statistics Profile
Destination Type
VLAN and Tunnel Traffic
Service Port
SNAT Pool
State
Protocol
Protocol Profile(Client)
Protocol Profile(Server)
Rate Class
Traffic Class
OneConnect Profile
NTLM Conn Pool
HTTP Profile
HTTP Compression Profile
Web Acceleration
Connection Limit
Connection Rate Limit
Connection
Rate Limit Mode
Connection Mirroring
Address Translation
Port Translation
Source Port
Clone Pool(Client)
Clone Pool(Server)
Auto Last Hop
Last Hop Pool
FTP Profile
RTSP Profile
Analytics Profile
NAT64
Stream Profile
Request Logging Profile
XML Profile
iRules
Related iRules
SSL Profile(Client)
SSL Profile(Server)
HTTP Class Profiles
Authentication Profiles
Default Persistence Profile
SMTP Profile
Fallback Persistence Profile
DNS Profile
Diameter Profile
Preserve Restrict
Change
Replicates client-side traffic (that is, prior to address
translation) to a member of the specified pool
Replicates server-side traffic (that is, prior to address
translation) to a member of the specified pool
Returns packets to the MAC address from which they were sent.
This enables you to configure auto last hop on a per-virtual
server basis
Directs reply traffic to the last hop router using the specified
pool
Specifies the FTP profile for managing FTP traffic
Specifies the Real Time Streaming Protocol (RTSP) profile for
the system to use for this virtual server
Specifies the profile to use for analytics statistics for the virtual
server. Warning: The Application Visibility and Reporting
module (HTTP Analytics) is not provisioned. Assigning an
Analytics profile is not recommended
Specifies, when checked (enabled), that the system allows IPv6
hosts to communicate with IPv4 servers
Specifies the stream profile for the system to use for this virtual
server. Stream profiles are useful when you want to search and
replace strings within a data stream, such as a TCP connection
Specifies the profile to use for logging requests and responses
for the virtual server
Specifies the XML profile to be used for XML content-based
routing. XML profiles define the matching content to look for in
the XML document
Specifies the iRules you want run on this virtual server. iRules
help automate the intercepting, processing, and routing of
application traffic.
Specifies the related iRules for the virtual server. This enables
iRule processing of data for protocols such as FTP and RTSP,
which transmit data and commands in separate channels.
Specifies the SSL profile for managing client-side SSL traffic
Specifies the SSL profile for managing server-side SSL traffic
Specifies the HTTP class profiles for the virtual server
Specifies the HTTP class profiles for the virtual server
Specifies the persistence profile you want the system to use as
the default for this virtual server
Specifies the SMTP profile for managing SMTP traffic
Specifies the persistence profile you want the system to use if it
cannot use the specified default persistence profile
Specifies the Domain Name System (DNS) profile for the system
to use for this virtual server
Specifies the Diameter profile for the system to use for this
virtual server
Actions:
Click Save and Next to continue.
Page 117 of 190
Field Name
Field Description
Name
Partition
Description
State
Health Monitors
Link QoS to Client
Link QoS to Server
Reselect Tries
Enable Request Queuing
Request Queue Depth
Request Queue Timeout
IP Encapsulation
Availability requirement
Allow SNAT
Allow NAT
Action On Service Down
Load Balancing Method
Slow Ramp Time
IP ToS to Client
IP ToS to Server
Priority Group Activation
Field Name
Field Description
Service Port
Partition
Description
State
Ratio
Priority Group
Connection Limit
Connection Rate Limit
Health Monitors
IP Encapsulation
HTTPS
Telnet
SMTP
SNMP
SNMP Trap
SSH
Others
Port numbers range from 0 to 65536
Displays the partition to which the Pool Member belongs
Add descriptive text to identify the pool
Displays whether the pool Member is available for load
balancing
Specifies the ratio weight to assign to the pool member
Specifies a number representing the priority group for the pool
member
Specifies a maximum established connection limit for a pool
member or node
Specifies the maximum number of connections-per-second
allowed for a virtual server, pool member, or node
Specifies the health monitors that the system uses to monitor
this pool member
Inherit From Pool
None
Member Specific
On choosing Member Specific, specify select monitors and
availability requirement
Specifies the IP encapsulation using either IPIP (IP
encapsulation within IP, RFC 2003) or GRE (Generic Router
Encapsulation, RFC 2784)
Inherit From Pool
None
Member Specific
On choosing Member Specific, specify select encapsulation
Field Name
Field Description
Available
Added
General controls
This control provides the option to change the details of an existing template which was
created using Create Template option.
This control allows to permanently remove the selected template from the application
after delete confirmation is received.
disabled to
enabled
state.
disabled from
This control allows performing a refresh of the current state which brings back the
latest details of templates configured.
Configuration Management
Field Name
Field Description
Work Order Id
Object Name
Type
Device Name
Creation Mode
Created By
Description
RFC Number
Implementation Time
Status
Hint: Field names have their corresponding search box with regular expression based search
criteria.
Create Object
Create Object option provides functionality to create a new object and associate the object
to the relevant groups
Field Name
Description
Device Vendor
Device Type
Groups
Device
Description
RFC Number
Impact
Reason
Implementation Time
Manual Implementation
Actions:
Once the details are filled select OK to enter the Configuration Edit Mode
Select the Object type drop down box to select the required object type and the available
objects will be populated.
Select the required objects and select Ok to get the sample configuration.
The sample configuration consists the basic configuration for the selected objects.
The user can edit these configurations by copying the configuration to the Config Editor or
the user can directly edit the configuration by using the TMSH Editor.
After completion Save the changes and select Next to proceed to Post Validation
Control Bar
Detail Grid
Control Bar
Field Name
Description
Create
Modify
Delete
Execute
Associate
Disassociate
Refresh
Create
Detail Grid
Control Name
Control Description
Description
Association Status
Success
Failure
Unexecuted
Hint: Clicking on the status displays the Execution of Test Plan page which gives the details of
the workorder process
This control provides the option to create a new test plan. One test plan can have many
numbers of test cases with different test types. This option is similar to Create Test Plan in
validation management
This control provides functionality to modify the existing Test Plan. Select the check box
near the Test Plan Name and click modify to make changes
This control provides functionality to associate Test plans to the configuration which
will be executed after configuration is implemented to the device.
Actions:
Select View Log to displays a log of the list of tests present in the Test Plan
Select Submit to sends the Test Plan for approval
Field Name
Description
Modified Configuration
Existing Configuration
Type of Change
This control provides functionality to configure and associate objects to specific Global Load
Balancer devices through configuration. Configuration can either be created using with or
without templates and the configurations are executed as individual work order over a
scheduled implementation time period
Three functionalities can be done under Global Load Balancer
Field Name
Description
Device Vendor
Groups
Device
Template Name
Description
RFC Number
Impact
Reason
Implementation Time
Manual Implementation
Actions:
Once the details are filled select OK to enter the Topology Creation Mode
Hint: An existing configuration Template cannot be edited. It can only be associated to a new
object.
This page is similar to Template Management, where a user can graphically create a GTM
Template
User can switch to Config Editor to manually edit the configuration using the config
editor/TMSH editor by Clicking the Switch to Config Editor tab
Hint: An existing configuration Template cannot be edited. It can only be associated to a new
object.
Page 133 of 190
Field Name
Description
Device Vendor
Groups
Devices
Description
RFC Number
Impact
Reason
Implementation Time
Manual Implementation
Hint: The process of creating a Global Load Balancer without template is similar to creating a
Global Load Balancer in the Template Management tab. The difference being that it is unique to
the corresponding GTM
Hint: At any point during the configuration, it is possible to switch to the Config Editor mode
and edit the settings. But changing modes will discard the entries in the existing mode
This control provides functionality to configure and associate objects to specific Local Load
Balancer devices through configuration. Configuration can either be created using with or
without templates and the configurations are executed as individual work order over a
scheduled implementation time period
Two functionalities can be done under Local Load Balancer
Field Name
Description
Device Vendor
Groups
Device
Template Name
Description
RFC Number
Impact
Reason
Implementation Time
Manual Implementation
The workflow of creating a Local Load Balancer Using template is similar to creating a
Global Load Balancer in the Template Management option.
Topology Creation>Parameter Configuration>Post Validation
Field Name
Description
Device Vendor
Groups
Devices
Description
RFC Number
Impact
Reason
Implementation Time
Manual Implementation
The work flow to create the Local Load Balancer is Similar to creating a Local Load Balancer
using Template Management
Topology Creation>Parameter Configuration>Post Validation
Work Order
Process
Comments
Actions
View
Approval
Implement
Rollback
Hint: Once the configuration is submitted, the work order appears to the user in the work
order log with respect to his access criteria.
Validation
Once the Work order gets populated in the work order logs, the user can validate the
process by selecting the corresponding work order
Clicking on the Work order ID allows the user to view the configuration settings and
provides options to perform the validation
Clicking on View Log allows the user to view details regarding the implementation
Field Name
Description
Existing Configuration
Rollback Configuration
Type of Change
Actions:
Click the Config change to compare historical configuration changes.
Click the colored icon to view the Config change.
Configuration Log
The configuration log displays the logs of the Work order. This can be viewed by clicking on the
status of the work order
Status
Description
Create
Validate
Approve
Implement
Manual Implementation
Implementation
Post Validation
Validation Management
This module helps us to create, modify, delete and execute
different kinds of test plans which can be associated to a configuration management work order
to ensure defined tests are performed and if there is a higher failure rate the configuration is
rolled back as a manual or automated process.
Control Bar
Detail Grid of Validate Management
Control Bar
Field Name
Description
Create
Modify
Delete
Execute
Hint: Search bar is used to perform quick search across test plans and performs
search with exact match criteria.
Description
Description
Last Run Status
Failure
Success
Unexecuted
Actions: Click on Success / Failure in Last Run Status to check the details of the entire test
plan.
This window gives us the Last Run Status of all the test cases inside one test plan.
Actions: Click on
detail.
to get Preview, Actual Response and Response string of the test cases in
Click on the status to view the Execution Result of Test Plan which shows the details of the
Validation Process
This control provides the option to create a new test plan. One test plan can have many
numbers of test cases with different test types.
Field Name
Description
Test Type
Name Server
- LOC
- MB
- MD
- MF
- MG
- MINFO
- MR
- MX
- NAPTR
- NIMLOC
- NSEC
- NULL
- NS
- NSAP
- NSAP-PTR
- NXT
- OPT
- PX
- RP
- RRSIG
- RT
- SIG
- SINK
- SRV
- SSHFP
- TKEY
- TSIG
- UID
- UINFO
- UNSPEC
- WKS
- X25
Under this we will have many criteria. Specify any of the criteria
with the radio button provided.
Resolver is client side DNS. The application provides with many
options under this to be configured.
- Default
- AT&T(US)
- British Telecom (UK)
- CISCO Systems (US)
- CSL (HK)
- DIGI (MY)
- Google
- Level3
- HiNet(TW)
- OpenDNS
- UUNET (CH)
- UUNET (DE)
- UUNET (UK)
- UUNET (US)
- UWA
All- Selects all the options under resolver.
Authoritative- Checks for the validity and authority.
Page 148 of 190
DIG Options
Custom Test
Command
Options
General controls
This control provides the option to change the details of an existing test case which was
created using Create Test Case option.
This control allows to permanently remove the selected test plan from the application
after delete confirmation is received.
This control allows us to run the selected test plan. As a result Last Run Status will be
updated with either Complete or Failure or Unexecuted.
Actions:
Click on Preview to check with the display preview before we add it.
Click on Add to include the test cases and test plans in validation management.
Click on Reset to clear all the data specified in the text boxes.
Click on Save to save the test plan for validation.
Click on Discard to close the test plan.
Configuration Migration
Note: This is a restricted feature and is enabled only to specific customers
The landing screen of template is the View Work order page. This page has two sections,
Control bar
Configuration detail grid
The available Workorder count is displayed at the right corner of the landing screen.
Control Bar
Control Name
Control Description
Hint: Search bar is used to perform quick search across devices configured and performs
search with exact match criteria.
The grid displays the high level view of the configurations and its statuses
Field Name
Field Description
WorkOrder ID
WorkOrder Details
Source
Destination
Implementation Time
RFC
Status
Actions:
User shall filter the results in the table using Filter option (drop down box). Search is available in
some columns.
View Environment
This module allows the user to view the Environment for the configuration. The user
can download a sample .xls file to which required modification can be performed and uploaded.
Once the File is uploaded, it can be viewed in the space which shows a snapshot view of all the
parameters available in the data sheet.
Control Name
Control Description
Sample File
Upload Parameters
Delete
Export Parameters
Import Parameters
Cancel
Appending Parameters
Click on Upload Parameter to compare an existing .xls sheet with the recently uploaded
sheet. The sheet which appears to the right can be edited.
Users can compare the changes made by selecting the Compare icon found on the top right
corner of the new sheet. The changes will be highlighted
Once the modifications are done, click Import Parameter to add the modified sheet.
Actions:
If a user clicks on "import parameters", then user B cannot edit the environment at the same time.
The other user will be shown a message "Environment is being modified. Please try after
sometime". This scenario is also applicable when user A modifies the environment using "Edit
Parameter" in Create WO
Field Name
Field Description
Work Order Id
Work Order Details
Reason
RFC
Manual Implementation
Actions:
Select the Tags from the Tag drop down box.
Check the Devices from which the configuration needs to be added
Check the Objects under each device that needs to be added
Click > to add the required device and objects
Selecting Destination Device
To Select the Destination device to which the configuration needs to be migrated click on the
Select Destination device box. A pop up will appear in which the details have to be specified
Once the source and destination device parameters are set, the configurations are loaded in
the respective columns.
Design Config columns displays the changes in the parameters
Running Config column displays the modified parameters that are currently in use in the
device
TMSH commands can also be given in the configuration.
To write commands begin with start tmsh command, the commands has to start with @#
and must end with end tmsh command
Click on the View Test Plan to view the test plan associated to the work
order. For detail on Creation on Test Plan click here
Actions:
Edit icon allows user to modify the Source/Destination configuration selection
User can edit the configurations in any columns, which will automatically reflected in the
other
Configuration columns
Submit enables the user to create the workorder for execution.
Hint: Work order once created and submitted follows the routine process of approval after
which the user with access permission can implement or rollback the configuration.
Comparing configurations
Select the configuration typ, which populates the list of tags, devices or object based on the
selection.
Selecting the Tag enables the user to change the tag level configurations
Selecting Device enables to change the tag level and device level configurations
Selecting Object enables to change the tag level, device level and object level configurations
Click Compare to compare with respect the similarity or difference.
TMSH commands can also be given in the design config module.
Report
This module provides functionality to monitor ADC network devices and make
quantified decisions using the statistics and log information.
Sub modules of configuration are:
Statistics
Logging
Statistics
This module enables application owners and engineers to compare various
traffic statistics of ADC application objects. Engineers can analyze the statistical trends to
identify issues.
The landing screen of Statistics has two main classifications.
Standard Reports
Custom Reports
Standard Reports
Standard reports provides specific reports explaining the device details, traffic summary, device
utilization and certificate management of top five WideIPs/VIPs.
Standard reports shows,
Field Name
Description
Transmission Rate
connections.
Filter Options:
- It supports filtering based on Total Connections/Current
Connections
- It can be viewed by bar chart/line graph/pie chart
- Statistics can be viewed for a specific period 1 Day/1
Week/1 Month/3 Months
Displays the transmission rate of top five VIP/Pools/Pool
Members.
Filter Options:
- It supports filtering based on Total Rate/In Rate/Out Rate
- It can be viewed by bar chart/line graph/pie chart
- Statistics can be viewed for a specific period 1 Day/1
Week/1 Month/3 Months
- Transmission Rate can be displayed either as bytes per
second or packets per second (bps/pps)
Hint: Statistics operation is same for VIP, Pool, Pool Member.
Field Name
Description
Field Name
Days to Expiration Report
Total Certificates
Filter Option
Statistics
Description
Displays the total number of certificates
It can be viewed by either bar chart or pie chart
Pie/Bar chart representing the days to expiration report of all
the certificates
-
Expired
Expiry in 30 days
Expiry in 10 days
Valid
All Manageable Certificates by Issuer
Total Certificates
Displays the total number of certificates
Filter Option
It can be viewed by either bar chart or pie chart
Statistics
Pie/Bar chart representing all manageable certificates by issuer
-
Certificate 1 classification
Certificate 2 classification
Certificate 3 classification
Certificate 4 classification
Custom Reports
By default, on clicking Custom Reports, the user last viewed report is displayed. This page
allows to edit the existing charts.
The below page is the landing screen of custom reports.
On choosing Add Chart, a drop down lists with three types of charts Line Chart, Pie Chart, Bar
Chart.
Page 163 of 190
Select anyone of them to create new chart for the existing report.
Chart Settings
Click
Field Name
Description
Chart Name
Chart Type
Timeline
Object Type
Vendor
Statistics
Object Name
+Add
Detail Grid
Actions: Click Save button after modifying the changes to the existing report. Proceed by
choosing Save from the window that pops up.
Click Delete at the right corner to delete the report.
Settings allows to modify the charts
Close allows to close the specific chart in the existing report
Select anyone of them to create new chart and define the customized report using Settings
Two or more charts can be added to a report. Click Save after completing the report.
Logging
This module is the AppViewX repository. Any changes, modifications,
deletions that any user has done on any device or device objects are tracked here. Each user will
have a different number of logs in each tab depending on the devices and objects available to
them from the Access Control List and Authorized functions list in the Roles tab.
Logging in AppViewX supports 5 kinds of logs and Settings for configuration.
Audit Log
Config Log
AppViewX Log
Syslog
Alerts Log
Hint: AppViewX stores the log for 6 months in the live database. Logs older than 6 months are
archived and can be queried by the user when needed.
The landing screen of Logging has six categories with All log as the default as below.
Field Name
Description
Time
User
Device Name
Object Details
Log Category
Severity
Log Messages
Actions:
User shall filter the results in each field using Filter option [Time (From Date: Time To Date:
Time), User, Device Name, Object Details, Log Category and Log Messages columns]. Sorting
will be available in all columns.
Hint: Total number of logs displayed here is indicative of all the logs in AppViewX.
Audit Log
All the user actions in AppViewX will be logged under this category. Each user will be able to
view his actions by default and if the user has got access (from access control) to view other
users action in his user group, their actions will also be shown in Audit log page. Also, any
clearance of any alerts from alert dashboard by a user will be logged under audit log.
Field Name
Description
Time
User
Device Name
Object Details
Log Messages
Config Log
Configuration changes of the objects being performed or accessed by the user will be logged and
displayed in here. User will be shown only to view the Config log related to the objects that are
accessible.
Field Name
Description
Time
User
Device Name
Object Details
Log Messages
Config Changes
Config Changes
A slide in window appears on clicking this icon where user can compare historical configuration
changes.
Field Name
Description
Old Configuration
New Configuration
Type of Change
Actions:
Click the Config change to compare historical configuration changes.
Click the colored icon to view the Config change.
AppViewX Log
All the device calls/actions initiated by AppViewX will be logged here.
Field Name
Description
Time
Device Name
Severity
Log Messages
Syslog
Syslog file changes will be logged and displayed here. User shall be able to view entries
corresponding to the accessible devices.
Field Name
Description
Time
Device Name
Log Messages
Alerts Log
Changes made for the alerts section by users will be logged and displayed here. User shall be
able to view entries corresponding to the accessible devices.
Field Name
Description
Time
User
Device Name
Object Details
Alert Category
Alert Severity
Log Messages
Settings
The Settings control provides functionalities to configure the log specific alerts. This
feature is used to send audit log reports via e-mail occurred during a specific duration.
Field Name
Description
User Group
Fill in the User Group for which the audit log report must be sent.
Page 173 of 190
Vendor
Object Type
Available
Added
Repeats
Email
Subject
Total No. of Records
Detail grid
Citrix
- GSLBVirtualServer
- GSLBService
- SLBVirtualServer
- ServiceGroup
- Service
Cisco
- GSSAnswerGroup
- Answer
- Virtual Server
- ServerFarm
- RealServer
Fill in the schedule field which indicates how often the report must be
sent.
- Daily
- Weekly
- Monthly
Specify the email address to send audit log reports.
Specify a customized subject.
Count of total recorded logs.
Displays all the configured reports.
Actions:
Click Add on filling the above details.
Clicking Reset, all field values will be reset without saving the new log.
Click Edit to modify the log settings.
Click Delete to delete the log.
Hint: If the validation passes and operation is completed, message stating Successfully
ad ded shall be displayed and this log will be added to the list.
If validation fails, Error message stating Details incorrect will be displayed below the
corresponding text boxes highlighted with red (Configurable)
If operation fails, message stating Operation failed will be displayed.
Alert
This module comprises the different alerts visible to the users where each user will view
alerts in each tab in the dashboard depending on the devices and objects accessible to them
from the Access control list and Authorized function in the role that is assigned to the user.
Alert types(tabs)
Alert Distribution
Devices in critical state
Applications in critical state
Alert detail grid
Settings
Hint: Clicking on View More in Validation Notification slide of Certificate Management, takes
the user to Alerts module where all the certificate alerts are listed.
Alert Types
Alert Type(tab)
Description
Certificate Alerts
Application Alerts
Device Alerts
AppViewX Alerts
Threshold Alerts
All Alerts
to configured recipient.
Includes all the device alerts raised by the alerting engine that
are accessible to AppViewX. This includes,
- Status alert sent by device is an event notification type
which should be received by alert engine and displayed in
alert dashboard.
- Syslog file will be scanned for user provided regular
expression pattern and if any match found, an alert will be
triggered in dashboard and sent via email and/or SNMP to
configured recipient.
Includes all the AppViewX alerts raised by the alerting engine.
Some of the alerts are service layer down, DB capacity alert,
license object count alert, object access cunt limit alert etc.
This is a user configured alert related to object statistics. User
shall configure threshold for any objects (accessible to him)
statistics.
Displays all the alerts raised by the alert engine.
Alert Distribution
Alert Distribution is a pie chart of distribution of alerts corresponding to the objects and devices
accessible to the user in five categories of alert severity (fatal, critical, Major, Minor and
Notification).
This alert distribution should vary for each alert category depending on tab selection.
Detail Grid
Field Name
Total no. of alerts
Common Name
Time stamp
Alert Severity
Alert category
Description
Displays the total number of alerts (Value depends on the alert
category).
Displays the from address of the email id that has been
configured at the back end
Displays the time of the occurrence of Alert
Displays the severity of this alert. There are five categories of
alert severity represented as below.
Fatal
Critical
Major
Minor
Notification
Displays the category of a specific alert.
- Certificate Alert
- Application Alert
- Device Alert
- AppViewX Alert
- Threshold Alert
- All
Page 177 of 190
Alert Name
Devices
Applications
Alert Detail
Actions:
Alerts can be cleared by selecting the alert and clicking Clear Alerts
User shall filter the results in the table using Filter option [Time (From Date: Time To Date
Time), Alert Severity and Alert Category columns] and search bar (other columns). Sorting
will be available in all columns.
Settings
Click
Settings at the right end of the alert screen to view the settings for alerts. The user can
configure the following types of alerts,
Certificate alerts
Threshold alerts
Syslog alert
General alert
Certificate alerts
Certificate alerts includes all the certificate alerts raised by the alerting engine that are
accessible to AppViewX.
Hint: Clicking on View More in Validation Notification slide of Certificate Management, takes
the user to Alerts module where all the certificate alerts are listed.
Field Name
Description
Alert Category
Alert Name
Alert Severity
Alert Message
Vendor
Device Name
Common Name
Email Configuration
SNMP Configuration
Actions:
Click Add on filling the above details.
Clicking Reset, all field values will be reset without saving the new alert.
Click Edit to modify the alert settings.
Click Delete to delete the alert.
Hint: If the validation passes and operation is completed, message stating Successfully
ad ded shall be displayed and this log will be added to the list.
If validation fails, Error message stating Details incorrect will be displayed below the
corresponding text boxes highlighted with red (Configurable)
If operation fails, message stating Operation failed will be displayed.
Threshold Alert
In threshold alert, user can configure the threshold for any objects statistics for all the objects
that are accessible to him. AppViewX collects statistics off all the objects every 30 minutes and
stores them in a database.
Field Name
Description
Vendor
Select the Vendor whose device object you are configuring the alert.
Supported Vendors
- F5
- Citrix
- Cisco
Corresponding object type for the vendor
F5
Citrix
Cisco
- WideIP
- GSLBVirtualServer - GSSAnswerGroup
- WideIP Pool
- GSLBService
- Answer
- WideIP
- SLBVirtualServer
- Virtual Server
Object Type
Object Name
Statistics
Alert Name
Alert Severity
Alert Message
Alert Condition
Operator
Value
Add New Condition
Email Configuration
SNMP Configuration
PoolMember
- Service
- ServerFarm
- Server
- RealServer
- Pool
- LTMPoolMember
- Virtual Server
Specify the name that has to be configured.
Drop down box to select the statistics for the particular vendor.
Enter an alert name that is associated with the alert.
Specify the alert severity (Fatal, Critical, Major, Minor and
Notification).
Enter an Alert Message to be displayed.
User can specify alerts in two ways.
- Single Statement Method
User specified statistic can be configured. The alert for that
statistic can be set using the operator (drop down list) and
threshold value can be specified.
- Boolean Operators
AppViewX allows the user to configure highly specific threshold
alerts using the Boolean AND and OR operators. This is done
through +Add New Condition.
Specify the operator for threshold condition (>=, <, <=, >, ==)
Specify the threshold value.
To configure an alert.
Select AND or OR condition on clicking +Add New Condition.
- AND indicates both conditions should be true for the alert to be
raised.
- OR indicates either one of the conditions is sufficient for the alert
to be raised.
Specify the other statistic, operator and value.
Method1: Notification to user through email.
Specify the Email ID and a customised Subject.
Method 2: Notification through a SNMP trap message.
Specify the following.
- Destination IP
- Port
- SNMP Version (V1 or V2)
- Community String
Count of threshold alerts.
Lists all the Threshold Alerts with detail specification of each alert
Alert Name, Severity, Alert Message, Vendor, Object Details, Statistics,
Alert Condition, Email, SNMP Details.
Hint: AppViewX collects statistics of all the objects every 30 minutes and store them in
database. Suppose say user has configured an alert threshold condition for a Statistics S of an
Object O as S > T1, whenever S value in DB goes above T1 , the configured alert will be raised in
alert dashboard and sent via email and/or SNMP to configured recipient.
Syslog alert
Alerts to be triggered specific to the key value in the syslogs for all devices managed is
configured.
Field Name
Description
Keyword Name
Key Value
Alert Severity
Alert Message
Email Configuration
SNMP Configuration
Lists all the Syslog Alerts with detail specification of each alert
Keyword Name, Key Value, Alert Severity, Alert Message, Email, SNMP
Details.
General alert
Custom alerts to be triggered specific to any change in the device is configured and categorized
as type of alert.
Field Name
Description
Vendor
Select the Vendor whose device object you are configuring the alert.
Supported Vendors
- F5
- Citrix
- Cisco
Corresponding object type for the vendor
F5
Citrix
Cisco
- WideIP
- GSLBVirtualServer - GSSAnswerGroup
- WideIP Pool
- GSLBService
- Answer
- WideIP
- SLBVirtualServer
- Virtual Server
PoolMember
- ServiceGroup
- ServerFarm
- Server
- Service
- RealServer
- Pool
- LTMPoolMember
- Virtual Server
Specify the name that has to be configured.
Select the alert category.
- Certificate Alert
- Application Alert
- Device Alert
- AppViewX Alert
- Threshold Alert
Specify the alert severity (Fatal, Critical, Major, Minor and
Notification).
Method1: Notification to user through email.
Specify the Email ID and a customised Subject.
Method 2: Notification through a SNMP trap message.
Specify the following SNMP details.
- Destination IP
- Port
- SNMP Version (V1 or V2)
- Community String
Count of all alerts based on selection.
Object Type
Object Name
Alert Category
Alert Severity
Email Configuration
SNMP Configuration
Lists all the alerts with detail specification of each alert Alert
Category, Alert Severity, Vendor, Object Type, Object Name, Email,
SNMP Details.
Page 183 of 190
Security
This module provides facility to create and manage Work orders to extract security
policies available from a device and push it to other devices.
Security Management
Security Management module allows user to select security policies, push them to other profiles
in devices and manage the security policy work orders.
Description
Work Order ID
Work Order Details
Vendor
Source
Destination
RFC Number
Implementation Time
Status
Actions: Filtering option is available across all the fields of the gird with exact match search
criteria
Create WO
This section allows user to create a security policy work order by selecting a security policy
managed by AppViewX on a source device to be pushed to multiple destination device profiles.
Security policies can be marked to be managed for a device while adding the device in Device
Management. ASM, a certified web application firewall that protects critical applications from
the most advanced threats can be selected along with the LTM while specifying the modules
while adding a device. Devices with ASM modules are managed here.
Actions: Click on Create WO to create new Work orders.
Hint: For adding ASM device, refer Device Management -> Add New Device.
Field Name
Description
Source Policy
Destination
Destination Policy
Actions:
Click >> displays the available devices to be added. Individual devices can
be added by clicking on the device once
Click <<Remove All to remove the assigned devices from the group
Click Submit to add the new Work order of the device.
Click Save to save the changes made.
Click Cancel to go back to the main page.
Security Log
Security log displays the recent history and the status of the specific work order id. It can be
checked at any point of work order process by clicking View Log or by clicking the status in the
detail grid.
Creation
Approval/Rejection
Implementation
Rollback
Hint: To assign or modify the role access, refer Accounts-> Roles -> Add/Modify -> Authorised
Functions
Comments
Actions
No actions allowed
Click Implement to
complete the work order
Click Rollback to reset the
work order
Hint: On every action, Comments can be mentioned on the prompting window which is
displayed in the Security log
AppViewX Support
For any support raise a ticket at: https://support.appviewx.com
For any support related queries contact us at: appviewx.support@payoda.com
For more information log on to: https://appviewx.com