Anda di halaman 1dari 190

PAYODA TECHNOLOGIES

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.

APPVIEWX V 10.3.X USER GUIDE

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

APPVIEWX V 10.3.X USER GUIDE

Add a New Role ..................................................................................................................................................... 49


General controls ................................................................................................................................................... 56
User Groups................................................................................................................................................................. 57
Control Bar ............................................................................................................................................................. 57
Add a New User Group....................................................................................................................................... 57
General controls ................................................................................................................................................... 59
Dashboard ........................................................................................................................................................................ 60
Control Bar ............................................................................................................................................................. 60
Creating a New Dashboard ................................................................................................................................... 61
Creating a Traffic Statistics Widget .............................................................................................................. 62
Creating an Application View Widget.......................................................................................................... 65
Applications List ................................................................................................................................................... 71
Creating a Traffic Grid Widget ........................................................................................................................ 72
Creating a Class Management Widget ......................................................................................................... 79
Creating a Script Execution Widget .............................................................................................................. 86
Save Dashboard .................................................................................................................................................... 89
Share Dashboard .................................................................................................................................................. 89
Align Dashboard ................................................................................................................................................... 89
Modifying a Dashboard ..................................................................................................................................... 89
Deleting a Dashboard ......................................................................................................................................... 90
Control Center................................................................................................................................................................. 91
Search Bar ............................................................................................................................................................... 91
Search Information Icon ................................................................................................................................... 92
Frequent Searches ............................................................................................................................................... 94
App-centric Visibility.......................................................................................................................................... 95
Topology View....................................................................................................................................................... 97
Orphan Objects Link ......................................................................................................................................... 100
Configuration................................................................................................................................................................. 101
Template Management ......................................................................................................................................... 101
Control Bar ........................................................................................................................................................... 101
Device detail grid ............................................................................................................................................... 102
Create Template ................................................................................................................................................. 102
Configuration Management ................................................................................................................................ 123
Object Detail Grid ............................................................................................................................................... 123
Object Creation-Config Editor....................................................................................................................... 124
Page 3 of 190

APPVIEWX V 10.3.X USER GUIDE

Global Load Balancer ........................................................................................................................................ 131


Local Load Balancer .......................................................................................................................................... 136
Work Order Process.......................................................................................................................................... 138
Validation Management ....................................................................................................................................... 143
Control Bar ........................................................................................................................................................... 143
Device detail grid ............................................................................................................................................... 143
Create test plan ................................................................................................................................................... 145
General controls ................................................................................................................................................. 149
Configuration Migration ...................................................................................................................................... 150
Control Bar ........................................................................................................................................................... 150
View Work Order detail grid ......................................................................................................................... 151
View Environment ............................................................................................................................................. 151
Create Work Order ............................................................................................................................................ 153
Clone Work Order .............................................................................................................................................. 158
Clone Work Order .............................................................................................................................................. 158
Report............................................................................................................................................................................... 159
Statistics...................................................................................................................................................................... 159
Standard Reports ............................................................................................................................................... 159
Custom Reports .................................................................................................................................................. 163
Logging ........................................................................................................................................................................ 166
Audit Log ............................................................................................................................................................... 167
Config Log.............................................................................................................................................................. 168
AppViewX Log ..................................................................................................................................................... 171
Syslog ...................................................................................................................................................................... 171
Alerts Log .............................................................................................................................................................. 172
Settings ................................................................................................................................................................... 173
Alert................................................................................................................................................................................... 175
Alert Types ................................................................................................................................................................ 175
Alert Distribution.................................................................................................................................................... 176
Devices in critical state (Top 10)................................................................................................................. 176
Applications in critical state (Top 10) ....................................................................................................... 177
Detail Grid ............................................................................................................................................................. 177
Settings ................................................................................................................................................................... 178
Security ............................................................................................................................................................................ 184
Security Management ........................................................................................................................................... 184
Page 4 of 190

APPVIEWX V 10.3.X USER GUIDE

Detail Grid of Work order ............................................................................................................................... 184


Create WO ............................................................................................................................................................. 185
Work order Process .......................................................................................................................................... 187
AppViewX Support ...................................................................................................................................................... 190

Page 5 of 190

APPVIEWX V 10.3.X USER GUIDE

How to navigate within the guide?


AppViewX guide is structured to make sure your reading and search for content experience is
the best.

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

APPVIEWX V 10.3.X USER GUIDE

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.

How it helps enterprise?


This tool will help the resources of the enterprise directly involved in delivery and management
of ADN starting from Application Owner and Network Administrator(s) to handle their required
tasks with maximum efficiency and ensuring proper change management is established based
on quantified statistics collected and administered on the ADCs, whereas Organization leaders
are provided with higher visibility to the network that is managed.
We understand your business and how critical it is and that is the reason why the architecture
of AppViewX is built to support High Availability with less maintenance process overhead.

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

APPVIEWX V 10.3.X USER GUIDE

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

Firefox (12 or later) , Internet Explorer (9 or later)j

Hint: If you have trouble logging into the application, please contact your enterprise AppViewX
administrator (or) support.
Page 8 of 190

APPVIEWX V 10.3.X USER GUIDE

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

This module provides the functionality of adding and managing


the network devices where all the devices in the network required to be monitored must be
added to through this module.

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

Adding a new device to the application


Discover a range of devices and add them bulk to the
application
Modify configuration of an existing device

Modify

Page 9 of 190

APPVIEWX V 10.3.X USER GUIDE

Delete
Credential
Enable
Disable
Import
Backup & Restore
iHealth
ConfigSync
Refresh

Delete the selected device


Allow to enter the user credentials
Enables the selected device
Disables the selected device
Imports a csv file used to bulk upload devices
Creates backups for the configuration either manually or
automatically
Generates Qkview files for diagnosing threats
Extracts the vendor device latest configuration
Updates the Device Management page

Hint: Search bar is used to perform quick search across devices configured and performs
search with exact match criteria.

Device detail grid

The grid displays the high level details of the devices configured to the application
Field Name

Field Description

Device Name
Failover Device

Displays the name of the primary device added


The backup device which takes up the respective operation
when the primary device fails.
Hint: Clicking on the check box near to the device name
displays the sync up pair which is highlighted in orange shade
IP address of the primary device
Functionality of the primary device
Supported Sub System:

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

APPVIEWX V 10.3.X USER GUIDE

Supported Object Types:


- Virtual Servers
- Pools
- Pool Members
Status

Data Center
Device Group
Credential Type

Access Type

Managed - Indicates the primary device is enabled and


application is communicating with the device
Unmanaged - Indicates the application is not
communicating with the device
Unresolved - Indicates the device is enabled but the
application is not able to establish a connection with the
device
Displays the data center to which the primary device is
associated to
Displays the Device Group to which the primary device is
associated to
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)
Displays the access type of the primary device
Access Types:
- SNMP
- API

Device Status Log


Clicking on the status of the device displays the detailed device status log.

Page 11 of 190

APPVIEWX V 10.3.X USER GUIDE

Add New Device

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.

Hint: Bold label sections represent mandatory fields

Page 12 of 190

APPVIEWX V 10.3.X USER GUIDE

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

APPVIEWX V 10.3.X USER GUIDE

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

APPVIEWX V 10.3.X USER GUIDE

Field Name

Field Description

Available

A list of Available templates is displayed on the left

Added

A few (or all) templates can be assigned to the primary device


by adding it to the Assigned tab on the right. (Single click)

This section allows device to be associated to predefined configuration template.

Actions:
Click >> Add All to add all the available templates to the newly created device.
Click << Remove All to remove all the added templates.

Discover New Devices

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

APPVIEWX V 10.3.X USER GUIDE

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

Specify the starting device IP range to search from


Specify the ending device IP range to search to
Specify the SNMP version
Supported Versions
- V1
- V2
Specify the community string after choosing the SNMP version
Displays a list of discovered devices with respective details
which can be added to AppViewX to manage and monitor.

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

APPVIEWX V 10.3.X USER GUIDE

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.

This control allows selected devices to be enabled from

Unmanaged to

Managed

Unmanaged from

Managed

state.

or

This control allows selected devices to be disabled to


Unresolved state.

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

APPVIEWX V 10.3.X USER GUIDE

Credential

This control provides the option of defining preconfigured template of device


authentication credentials which can be used while adding a device or discovering and adding a
range of devices available in the network using which the application authenticates to the
device(s).

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

Specify the credential template name

Access Type

Specify the Access profile (SNMP or API)


SNMP
Enter the Community String and SNMP Version
API
Enter the Username and Password

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

APPVIEWX V 10.3.X USER GUIDE

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

Backup & Restore

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
The landing screen displays two options.

Backup & Restore


Settings

Backup & Restore


This section displays the entire backup configuration available for the device which has been a
archived as per the backup settings. This consists of two sections:

Page 19 of 190

APPVIEWX V 10.3.X USER GUIDE

Select Archive displaying the latest archived files


Detail grid

Detail Grid
Field Name

Field Description

File Name

Displays the archived file name.


Hint: Clicking on the file name opens up the detailed file
details
Displays the path
Displays the date and time when it is last modified
Displays the size of the ucs file
Clicking on the button saves the selected file in the user
defined location

File Path
Last Modified
Size
Download

Page 20 of 190

APPVIEWX V 10.3.X USER GUIDE

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

APPVIEWX V 10.3.X USER GUIDE

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

Allows keyword search of any of the archive


Select the first archive to be compared and the files associated
with it are listed below
Select the second archive to be compared with the earlier and
the files associated with it are listed below
Displays the status whether the compared files are Identical or
Modified.
- Identical
Archive 1 and 2 are identical that no changes are made
- Modified
There are three states which is highlighted in specific colour
code:

Archive 2
Change Summary

Added That particular file is added to the archive


Modified Small change is made in the archive
Removed That particular file is removed from the archive
Clicking on any of the file listed opens up the file.

Page 22 of 190

APPVIEWX V 10.3.X USER GUIDE

Actions:
Click

Export to pdf at the right corner to save the archives

Page 23 of 190

APPVIEWX V 10.3.X USER GUIDE

Object Restore
This button allows object level restore.

Field Name

Field Description

Object Selection

Select the object to be restored from the below:


- Wideip
- Pool
- Pool Member
- Virtual Server
Lists the available objects under the selected object level
Lists the selected objects under the selected object level
Allows keyword search to find any particular object
Displays the total records available
Choosing this check box restores the configurations for all the
sub-objects (say pool/pool member) associated with the
selected object.

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

APPVIEWX V 10.3.X USER GUIDE

Actions:
Clicking on

displays the entire configuration of the particular selected object

Field Name

Field Description

Latest Backup

Displays the files associated with the latest backup file(last


archived file)
Select the archive to be restored

Configuration to be
restored

Displays the modifications made in the selected file


To be Added That particular file is added to the archive
To be Modified Small change is made in the archive
To be Removed That particular file is removed from the
archive
Reason for Restore

Type a message to be displayed in the audit log

Actions:
Click Restore to restore object.

Page 25 of 190

APPVIEWX V 10.3.X USER GUIDE

The process progress in the following work order:


1.
2.
3.
4.

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

APPVIEWX V 10.3.X USER GUIDE

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

Allows keyword search to find a file


Displays the files associated with the latest backup file(last
archived file)
Select the archive to be restored

Configuration to be
restored
Change Summary

Displays the status whether the compared files are Identical


or Modified.
Page 27 of 190

APPVIEWX V 10.3.X USER GUIDE

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

To be Removed That particular file is removed from the


archive
Reason for Restore

Type a message to be displayed in the audit log

Actions:
Click Restore to start the process and choose Cancel to go to the previous screen.

The process progress in the following work order:


1.
2.
3.
4.

Implementation Inprogress
Implementation Success
Rollback InProgress
Rolledback

Page 28 of 190

APPVIEWX V 10.3.X USER GUIDE

Similar steps as Object Restore is followed for Device Rollback.


Backup Now
This button allows to generate an instant backup for the current configuration. Taking a backup
may delete the oldest archive.

Choose Yes to proceed the process.


Delete
This button allows to delete the selected archive.

Choose Yes to delete the archive.

Settings
The settings for taking backup and restore functionalities are done here.

Page 29 of 190

APPVIEWX V 10.3.X USER GUIDE

Field

Field Description

Enable Configuration Backup

Selecting on this check box allows to backup device.


Two types of settings are allowed here. User can choose
the radio button to choose either device settings or use
the device group settings
- Configure Device Settings
- Use Device Group settings
Hint: This takes up the settings made in Device Group ->
Add New Device Group ->
Define the no of archives to be performed before the
backup settings is not valid any more

No. of Archives

Supports 1 to 16 archives
Scheduler
Daily
Weekly
Monthly
Yearly

Specify the starting date and time


Specify the day, repeat every 1/2/3 week(s), starting
date and time
Specify the day with date and day or by date, repeat
every 1-11 month(s), starting date and time
Specify the day with date, day, year or by date, repeat
every 1-5 year(s), starting date and time
Page 30 of 190

APPVIEWX V 10.3.X USER GUIDE

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

APPVIEWX V 10.3.X USER GUIDE

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

Allows keyword search of the report


Displays the title of the report
Displays the short description of the report
Clicking on the button pops up a detailed report of the
selected report as shown below

More Details

Page 32 of 190

APPVIEWX V 10.3.X USER GUIDE

Actions:
Click

Export to pdf at the right corner to save the diagnostic report

The action View All Details displays the entire Diagnostic report with the recommended
configurations to fix the issue (if any).

Page 33 of 190

APPVIEWX V 10.3.X USER GUIDE

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

Export to pdf at the right corner to save the diagnostic report

Settings
This section allows to enable or disable QKView file generation with further actions.

Page 34 of 190

APPVIEWX V 10.3.X USER GUIDE

Field

Field Description

Enable QKView File Generation

Selecting on this check box allows to generate QKView


file.
Two types of settings are allowed here. User can choose
the radio button to choose either device settings or use
the device group settings
- Configure Device Settings
- Use Device Group settings
Hint: This takes up the settings made in Device Group ->
Add New Device Group -> Qkview Generation Schedule
Choose the no. of archives to be generated which ranges
from 1 to 5.
Hint: Archives generated in FIFO pattern

No. of Archives
Scheduler

Page 35 of 190

APPVIEWX V 10.3.X USER GUIDE

Daily
Weekly
Monthly
Yearly

Specify the starting date and time


Specify the day, repeat every 1/2/3 week(s), starting
date and time
Specify the day with date and day or by date, repeat
every 1-11 month(s), starting date and time
Specify the day with date, day, year or by date, repeat
every 1-5 year(s), starting date and time

Actions:
Click Save button to save the changes and Cancel to return to the previous page

Page 36 of 190

APPVIEWX V 10.3.X USER GUIDE

Device Group

This module provides the functionality of managing a group


of devices to perform administrative actions and scheduled maintenance activities.

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

Adding a new device group to the application


Modify configuration of an existing device group
Delete the selected device group
Updates the Device Group page

Add New Device Group

This control provides the option of adding a new device group to the application.

Page 37 of 190

APPVIEWX V 10.3.X USER GUIDE

Page 38 of 190

APPVIEWX V 10.3.X USER GUIDE

Field Name

Field Description

Group Name
Description
Available

Specify the group name


Description of the group
Lists the available added devices. Individual devices can be
added by clicking on the device once
Lists the added devices to the group
Assigns the searched device to the selected group
Removes the assigned device from the group if added
wrongly

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

APPVIEWX V 10.3.X USER GUIDE

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

APPVIEWX V 10.3.X USER GUIDE

Software Upgrade
This module allows upgrade of device versions including
images and hotfixes in a single go.

The landing screen of software upgrade has two sections:

Imported Images/Hotfixes with Detail grid


Selected Images
Device Details

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

APPVIEWX V 10.3.X USER GUIDE

Field Name

Field Description

Total Records
Selected Records
Software Image
Order
Type
Version
Build
Upload Time
Size
Checksum

Displays the count of total number of records available


Displays the count of selected records
Displays the available images/hotfixes
Specify the order in which it has to be pushed to device
Displays the type of software image
Displays the version
Displays the build number
Displays the uploaded time
Displays the image size
Displays the digital fingerprint of the file

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

APPVIEWX V 10.3.X USER GUIDE

Devices
Field Name

Field Description

Devices
Search Bar
Device Name
HD (Hard Disk)

Displays the available device count


Allows keyword search on finding the device
Displays the name of the device
Displays the partition.
Clicking on the check box, allows to select the device to push
the image.

Status

Displays the current progress of upgrade

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

APPVIEWX V 10.3.X USER GUIDE

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

This module provides functionalities to create , manage users and associate


the user to the corresponding roles and user groups. User is an individual who uses the
application and authenticates to the application using specific username and password
maintained by AppviewX application or external enterprise servers (Eg: LDAP).

The landing screen of Users screen provides these sections of control

Control bar
User detail grid

Page 44 of 190

APPVIEWX V 10.3.X USER GUIDE

Control Bar

Control Name

Control Description

Add

Adding a new user to the application

Modify

Modify configuration of an existing user

Delete

Delete an existing user

Enable

Enable an existing user

Disable

Disable an existing user

Import

Import .csv file to import user Details

Refresh

Updates the users detail grid with latest details

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

The user name which is given to the user

Full Name

The full name of the user is displayed (first name , last name )

Preferred Contact

Contact details of the user of either Email (or) Telephone


number is displayed based on preference selected in user
creation
Displays the status of the user
Enabled Indicates the user is enabled
Disabled Indicates the user is disabled

Status

Add New User

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

APPVIEWX V 10.3.X USER GUIDE

Control Name

Control Description

Username

Specify the User name which will be used for authentication by


the user where this is
Specify any desirable password. Password should be atleast 4
characters long.
Confirm the password to be used.

Password
Confirm Password
Authenticate Externally
First Name

In this option only the user name is entered and user


authentication happens with external enterprise servers (Eg:
LDAP) if configured to the application
Specify the first name of the user

Last Name

Specify the last name of the user

Description

Specify descriptions about the user

Email Address
Phone Number
Preferred Mode of Contact

Enter the email address of the user


Enter the phone number of the user
Select the preferred mode of contact; it can either be email
address or phone number .Based on selection it will be
displayed in the user detail grid

Hint: Bold label sections represent mandatory fields


Page 46 of 190

APPVIEWX V 10.3.X USER GUIDE

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

APPVIEWX V 10.3.X USER GUIDE

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.

This control allows selected user to be change from


This control allows user(s) to access the application.

Disabled to

Enabled state.

This control allows selected user to be changed to


Disabled from
Enabled state.
This control allows the removal of access to the application for the specific user(s).

This control allows performing a refresh of the current state which brings back the
latest details of user configured in user detail grid.

Import a set of Users

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

APPVIEWX V 10.3.X USER GUIDE

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

Adding a new role to the application

Modify

Modify configuration of an existing role

Delete

Delete an existing role

Refresh

Updates the roles detail grid with latest details

Add a New Role

Page 49 of 190

APPVIEWX V 10.3.X USER GUIDE

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

APPVIEWX V 10.3.X USER GUIDE

Hint: Functions are assigned by selecting the necessary check box.


expandable menu and it allows viewing sub-options.

Indicates that there is an

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

APPVIEWX V 10.3.X USER GUIDE

Dashboard
Device Group
Device Management

Logging

Operation

Roles

Security Policy

Statistics
Template Management

Create without template


Modify existing config
Work order
View work order
Approve work order level1
Approve work order level2
Implement Work order
Rollback Work order
Application View
View Device Groups
Add/Modify Device Groups
Delete Device Groups
View Devices
Add/Modify Device
Delete Device
Device Discovery
Credential Library
Enable/Disable Device
Import/Export Devices
Backup and Restore
Download
Compare
Full Restore/ Device Restore
Half Restore/ Device Restore
Delete
Backup Settings
Self Audit log
All Audit log
Config log
AppViewX log
Syslog log
Alerts log
Configure Settings
Enable/Disable/Forcedown
Set LBMode
Set Action on ServieDown
Set Ratop
View Status
View Roles
Add Role
Modify Existing Role
Delete Existing Role
Work order
View Work order
Create Work order(Auto)
Create Work order(manual)
Approval Work order Level1
Approval Work order Level2
Implement Work order
Rollback Work order
Standard Report
Custom Report
View Template
Page 52 of 190

APPVIEWX V 10.3.X USER GUIDE

UserGroup

Users

Modify Existing Template


Delete Existing Template
Enable/Disable Template
Import/Export Template
Create Template
Global Load balancer
Local Load balancer
View UserGroups
Add UserGroups
Modify Existing UserGroup
Delete Existing UserGroup
Enable/Disable UserGroup
View User
Add User
Modify Existing User
Delete Existing User
Enable/Disable User
Import/Export 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

APPVIEWX V 10.3.X USER GUIDE

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

Hint: This section allows regular expression based assigning


devices which will assign devices currently matching the filter
criteria and also auto assign new devices added later matching
the same filter criteria
Example: Enter 1.* in enter search text section in Available
column and click on >> Add Search String to create the regular
expression of RegExp: 1.*.
Device(s) to be managed by this role can be assigned by adding
it to this section

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

APPVIEWX V 10.3.X USER GUIDE

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

APPVIEWX V 10.3.X USER GUIDE

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

APPVIEWX V 10.3.X USER GUIDE

User Groups

This module provides functionalities to create, and manage user


groups where one or more one role can be associated to a group for administrative purposes.

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

Adding a new group

Modify

Modify configuration of an existing group

Delete

Delete an existing group

Enable

Enable an existing group

Disable

Disable an existing group

Refresh

Update the group page

Add a New User Group

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

APPVIEWX V 10.3.X USER GUIDE

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

User Group Name

Specify the name of the user group

Description

Specify the details and description about the user group

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

APPVIEWX V 10.3.X USER GUIDE

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.

This control allows selected groups to be active from

Disabled to

This control allows selected groups to be moved 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

APPVIEWX V 10.3.X USER GUIDE

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.

The landing screen of Dashboard provides these sections of control

Control bar
Dashboard work space

Control Bar

Control Name

Control Description

Dashboard list

Dropdown list of available dashboards

Application list

Dropdown list of available applications

Create Dashboard

Create a new dashboard

Save

Save changes in the dashboard

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

APPVIEWX V 10.3.X USER GUIDE

Control Name

Control Description

Dashboard list

Dropdown list of available dashboards

Application list

Dropdown list of available applications

Create Dashboard

Create a new dashboard

Save

Save changes in the dashboard

Delete

Delete a dashboard
Share the dashboard to another user with read (or) write
option
Align the widgets in the dashboard

Share
Align

If no dashboard has been configured, the default landing screen is displayed

Hint: By default the dashboard that the user last viewed is displayed when the user logs in

Creating a New Dashboard


The
control provides functionality to create a new dashboard. A pop up box
appears which prompts the user to enter the details for the Dashboard

Page 61 of 190

APPVIEWX V 10.3.X USER GUIDE

Field Name

Field Description

Dashboard Name

Specify name for the dashboard

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

Actions: Additional widgets can be added to the dashboard by selecting the


Add Widget
icon from the control bar and by selecting the required widget from the dropdown list.

Creating a Traffic Statistics Widget

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

APPVIEWX V 10.3.X USER GUIDE

The Settings control provides functionalities to configure the widget.

Settings: Type Application Selection

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

Specify the application selection configuration to display the


statistics of a particular object type
Specify the Interval time to obtain the real time statistics in
minutes (MM) and seconds (SS)
Supported vendors:
- F5
- Citrix
The statistics of the object type will be displayed. When the
object type is selected cloned components will also be created.

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

Citrix supported Statistics


- Vserver hits
- Request bytes
- Response bytes
- Current Client Estimated
connections
- Spill Over Threshold
- Spill Over Hits
Page 63 of 190

APPVIEWX V 10.3.X USER GUIDE

Total DNS Requests


Total DNS Resolution
A Request
AAAA Request

Settings: Type Custom

This type of settings provides option to generate a customizable traffic statistics.

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

Specify the application selection configuration to display the


statistics of a particular object type
Specify the Interval time to obtain the real time statistics.

Interval
Vendor

Specify the vendor.


Supported vendors:
- F5
- Citrix

Page 64 of 190

APPVIEWX V 10.3.X USER GUIDE

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

Citrix supported objects


- GSLB Virtual Server
- SLB 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

Corresponding statistics for the selected vendor and object type


is allowed to be configured

Actions: Click Save to save the changes. A confirmation message appears if the action was
successful or failed

Creating an Application View Widget


Application view lets the user track changes on the applications running in the network.
Application View widget can be added by selecting the Add widget tab and then clicking on the
Application View component.

The Settings control provides functionalities to configure the Application View

Page 65 of 190

APPVIEWX V 10.3.X USER GUIDE

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

APPVIEWX V 10.3.X USER GUIDE

Add Objects to Group

In the Settings window select the AddObjectsToGroup option from the drop down list.

Objects can be viewed in the dashboard within the selected group.

Page 67 of 190

APPVIEWX V 10.3.X USER GUIDE

Field Name

Field Description

Group

Specify the name of the Parent Group

Vendor

Object Type

Specify the vendor.


Supported vendors:
- F5
- Citrix
- Cisco
List of objectypes which can be viewed on the widget

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

APPVIEWX V 10.3.X USER GUIDE

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

Specify the action that has to be displayed


Specify the action that has to be displayed. The available
options are
- Enable/Activate
- Disable/Suspend
- Forcedown
Confirmation message can be added (optional).

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

APPVIEWX V 10.3.X USER GUIDE

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.

Hint: Unlimited components can be added to the dashboard.

More Options control provides the following functionalities


Control Name

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

Copy widget to another dashboard

Move To

Move widget to another dashboard

Hint: Colour indicated on the Dashboard is replicated from the vendor devices indicating its
status based Colour codes

Page 70 of 190

APPVIEWX V 10.3.X USER GUIDE

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.

Though Objects may be selected in the AddObjectToGroup to be viewed under the


Application View widget, this list provides option to dynamically assign the objects and
applications to the groups.

Page 71 of 190

APPVIEWX V 10.3.X USER GUIDE

Creating a Traffic Grid Widget

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

APPVIEWX V 10.3.X USER GUIDE

Traffic Grid Widget

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

All objects are Available

Red - Offline
Yellow - Offline but may become
available again

All objects are Offline


All objects are Offline but may become
Available again

Blue - Unknown

All objects are unknown

Pale Green - Mixture of Available


and Other Status

At least one object is available

Pale Red - Mixture of Offline and


Other Status

At least one object is offline

Pale Yellow - Mixture of Offline but At least one object is Offline but may
Page 73 of 190

APPVIEWX V 10.3.X USER GUIDE

may become available again and become available again


other status
Pale Blue - Mixture of Unknown and At least one object is unknown
other status
Gray States
Symbol

Unlicensed/None/Failure If object is not in any of the above states

State
Disabled state

Description
All objects disabled

Mixture of Enabled and Disabled Equal number of enabled and disabled


states
Mixture of Enabled and Failure States

It has no disabled object states, it has 1


or more enabled objects but also
combined with other object states
Mixture of Disabled and Failure It does not have enabled object states, it
States
has 1 or more disabled objects but also
combined with other object states
Mixture of Enabled, Disabled and It has a combination of enabled and
Failure States
disabled objects as well as other object
states.
Failure State
This is if none of the above option
matches

Monitor/Modify Traffic Percentage


Traffic Percentage

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

APPVIEWX V 10.3.X USER GUIDE

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

Choose a device Vendor


F5 supported objects
- WideIp
- WideIp Pool
- WideIp Pool Member
- Server
- Pool
- Ltm Pool Member
- Virtual Server
Choose the Object from the list of populated Objects currently
available in the device

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

APPVIEWX V 10.3.X USER GUIDE

Field Name

Field Description

Vendor

Choose a device Vendor


F5 supported objects
- Pool Member
- Ltm Pool Member
Choose the Object from the list of populated Objects currently
available in the device.
Only if the Load Balancing method is of the type Ratio, then the
corresponding ratio value is reflected as the Traffic Percentage
value on the widget.

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

Specify a display name for the statistics which will be displayed


when the mouse hovers on the icon.

Vendor
Object Type

Choose a device Vendor


F5 supported objects
- WideIP
Page 76 of 190

APPVIEWX V 10.3.X USER GUIDE

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

Specify the Rule type


- Warning (Prompts the user with a message before execution)
- Restriction (Restricts the user from performing any changes)

Traffic Percentage Type

Order
Message

Select the condition for which the rule can be executed


- Above
- Below
- Equal
- Range
Specify the order in which the rule needs to be executed
Enter a user defined message which will appear when the traffic
percentage is a attained

Rule Type: Action


User can customize an action which will be executed accorting to the rule specified
Hint: When Rule type is set as Action the message and order will be disabled
Page 77 of 190

APPVIEWX V 10.3.X USER GUIDE

Field Name

Field Description

Rule Type

Specify the Rule type as Action

Traffic Percentage Type

Vendor

Select the condition for which the rule can be executed


- Above
- Below
- Equal
- Range
Choose the Action type that needs to be performed
- Enable
- Disable
Select the required Vendor

Object Type

Select the corresponding object type from the dropdown box

Object Name

Choose the Object name from the list of populated Objects


currently available in the device

Action Type

Page 78 of 190

APPVIEWX V 10.3.X USER GUIDE

Creating a Class Management Widget


Note: This is a restricted feature and is enabled only to specific customers

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

Select Create Action from the drop down box.

Two types of Actions are available for the Create Action option. Select the required action
from the dropdown box.

Action: View Class

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

APPVIEWX V 10.3.X USER GUIDE

drop down box.


The Actions for the respective groups will be added to the table below.

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

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
drop down box.

Page 80 of 190

APPVIEWX V 10.3.X USER GUIDE

String Value Association

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

Select Add to add the necessary String Value combinations

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

APPVIEWX V 10.3.X USER GUIDE

Execution of Class

Click on the group to view the list of actions created.

Select the corresponding action to view its functionality

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

Execution when Action is of type- View 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

APPVIEWX V 10.3.X USER GUIDE

On clicking Execute, a pop up showing the string values of the class will be appear

Execution when Action is of type- Modify Class

On clicking the action, a pop up appears which depends on the values that have been
selected as runtime in settings

The pop up will show a summary of the selected settings

If runtime is selected, the user can change the class name, and can select the device from
the dropdown box

If the runtime for Class sting value is selected

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

If runtime for device is selected

The Available Device will show a list of devices which have the selected class

User can select devices and push it to Selected Device box

On clicking Execute, the action will be executed and log will be created

Page 83 of 190

APPVIEWX V 10.3.X USER GUIDE

On successful execution, a message will appear <Action Name> successfully executed


in the notifications

A more detailed log will be shown in View Logs

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

APPVIEWX V 10.3.X USER GUIDE

Rollback
Rollback allows user the rollback the changes made in the action.

Page 85 of 190

APPVIEWX V 10.3.X USER GUIDE

Creating a Script Execution Widget

This module provides easy access to maintain and execute script


commands from the AppViewX Dashboard. These Script files are pre-written files
existing in some location of the AppViewX server.

The Settings control provides functionalities to associate and enter the script for execution

Field Name

Field Description

Label

Specify a Label name to associate the group of actions


Specify a user defined status to indicate the status of target
object/device
Specify an action name which describes the nature of the script
Specify the script that needs to be executed. These scripts are
the actual operation performing scripts

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

Click on the Label to view the list of actions created.

Select the corresponding action to view its operation


Page 86 of 190

APPVIEWX V 10.3.X USER GUIDE

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

Selecting on the Action enables the user to execute the script.

Page 87 of 190

APPVIEWX V 10.3.X USER GUIDE

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

APPVIEWX V 10.3.X USER GUIDE

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

Read/Write capabilities can be assigned to user by clicking readonly or read/write while


assigning the roles to the Dashboard.

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.

Click Save to save changes to the dashboard.

Page 89 of 190

APPVIEWX V 10.3.X USER GUIDE

Deleting a Dashboard

Open the dashboard to be deleted from the Dashboard drop down list.

Click Delete to delete the present dashboard.

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

APPVIEWX V 10.3.X USER GUIDE

Control Center

This module provides functionality to perform regular expression based search


mechanism that allows the users to directly search for an application or an object with a special
visibility to orphan objects.

The landing screen of Operation screen provides the following options.

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

APPVIEWX V 10.3.X USER GUIDE

Search Information Icon

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.

Full Text Search

To search for a specific word/object name, type in the entire name.

If the name contains special characters !,@,#,$,%,^,&,*,space,<,>,?,- provide the text within
double quotes.
Syntax: <Value>/<Value>
Example: Payoda / "Payoda-AppViewX"

Page 92 of 190

APPVIEWX V 10.3.X USER GUIDE

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

Logical Operators Search


Following operators can be used to filter search for better results

AND
OR
NOT
!
+

Syntax: <key> AND <value>


Example1:
"DemoPool2" AND "55.2.99.1"
Searches for all entries for wideip.com AND 55.2.99.1
Example2:
-Device_Name:"ltmDevice"
Searches for all entries for Device_Names that does not contain ltmDevice
Example3:
+firepass tcp
Searches all entries that should contain firepass and may contain tcp
Wildcard Search
The following wild cards can be used to filter search for better results

*
?
~

Page 93 of 190

APPVIEWX V 10.3.X USER GUIDE

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

APPVIEWX V 10.3.X USER GUIDE

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

to toggle between Grid View/List View


to refresh the search

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

APPVIEWX V 10.3.X USER GUIDE

Status of objects
Status

Description

F5
Objects in disabled state
Objects in enabled state
Colour Code

For objects in available status


For objects in offline status
For objects in offline status that might become online
again.
For objects in unlicensed/None/Failure statuses.
For objects in unknown status

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

APPVIEWX V 10.3.X USER GUIDE

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

APPVIEWX V 10.3.X USER GUIDE

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

APPVIEWX V 10.3.X USER GUIDE

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.

LB Configuration Used to Enable/Disable whether Load Balancing method and its


attributes should be shown 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

APPVIEWX V 10.3.X USER GUIDE

Orphan Objects Link


Control center provides special visibility to orphan objects, pools without parents (say wideip).
The landing screen has the similar functionalities like the earlier page with Search bar, Search
Information Bar and toggle between Grid View/List View.

Hint: User can view Orphan Objects in Report -> Orphan Objects Report which also has the
link to the above page

Page 100 of 190

APPVIEWX V 10.3.X USER GUIDE

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

Creating a new template for the topology


Update the existing templates
Delete the existing templates
Enables the selected template and is ready for configuration
management
Disables the selected template
Export template definitions in a XML format

Disable
Export

Page 101 of 190

APPVIEWX V 10.3.X USER GUIDE

Refresh

Updates the Template Management page

Hint: Search bar is used to perform quick search across devices configured and performs
search with exact match criteria.

Device detail grid


The grid displays the high level details of the devices configured to the application
Field Name

Field Description

Template Name
Template Type
Associated Devices
Associated DeviceGroups
Validated Objects
Status

Displays the name of the template configured


Type of the template(LTM/GTM/null)
Lists the devices associated with the template
Lists the device groups associated with the template
Objects implemented using this template are tracked for audit
Enable Indicates the template is ready for configuration
management
Disable Indicates the selected template cannot be used by
the user
Pending - Indicates the template creation is yet to be
completed

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 module is used to create a new configuration template which


becomes the pre-defined requirements for the load balancers.

Page 102 of 190

APPVIEWX V 10.3.X USER GUIDE

Global Load Balancer

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.

Creating Global Load Balancer template, involves three steps workflow

Topology Creation
Parameter Configuration
Device Association

Workflow 01: Create Wide IP Template Topology Creation


Key feature is the topological representation of the network. The first step of creating a
template is to create the topology to be configured by drag and drop the corresponding pool to
the parent node followed by adding the pool members to the pool.
Specify the name of the template of how it is to be represented.

Page 103 of 190

APPVIEWX V 10.3.X USER GUIDE

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.

Workflow 02: Create Wide IP Template Parameter Configuration


This step allows specify the template configuration with separate fields for defining the
configuration of wide ip, pool and pool members based on the topology defined.

Page 104 of 190

APPVIEWX V 10.3.X USER GUIDE

Hint: Clicking the hint icon displays a brief description of the respective field.

Wide IP Template Details

Page 105 of 190

APPVIEWX V 10.3.X USER GUIDE

Field Name

Description

Name
Description

Displays the name of the wide IP


Add descriptive text to identify the wide IP
Displays the partition to which the wide IP belongs

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

Hint: Bold fields are mandatory.

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.

Page 106 of 190

APPVIEWX V 10.3.X USER GUIDE

Field Name

Description

Name
State

Specifies the name of the pool


Specifies whether the pool and its resources are available for
load balancing
Specifies the partition to which the wide IP belongs

Partition
Health Monitors
Availability Requirements
Limit Settings
Manual Resume
TTL
CNAME
Ratio
DynamicRatio
Maximum Address
Returned

Specifies the health monitors that the system uses to determine


whether it can use this pool for load balancing
All/Atleast
Specifies resource thresholds or limits at the pool level
Specifies, when enabled that a member of this remain disabled
indefinitely when its status changes from up to down
Specifies the number of seconds that the IP address, once found,
is valid
Specifies the canonical name of the zone
Specifies fixed ratio to the load balancing algorithms
Specifies, when enabled, that the system applies a dynamic ratio
to the load balancing algorithms
Specifies the maximum number of available virtual servers.
Possible values are between 1 to 16
Page 107 of 190

APPVIEWX V 10.3.X USER GUIDE

Verify Virtual Server


Availability
Preferred Load Balancing
Alternate Load Balancing
Fallback Load Balancing
Fallback IPv4
Fallback IPv6

Specifies, when enabled, that the system verifies the availability


of the members before sending a connection to those resources
Specifies the load balancing mode that the system tries first
Specifies the load balancing mode that the system tries if the
Preferred method is unsuccessful in picking a poo
Specifies the load balancing mode that the system tries if both
the Preferred and Alternate methods are unsuccessful in
picking a pool
Specifies the IPv4 address of the server to which the system
directs requests when it cannot use one of its pools to do so
Specifies the IPv6 address of the server to which the system
directs requests when it cannot use one of its pools to do so

Actions: Similar configuration is carried out with all the other pools under the wide IP.

Pool Member Template Details :

Page 108 of 190

APPVIEWX V 10.3.X USER GUIDE

Field Name

Description

Choose Pool Member


Server Name

Select the Pool Member


Displays the name of the server to which the pool member
belongs
Displays the name of the virtual server to which the pool
member belongs
Displays the partition to which the wide IP belongs
Displays the IP address of the pool member

Virtual Server
Partition
IP Address
Service Port

Translation
Translation Service Port
State
Order
Ratio
Health Monitors
Limit Settings
Dependency List

Type a service port or select a type from the list.


FTP
HTTP
HTTPS
Telnet
SMTP
SNMP
SNMP Trap
SSH
Others
Port numbers range from 0 to 65536
Specifies the translation IP address for the virtual server, if
necessary
Displays the service port number for the pool member. Port
numbers range from 0 to 65536
Displays whether the pool Member is available for load
balancing
Specifies the priority within the pool for this pool member
Displays the weight to the pool member for load balancing
purposes
Specifies the health monitors that the system uses to determine
whether it can use this pool for load balancing
Specifies resource thresholds or limits at the pool Member level
Limit can be specified by Bits/Packets/Current Connections
Specifies the virtual servers on which the current virtual server
depends. If any of the specified servers are unavailable, the
current virtual server is also listed as unavailable

Workflow 03: Create Wide IP Template Device Association


The final step in creating the template is the device association. Here, the created template is
associated with multiple available devices for which this template is applicable.

Page 109 of 190

APPVIEWX V 10.3.X USER GUIDE

Field Name

Field Description

Available
Added

A list of available wide IP templates is displayed on the left


A few (or all) wide IP templates can be assigned to the primary
device by adding it to the Assigned tab on the right. (Single
click)

This section allows device to be associated to predefined configuration template.


Hint: Only after the Mandatory fields are filled and configured the template is Enabled
not it remain Pending

. 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.

Page 110 of 190

APPVIEWX V 10.3.X USER GUIDE

Local Load Balancer


This allow user to define configuration to monitor the health and performance of individual
servers in real time to use template in configuration management.
On clicking Local Load Balancer, a pop up window appears asking for Device Vendor selection.
Click Ok to proceed. Template Configuration is supported only for F5 devices.

Creating Local Load Balancer template, involves three steps workflow

Topology Creation
Parameter Configuration
Device Association

Workflow 01: Create VIP Template Topology Creation


Key feature is the topological representation of the network. The first step of creating a
template is to create the topology to be configured by drag and drop the corresponding pool to
the parent node followed by adding the pool members to the pool.
Specify the name of the template of how it is to be represented.

Page 111 of 190

APPVIEWX V 10.3.X USER GUIDE

Hint: Allows only one pool to be configured for a VIP.

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.

Workflow 02: Create VIP Template Parameter Configuration


This step allows specify the template configuration with separate fields for defining the
configuration of VIP, pool and pool members based on the topology defined.

VIP Template Details

Page 112 of 190

APPVIEWX V 10.3.X USER GUIDE

Page 113 of 190

APPVIEWX V 10.3.X USER GUIDE

Page 114 of 190

APPVIEWX V 10.3.X USER GUIDE

Field Name

Field Description

Name
Partition
SIP Profile

Displays the name of the virtual server


Specifies the partition to which the VIP belongs
Specifies the Session Initiation Protocol (SIP) profile for the
system to use for this virtual server
Provides a space where you can add descriptive text to identify
the virtual server
Specifies the attributes of this virtual server
Standard
Performance(HTTP)
Performance(Layer4)
Specifies the statistics profile to use for this virtual server.
Statistics profiles are useful when you want to use defined
statistical counters to manipulate the data while processing
traffic
Specify the destination type.
Host (Specify the address)
Network (Specify the address and mask)
Specifies the VLANs and tunnels for which the virtual server is
enabled or disabled

Description
Type

Statistics Profile

Destination Type
VLAN and Tunnel Traffic

Page 115 of 190

APPVIEWX V 10.3.X USER GUIDE

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

All VLANS and Tunnels


Enabled on (Specifies the available VLANs and tunnels and
those for which the virtual server is enabled, depending on
the setting in VLAN and Tunnel Traffic)
Disabled on (Specifies the available VLANs and tunnels and
those for which the virtual server is disabled, depending on
the setting in VLAN and Tunnel Traffic)
Select a type from the list and enter the value in the Service Port
box. Port numbers range from 0 to 65536
Specifies the name of a SNAT pool, used for implementing
selective and intelligent SNATs
Specifies whether the virtual server and its resources are
available for load balancing
Specifies a network protocol name you want the system to use
to direct traffic on this virtual server
Specifies that the selected profile is a client-side profile. The list
contains entries for each already defined client protocol profile
Specifies that the selected profile is a server-side profile
Specifies the rate class associated with the virtual server
Specifies the name or names of existing traffic classes
Specifies that the selected profile is a OneConnect profile.
Applies to Standard connections only
Specifies the profile to use for NT LAN Manager (NTLM) traffic
Specifies the HTTP profile for managing HTTP traffic
Specifies the HTTP Compression profile for managing content
compression
Specifies the Web Acceleration profile for managing the way to
cache HTTP traffic
Specifies the maximum number of concurrent connections
allowed for the virtual server. Setting this to 0 turns off
connection limits
Specifies the maximum number of connections-per-second
allowed for a virtual server, pool member, or node
Controls the scope of the rate limit defined for the virtual
server, specifically, per virtual server object, per source
address, per destination address, or a combination of source
and destination addresses
Specifies that the system mirrors connections on each member
of a redundant pair. Connection mirroring is the process of
duplicating connections from the active system to the standby
system. (May degrade performance when enabled.)
Specifies, when checked (enabled), that the system translates
the address of the virtual server.
When cleared (disabled), specifies that the system uses the
address without translation
Specifies, when checked (enabled), that the system translates
the port of the virtual server.
When cleared (disabled), specifies that the system uses the port
without translation
Specifies whether the system preserves the source port of the
connection.
Preserve
Page 116 of 190

APPVIEWX V 10.3.X USER GUIDE

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

APPVIEWX V 10.3.X USER GUIDE

Pool Template Details

Field Name

Field Description

Name
Partition
Description
State

Type the name of the pool


Displays the partition to which the Pool belongs
Add descriptive text to identify the pool
Displays whether the pool and its resources are available for
load balancing
Specify the number of monitors as being available, before that
member is defined as being in an up state
Pass Through/Specify
Pass Through/Specify
Specifies the number of times the system tries to contact a new
pool member after a passive failure
Enables TCP request queuing
Specifies the maximum number of connection requests allowed
in the queue
Specifies the maximum number of milliseconds that a
connection request can be queued until capacity becomes
available
Specifies the IP encapsulation using either IPIP (IP
encapsulation within IP, RFC 2003) or GRE (Generic Router
Encapsulation, RFC 2784) on outbound packets

Health Monitors
Link QoS to Client
Link QoS to Server
Reselect Tries
Enable Request Queuing
Request Queue Depth
Request Queue Timeout
IP Encapsulation

Page 118 of 190

APPVIEWX V 10.3.X USER GUIDE

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

Specifies whether all monitor configuration has to be passed or


atleast few which is configured for the pool
Specifies whether SNATs are automatically enabled or disabled
Specifies whether NATs are automatically enabled or disabled
Specifies how the system should respond when the target pool
member becomes unavailable
Specifies the load balancing method
Specifies the duration during which the system sends less traffic
to a newly-enabled pool member
Pass Through/Specify
Pass Through/Specify
Disable/Less than
On choosing Less than, specify whether the system load
balances traffic according to the priority number assigned to
the pool member

Pool Member Template Details

Field Name

Field Description

Choose Pool Member


Address

Select the Pool Member


Type the IP address of the pool member, or select the Node List
option to select a member from the list of configured nodes
Type a service port or select a type from the list.
FTP
HTTP

Service Port

Page 119 of 190

APPVIEWX V 10.3.X USER GUIDE

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

Workflow 03: Create VIP Template Device Association


The final step in creating the template is the device association. Here, the created template is
associated with multiple available devices for which this template is applicable.

Page 120 of 190

APPVIEWX V 10.3.X USER GUIDE

Field Name

Field Description

Available
Added

A list of available VIP templates is displayed on the left


A few (or all) VIP templates can be assigned to the primary
device by adding it to the Assigned tab on the right. (Single
click)

This section allows device to be associated to predefined configuration template.


Actions:
Click >> Add All to add all the available templates to the newly created device.
Click << Remove All to remove all the added templates.

General controls

This control provides the option to change the details of an existing template which was
created using Create Template option.

Page 121 of 190

APPVIEWX V 10.3.X USER GUIDE

This control allows to permanently remove the selected template from the application
after delete confirmation is received.

This control allows selected configuration to be enabled from

disabled to

enabled

state.

This control allows selected configuration to be disabled to


enabled or
pending state

disabled from

This control allows performing a refresh of the current state which brings back the
latest details of templates configured.

Page 122 of 190

APPVIEWX V 10.3.X USER GUIDE

Configuration Management

This module provides the functionality to create and schedule


work order (WO) based configurations using the templates created or defining a new
configuration. Each configuration defined has to go through a specific workflow of approval
process and qualified before the object configuration is implemented to the device.

The landing page of Configuration Management has the following sections,

Objects detail grid


Object Creation- Config Editor
Local Load Balance
Global Load Balancer

Object Detail Grid


The grid displays the high level details of the configured work orders defined for enabling a
device object configuration and its status

Field Name

Field Description

Work Order Id

List of Work Order Id


Page 123 of 190

APPVIEWX V 10.3.X USER GUIDE

Object Name
Type
Device Name
Creation Mode
Created By
Description
RFC Number
Implementation Time
Status

Name of the Object


Lists the type to which to object belongs to
Displays name of the device
Mode of Creation
Name of the creator of corresponding Object
Description about the object
Reference Number
Time of auto Implementation
Status of the work order
- Incomplete(configuration is incomplete)
- Rollback Failed(when Rollback is not taken effect)
- Implementation in progress(when implementation is taking
place)
- Rollback(When work order is Rolled back)
- Waiting for approval(when work order is waiting for an
approval from the user)
- Waiting for Manual Implementation(when work order is
waiting for manual Implementation)
- Post Validation(when the work order is validated)

Hint: Field names have their corresponding search box with regular expression based search
criteria.

Object Creation-Config Editor


This control provides functionality to create and configure objects in directly in AppViewX
rather than creating an object in the device and then pushing it to the application. It also
facilitates options to assign groups to the objects. Two functionalities can be done in the Object
Creation-Config Editor

Create Object
Create Object option provides functionality to create a new object and associate the object
to the relevant groups

Page 124 of 190

APPVIEWX V 10.3.X USER GUIDE

Field Name

Description

Device Vendor

List of Supported Vendors


- F5
Type of the Device
- Global Load Balancer
- Local Load Balancer
List of available groups to associate the object
List of available Devices
User defined description about the object
Reference Number
A description field to specify what is the impact of the
configuration
A description field to specify the reason for the change in
configuration request
Specify the time to trigger Implementation
Provision to authorize Manual Implementation (or)
automated implementation. Automated Implementation
triggers based on the implementation time specified

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

Page 125 of 190

APPVIEWX V 10.3.X USER GUIDE

Workflow 01: Configuration Editor Mode


The Editor provides functionality to create and modify configuration for the objects in a Config
editor or TMSH editor mode

Selecting objects to configure

Select the required objects from the Object Selection tab.

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.

Page 126 of 190

APPVIEWX V 10.3.X USER GUIDE

Editing using the Conifg Editor/TMSH Editor

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

Page 127 of 190

APPVIEWX V 10.3.X USER GUIDE

Workflow 02: Post Validation


Post Validation provides validation of the object where specific tests are executed after the
configuration is pushed into the device. The test execution result view is similar to Validation
Management.

The Post Validation Tab consist of the two section

Control Bar
Detail Grid

Control Bar

Field Name

Description

Create

Create a New Test Plan


Modify an existing Test Plan
Delete an existing Test Plan
Execute a Test Plan
Associates a Test Plan with selected Test Plan
Disassociates a Test Plan from selected Test Plan
Updates the detail grid with latest details
Create a New Test Plan

Modify
Delete
Execute
Associate
Disassociate
Refresh
Create

Page 128 of 190

APPVIEWX V 10.3.X USER GUIDE

Detail Grid

Control Name

Control Description

Test Plan Name

List of Test Plans

Description

Description about the test plan

Association Status

Displays status of the Test Plan with respect to its association.


- Associated
- Disassociated
Displays the status of Test Plan with respect to its last run
- All

Last Run Status

Success

Failure

Unexecuted

Hint: Clicking on the status displays the Execution of Test Plan page which gives the details of
the workorder process

Creating a New Test Plan

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

Modifying Test Plan

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

Page 129 of 190

APPVIEWX V 10.3.X USER GUIDE

Deleting a Test Plan

This control provides functionality to delete and existing Test Plan

Execute a Test Plan

This control provides functionality to execute the work order

Associating Test Plans

This control provides functionality to associate Test plans to the configuration which
will be executed after configuration is implemented to the device.

Disassociating Test Plans

This control provides functionality to disassociated Test plans

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

Modifying Existing Object


Modify Existing Object provides functionalities to modify an already existing object. The
options is similar to that of a create object window when changes are performed on a existing
configuration the changes will be higlighted

Page 130 of 190

APPVIEWX V 10.3.X USER GUIDE

Field Name

Description

Modified Configuration

Modified configuration is displayed in the left side


Existing configuration is displayed in the right side
Colored circles indicate the type of change to the
configuration.
Added: New Config line added
Modified: Previous Config line removed
Remove: Previous Config line modified

Existing Configuration
Type of Change

Global Load Balancer

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

Page 131 of 190

APPVIEWX V 10.3.X USER GUIDE

Create using template


Create using Template provides functionality to create pre-defined configurations settings
for a Global load balancer associated to the device. Templates come in handy when there is a
need to create a commonly used configuration.

Field Name

Description

Device Vendor

List of Supported Vendors


- F5
List of available groups to associate the object
List of available Devices

Groups
Device
Template Name
Description
RFC Number
Impact
Reason
Implementation Time
Manual Implementation

Select the Template Name from the existing Template name


User defined description about the template
Reference Number
A description field to specify what is the impact of the
configuration
A description field to specify the reason for the change in
configuration request
Specify the time to trigger Implementation
Provision to authorize Manual Implementation (or) automated
implementation. Automated Implementation triggers based on
the implementation time specified

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.

Workflow 01: Topology Creation


Page 132 of 190

APPVIEWX V 10.3.X USER GUIDE

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

Workflow 02: Parameter Configuration

Hint: An existing configuration Template cannot be edited. It can only be associated to a new
object.
Page 133 of 190

APPVIEWX V 10.3.X USER GUIDE

Workflow 03: Post Validation


Post Validation provides validation of the object where specific tests are executed after the
configuration is pushed into the device. The functionality is similar to Object Creation-Config
Editor post validation process. The test execution result view is similar to Validation
Management.
Create without Template
Create without Template provides functionality to create configurations settings for a Global
load balancer without any template this helps the user to skip the Work Order approval process
since they are already validated templates.

Field Name

Description

Device Vendor

List of Supported Vendors


- F5
List of available groups to associate the object
List of available Devices
User defined description about the template
Reference Number
A description field to specify what is the impact of the
configuration
A description field to specify the reason for the change in
configuration request
Specify the time to trigger Implementation
Provision to authorize Manual Implementation (or)
automated implementation. Automated Implementation
triggers based on the implementation time specified

Groups
Devices
Description
RFC Number
Impact
Reason
Implementation Time
Manual Implementation

Page 134 of 190

APPVIEWX V 10.3.X USER GUIDE

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

Workflow 01: Topology Creation

Workflow 02: Parameter Configuration

Page 135 of 190

APPVIEWX V 10.3.X USER GUIDE

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

Workflow 03: Post Validation


Post Validation provides validation of the object where specific tests are executed after the
configuration is pushed into the device. The functionality is similar to Object Creation-Config
Editor post validation process. The test execution result view is similar to Validation
Management.
Modifying Existing Configuration
Modify Existing Config provides functionality to modify an already existing Global load
balancer configuration. The window is similar to that of a create using template.

Local Load Balancer

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

Creating Using Template


Create using Template provides functionality to create pre-defined configurations settings
for a Local load balancer associated to the device. Templates come in handy when there is a
need to create a commonly used configuration.

Page 136 of 190

APPVIEWX V 10.3.X USER GUIDE

Field Name

Description

Device Vendor

List of Supported Vendors


- F5
List of available groups to associate the object
List of available Devices
Specify a name to the template
User defined description about the template
Reference Number

Groups
Device
Template Name
Description
RFC Number
Impact
Reason
Implementation Time
Manual Implementation

A description field to specify what is the impact of the


configuration
A description field to specify the reason for the change in
configuration request
Specify the time to trigger Implementation
Provision to authorize Manual Implementation (or) automated
implementation. Automated Implementation triggers based on
the implementation time specified

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

Creating without Template


Create without Template provides functionality to create configurations settings for a Local
load balancer without any template this helps the user to skip the Work Order approval process
since they are already validated templates.

Page 137 of 190

APPVIEWX V 10.3.X USER GUIDE

Field Name

Description

Device Vendor

List of Supported Vendors


- F5
List of available groups to associate the object
List of available Devices
User defined description about the template
Reference Number
A description field to specify what is the impact of the
configuration
A description field to specify the reason for the change in
configuration request
Time of Implementation
Provision to authorize Manual Implementation (or) automated
implementation. Automated Implementation triggers based on
the implementation time specified

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


The work Order Process facilitates the hierarchical approval process for implementation of the
configured Objects/Global Load Balancer/Local Load Balancer. Only when the user of the
highest authority validate the process, it becomes implemented.

Role based access for Word Order


Users are assigned with roles for Work order by providing accessibility in the Roles option

Page 138 of 190

APPVIEWX V 10.3.X USER GUIDE

The Work Order process flow


View Work order
Approval Work order
Implement Work order
Rollback Work order
Configure the Objects/Global Load Balancer/Local Load Balancer and then Submit it for
approval. The access criteria for validation is determined when the roles are assigned to the
user

Work Order
Process

Comments

Actions

View

Accessibility only to view the process


to be implemented

User can view the Work order


in the work order logs

Approval

Accessibility to Approve or Reject the


work order (there can be many
approvers for a work order)

Accessibility to Implement the


process and then proceed to Post
Validation
Accessibility to Rollback the
implementation (if the approvers do
not approve, then the implementation
rollback automatically takes place)

Implement
Rollback

Click Approve to approve


an implementation
Click Reject to reject an
implementation
Click Implement to
implement the work order
Click Rollback to rollback
the implementation of the
work order

Page 139 of 190

APPVIEWX V 10.3.X USER GUIDE

Rollback can be performed on a new


object creation (or) object
modification. Where modification
rollback object will replace the old
configuration settings.

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

Rollback- Configuration changes


A slide in window appears on clicking the Rollback icon where user can compare historical
configuration changes before proceeding to rollback

Page 140 of 190

APPVIEWX V 10.3.X USER GUIDE

Field Name

Description

Existing Configuration

Previous configuration is displayed here.


Current configuration changes are displayed here.
Coloured circles indicate the type of change to the
configuration.
Added: New Config line added
Modified: Previous Config line removed
Remove: Previous Config line modified
- Up arrow : Navigates to the next change in configuration
towards top
- Bottom arrow : Navigates to the next change in
configuration towards bottom

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

Page 141 of 190

APPVIEWX V 10.3.X USER GUIDE

Status

Description

Create
Validate

Displays status on time of creation


Displays status on the Validation process
Displays details about the approval process by users
Displays details about the implementation process
Displays status on the Manual Implementation
Displays status on the Implementation process
Displays the Post validation details

Approve
Implement
Manual Implementation
Implementation
Post Validation

Page 142 of 190

APPVIEWX V 10.3.X USER GUIDE

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.

The landing screen of validation has two sections,

Control Bar
Detail Grid of Validate Management

Control Bar

Field Name

Description

Create
Modify
Delete
Execute

Create a new test plan in the validation management.


To make changes in the already existing test plan.
To delete the test plan from the validation management.
To run the test plan.

Hint: Search bar is used to perform quick search across test plans and performs
search with exact match criteria.

Device detail grid


Field Name

Description

Test Plan Name

Specifies name of the test plan.

Page 143 of 190

APPVIEWX V 10.3.X USER GUIDE

Description
Last Run Status

Describes about the test plan.


Specifies the run status with colors.
-

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

Page 144 of 190

APPVIEWX V 10.3.X USER GUIDE

Create test plan

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.

Page 145 of 190

APPVIEWX V 10.3.X USER GUIDE

Field Name

Description

Test Plan Name


Description
Test Name
Description

Specify name of the test plan to be created.


Describe about the test plan.
Specify name of the test.
Describe about the test.
Page 146 of 190

APPVIEWX V 10.3.X USER GUIDE

Test Type

Specify any one test type from


- HTTP
- HTTPS
- TCP
- UDP
- DIG
- Customized Test
HTTP- Hyper Text Transfer Protocol HTTPS- Hyper Text Transfer Protocol Secure
URL
Specify the Uniform Resource Locator for testing.
User Name
Specify the user name.
Password
Specify the password.
Method
This provides the way data to be transferred.
- GET(Specify the response string)
- POST(Specify the POST value and response string)
Response String
Specify the response we expect.
Name
Name of the Header
Value
Value of the Header
TCP- Transmission Control Protocol UDP User Datagram Protocol
IP
Specify the IP address.
Port
Specify the port number.
Send String
Specify to establish connection to the receiver.
Receive String
Specify to get acknowledge from the receiver once the
connection established.
DIG- Domain Information Grouper
Host name
Specify the host name.
DIG Type
Specify one type in many
Any
- A
- AXFR
- CNAME
- MX
- NS
- PTR
- SOA
- TXT
- A6
- AAAA
- AFSDB
- APL
- ATMA
- CERT
- DNAME
- DNSKEY
- DS
- EID
- GID
- GPOS
- HINFO
- ISDN
- KEY
- KX
Page 147 of 190

APPVIEWX V 10.3.X USER GUIDE

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

APPVIEWX V 10.3.X USER GUIDE

DIG Options
Custom Test
Command

Options

NIC Root Server- Network Interface Card root server.


Others- Specify the name server in text.
Choose the option we need with the help of check box provided.
- Short Provides short form of information.
- No Recursive Avoids repetition of information.
Specify the command in many provided in drop down box list.
- wget- for non-interactive download of files from web.
- curl Transfers a URL.
- dig - DNS lookup utility.
- nslookup - Obtains the domain name or IP address.
- nmap - Performs network scan.
- ping Verifies device for communication
- nc- Debugs and tests the network.
- traceroute Identifies connection problem.
- netstat Displays detailed network status information.
- top- Displays top CPU processes.
Specify the option in text.

Hint: Bold label sections represent mandatory fields

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.

Page 149 of 190

APPVIEWX V 10.3.X USER GUIDE

Configuration Migration
Note: This is a restricted feature and is enabled only to specific customers

This module helps to manage and migrate the configurations across


multiple environments. Users can import a xls file which can contains the necessary parameters
that can be used to provide the values for the necessary configurations

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

View Work Order


Create Work Order
Clone Work Order
View Environment
Compare Configuration

View the List of Work Orders and their status


Create a new Work Order
Clone an Existing Work Order
View an uploaded Environment
Compare One configuration file with another

Hint: Search bar is used to perform quick search across devices configured and performs
search with exact match criteria.

Page 150 of 190

APPVIEWX V 10.3.X USER GUIDE

View Work Order detail grid

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

WorkOrder Id for the configuration


Description about the Configuration corresponding to the WO
Source from where the configuration is present
Destination to where the configuration needs to be pushed
Specify the time to trigger Implementation
Reference Number
Status of the work order
- Incomplete(configuration is incomplete)
- Waiting for approval(when work order is waiting for an
approval from the user)
- Waiting for Manual Implementation(when work order is
waiting for manual Implementation)
- Waiting for Resubmit
- Implementation in progress
- Post Validation Completed(when the work order is
validated)

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.

Page 151 of 190

APPVIEWX V 10.3.X USER GUIDE

Control Name

Control Description

Sample File

Select to download the sample .xls file to which modifications


can be performed
Upload the .xls sheet which the user has created to AppViewX
Delete the Uploaded sheet
Export the parameters from AppViewX to the users destination

Upload Parameters
Delete
Export Parameters
Import Parameters
Cancel

Import the parameters to the perform a comparison with the


existing .xls sheet.
Cancel the import action

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.

Page 152 of 190

APPVIEWX V 10.3.X USER GUIDE

Hint: Wild Card usage


If a device d1 has iRule ABC, ABD, ABX, then user can define the environment sheet as
Env
dev
prod
Device
d1
iRule
AB*
Variable www
http
In this case the string "www" is replaced by "http" in ABC, ABD, ABX

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

Create Work Order


This tab allows the user to implement the configurations that have been uploaded.
The system follows a Work Order based process execute the actions.

Page 153 of 190

APPVIEWX V 10.3.X USER GUIDE

Field Name

Field Description

Work Order Id
Work Order Details
Reason
RFC
Manual Implementation

Id number will automatically be generated


User defined description on the work order
User defined Reason for the Work order
Reference Number
Provision to authorize Manual Implementation (or) automated
implementation. Automated Implementation triggers based on
the implementation time specified
Provision to Enable/Disable post validation

Post Approval Validation

Selecting Source Configuration


To Select the source configuration click on the Select Source Object box. A pop up will appear in
which the details have to be specified

Page 154 of 190

APPVIEWX V 10.3.X USER GUIDE

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

Page 155 of 190

APPVIEWX V 10.3.X USER GUIDE

View and Compare Configuration

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 Parameter icon to view the paremeters. Any


modifications done in this sheet will be reflected in the environment.

Page 156 of 190

APPVIEWX V 10.3.X USER GUIDE

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.

Page 157 of 190

APPVIEWX V 10.3.X USER GUIDE

Clone Work Order


This tab allows the user to clone an existing configuration. This cloned configuration
is created as a new work order and the configurations can be modified.

Clone Work Order


This Tab allows the user to compare the configurations between different
devices or objects in the source/destination 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.

Page 158 of 190

APPVIEWX V 10.3.X USER GUIDE

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,

Traffic Summary Report


Device Utilization Report
Certificate Management Reports

Page 159 of 190

APPVIEWX V 10.3.X USER GUIDE

Traffic Summary Report


Traffic Summary Report shows the statistics of top five WideIPs/VIPs in two separate reports.
GTM in the left represents the statistics of top five WideIPs based on the total DNS requests with
success/failure rate of the same and LTM in the right represents the statistics of top five VIPs
/Pools/Pool Members based on total connections with transmission rate.

Field Name

Description

Global Traffic Manager (GTM)


Total DNS Requests
Displays the statistics of top five WideIPs based on the total
DNS requests.
Filter Options:
- It supports filtering based on Total DNS Requests/New DNS
Requests
- It can be viewed by either bar chart or line graph
- Statistics can be viewed for a specific period 1 Day/1
Week/1 Month/3 Months
Success/Failure Rate
Displays the success/failure rate of top five WideIPs.
Filter Options:
- It supports filtering based DNS Success Rate/DNS Failure
Rate
- It can be viewed by either bar chart or line graph
- Statistics can be viewed for a specific period 1 Day/1
Week/1 Month/3 Months
Local Traffic Manager (LTM)
Connections
Displays the statistics of top five VIPs based on the client total
connections and Pools/Pool Members based on the server total
Page 160 of 190

APPVIEWX V 10.3.X USER GUIDE

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.

Device Utilization Report


Device Utilization Report shows the statistics of top five devices and bottom five devices.
Memory and CPU Utilization in the left represents the statistics of top five devices and bottom
five devices based on the AppViewX memory. Total Connections in the right represents the
statistics of top five devices and bottom five devices based on total connections at server side
and client side.

Page 161 of 190

APPVIEWX V 10.3.X USER GUIDE

Field Name

Description

Memory and CPU Utilization of AppViewX application


Memory Utilization
Displays the memory utilization of top five devices and bottom
five devices
Filter Options:
- It can be viewed by either bar chart or line graph
- Statistics can be viewed for a specific period 1 Day/1
Week/1 Month/3 Months
CPU Utilization
Displays the CPU utilization of top five devices and bottom five
devices
Filter Options:
- It can be viewed by either bar chart or line graph
- Statistics can be viewed for a specific period 1 Day/1
Week/1 Month/3 Months
Total Connections
Server Side
Displays the statistics of top five devices by server side total
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
Client Side
Displays the statistics of top five devices by client side total
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
Certificate Management Reports
Certificate Management Reports shows the certificate statistics which includes two reports, one
is the days to expiration report and the second report on the right is about all the manageable
certificates by issuer.

Page 162 of 190

APPVIEWX V 10.3.X USER GUIDE

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

APPVIEWX V 10.3.X USER GUIDE

Select anyone of them to create new chart for the existing report.

Chart Settings
Click

Settings option in each chart which allows customising the report.

Field Name

Description

Chart Name
Chart Type
Timeline
Object Type
Vendor
Statistics
Object Name
+Add
Detail Grid

Specify the chart name


Specify the type of the chart
Specify the period of 1 day/1 week/1 month/3 months
Specify the type of the object
Specify the Vendor
Specify the Statistics
Adds new objects to the chart
Displays the details of objects associated with the chart

Page 164 of 190

APPVIEWX V 10.3.X USER GUIDE

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

Creating a new Custom Report


Creating a custom report allows to create a statistic report based on the user requirements. User
is extended with choosing which wideip or vip is needed.
Switch to Create CustomReport from the existing report by clicking the control bar. On choosing
Add Chart, a drop down lists with three types of charts Line Chart, Pie Chart, Bar Chart.

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.

Page 165 of 190

APPVIEWX V 10.3.X USER GUIDE

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.

Page 166 of 190

APPVIEWX V 10.3.X USER GUIDE

Field Name

Description

Total No. of logs

Displays the total number of logs (Value depends on the alert


category).
Column to display the log time. By default logs will be sorted
based on Timestamp from latest to oldest.
Column to display the user under whose login that particular
action has happened.
Column to display the device in which this log event occurs.
Column to display the object type and object name in which
this log event occurs
Specifies the type of log.
- Audit Log
- Config Log
- AppViewX Log
- Syslog
- Alerts Log
Displays the severity of the log which is applicable only for
Alert logs. There are five categories of alert severity
represented as below.
Fatal
Critical
Major
Minor
Notification
N/A refers to all the other events.
Column to display the specified log details.

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.

Page 167 of 190

APPVIEWX V 10.3.X USER GUIDE

Field Name

Description

Total No. of logs

Displays the total number of audit logs.


Column to display the log time. By default logs will be sorted
based on Timestamp from latest to oldest.
Column to display the user under whose login that particular
action has happened.
Column to display the device in which this log event occurs.
Column to display the object type and object name in which
this log event occurs
Column to display the specified log details.

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.

Page 168 of 190

APPVIEWX V 10.3.X USER GUIDE

Field Name

Description

Total No. of logs

Displays the total number of config logs.


Column to display the log time. By default logs will be sorted
based on Timestamp from latest to oldest.
Column to display the user under whose login that particular
action has happened.
Column to display the device in which this log event occurs.
Column to display the object type and object name in which
this log event occurs
Column to display the specified log details.
User will have provision to compare the configuration changes
between 2 versions here.

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.

Page 169 of 190

APPVIEWX V 10.3.X USER GUIDE

Field Name

Description

Old Configuration

Previous configuration is displayed here.


Current configuration is displayed here.
Colored circles indicate the type of change to the configuration.
Added: New Config line added
Modified: Previous Config line removed
Remove: Previous Config line modified
- Up arrow : Navigates to the next change in configuration
towards top
- Bottom arrow : Navigates to the next change in
configuration towards bottom

New Configuration
Type of Change

Actions:
Click the Config change to compare historical configuration changes.
Click the colored icon to view the Config change.

Page 170 of 190

APPVIEWX V 10.3.X USER GUIDE

AppViewX Log
All the device calls/actions initiated by AppViewX will be logged here.

Field Name

Description

Total No. of logs

Displays the total number of AppViewX logs.


Column to display the log time. By default logs will be sorted
based on Timestamp from latest to oldest.
Column to display the device in which this log event occurs.
N/A (Not Applicable)
Applicable only for Alert logs.
Column to display the specified log details.

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.

Page 171 of 190

APPVIEWX V 10.3.X USER GUIDE

Field Name

Description

Total No. of logs

Displays the total number of Syslogs.


Column to display the log time. By default logs will be sorted
based on Timestamp from latest to oldest.
Column to display the device in which this log event occurs.
Column to display the specified log details.

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

Total No. of logs

Displays the total number of alert logs.


Column to display the log time. By default logs will be sorted
based on Timestamp from latest to oldest.
Column to display the user under whose login that particular

Time
User

Page 172 of 190

APPVIEWX V 10.3.X USER GUIDE

Device Name
Object Details
Alert Category

Alert Severity

Log Messages

action has happened.


Column to display the device in which this log event occurs.
Column to display the object type and object name in which
this log event occurs
Specifies the category of the alert.
- Certificate Alert
- Application Alert
- Device Alert
- AppViewX Alert
- Threshold Alert
- All
Displays the severity of the alert log. There are five categories
of alert severity.
Fatal
Critical
Major
Minor
Notification
Column to display the specified log details.

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

APPVIEWX V 10.3.X USER GUIDE

Vendor

Object Type

Select the vendor.


Supported Vendors:
- Cisco
- Citrix
- F5
Corresponding object type for the vendor
F5
- WideIP
- WideIP Pool
- WideIP
PoolMember
- Server
- Pool
- LTMPoolMember
- Virtual Server

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.

Page 174 of 190

APPVIEWX V 10.3.X USER GUIDE

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.

The landing page of alert has the following sections,

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

Includes all the certificate alerts raised by the alerting engine


that are accessible to AppViewX.
Includes all the applications alerts raised by the alerting engine
that are accessible to AppViewX. Such alerts should be listened
and raised in alert dashboard and sent via email and/or SNMP

Application Alerts

Page 175 of 190

APPVIEWX V 10.3.X USER GUIDE

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.

Devices in critical state (Top 10)


This is a slider where the user can view the top 10 devices having most critical and fatal alerts in
that alert category. The top five is displayed in the first page and the next five is displayed in the
second page and can be viewed using a slider.

Page 176 of 190

APPVIEWX V 10.3.X USER GUIDE

Applications in critical state (Top 10)


This is a slider where the user can view the top 10 applications having most critical and fatal
alerts in that alert category.

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

APPVIEWX V 10.3.X USER GUIDE

Alert Name

Displays the name of that alert

Devices
Applications

Displays the device in which this alert occurs


Displays the application in which this alert occurs

Alert Detail

Displays the alert details.

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.

Hint: All cleared Alerts can be viewed in the logging module.

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.

Page 178 of 190

APPVIEWX V 10.3.X USER GUIDE

Field Name

Description

Alert Category

Displays the category of a specific alert.


- Certificate Alert
- Application Alert
- Device Alert
- AppViewX Alert
- Threshold Alert
- All
Specify the alert name.
Specify the alert severity (Fatal, Critical, Major, Minor and
Notification).
Enter an Alert Message to be displayed.
Select the Vendor whose device object you are configuring the alert.
Supported Vendors
- F5
- Citrix
- Cisco
Select the device name.

Alert Name
Alert Severity
Alert Message
Vendor

Device Name
Common Name
Email Configuration
SNMP Configuration

Total No. of Certificate


Alerts
Detail grid

From address of email configured for communicating the certificate


alert
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 certificate alerts.
Lists all the Certificate Alerts with detail specification of each alert
Alert Name, Alert Severity, Vendor, Device Name, Common Name,
Email, SNMP Details.
Page 179 of 190

APPVIEWX V 10.3.X USER GUIDE

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

Page 180 of 190

APPVIEWX V 10.3.X USER GUIDE

Object Name
Statistics
Alert Name
Alert Severity
Alert Message
Alert Condition

Operator
Value
Add New Condition

Email Configuration
SNMP Configuration

Total No. of Threshold


Alerts
Detail grid

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.

Page 181 of 190

APPVIEWX V 10.3.X USER GUIDE

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

Enter a unique alert keyword name different from all alerts.


Enter the key value in regular expression format. AppViewX alert
engine raises an alert if any syslog file matches this key value.
Specify the alert severity (Fatal, Critical, Major, Minor and
Notification).
Enter an Alert Message to be displayed.
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 syslog alerts.

Alert Severity
Alert Message
Email Configuration
SNMP Configuration

Total No. of Syslog


Alerts
Detail grid

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.

Page 182 of 190

APPVIEWX V 10.3.X USER GUIDE

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

Total No. of Alerts


Detail grid

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

APPVIEWX V 10.3.X USER GUIDE

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.

The landing screen of security management screen provides us two sections

Create Work order


Detail Grid of Work order

Detail Grid of Work order


Field Name

Description

Available Work Orders

Specifies total number of Work orders available on the current


page.
Specifies identity of each Work order.
Specifies details provided during creation of a Work order.
Specifies the device vendor name.
Specifies the source device.
Specifies the target device.
Specifies reference value, Requested By, Requested Time and
the reason for Work order.
Specifies the implementation period with date and time.
Specifies the status of the Work order:
- All
- Incomplete
- Waiting for Approval Level 1
- Rejected for Approval Level 1
- Waiting for Approval Level 2

Work Order ID
Work Order Details
Vendor
Source
Destination
RFC Number
Implementation Time
Status

Page 184 of 190

APPVIEWX V 10.3.X USER GUIDE

- Rejected for Approval Level 2


- Waiting for Manual Implementation
- Waiting for Auto Implementation
- Implementation Control
- Rollback Completed
- Rollback Failed
- Implementation Failed
- Implementation Partially Successful
- Rollback Partially Successful
Hint: Click on the status to get the window displaying Security
Log of the specific work order id which shows the work order
status in detail

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.

Page 185 of 190

APPVIEWX V 10.3.X USER GUIDE

Field Name

Description

Work order Details


Source
Vendor

Specify the details of the Work order

Source Policy

Specify the device vendor


Supported Vendor: F5
Lists the security policies on the devices for which the user
has read access to.

Destination
Destination Policy

Specify the name in which the policy is to be imported to the


destination devices.
Device and Profile selection
Lists the available profiles(ASM) on the devices for which the
user has Read-Write access
Hint: Multiple profile destinations within the same device
cannot be selected
Associated device and profile Lists the profiles the user has selected as destination to push
the policy
Implementation Type
Type of implementation.
- Manual
- Auto
RFC Number
Specify the reference value of Work order
It can be either alphabetic letters or numerical values.
Reason
Specify the reason for creating Work order
Implementation Time
Specify the time at which the push policy implementation has
to be auto-triggered by the application. This is mandatory
only in the case of Auto implementation.
Hint: In case the implementation time elapses before the
work order finishes through the approval process, then the
type automatically falls to manual.

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.

Page 186 of 190

APPVIEWX V 10.3.X USER GUIDE

Work order Process


The Work order facilitates the hierarchical approval of process for assigning available policies
to other device.
Role Based Access for Work order
AppViewX ensures Role Based Access for work order related functions. The work order for
security policy goes through following broad classification,

Creation
Approval/Rejection
Implementation
Rollback

Page 187 of 190

APPVIEWX V 10.3.X USER GUIDE

Hint: To assign or modify the role access, refer Accounts-> Roles -> Add/Modify -> Authorised
Functions

Work order Process

Comments

Actions

View Work order

Allows user to view the work orders


available
- Work order with Auto as
Implementation type is created.

No actions allowed

Create Work order


(Auto)

Create Work order


(Manual)

This waits for the approval of


level 1 administrator

Work order with Manual as


Implementation type is created
This waits for the approval of
level 1 administrator
Level 1 administrator approves
the created work order (either
auto/manual)
This waits for the approval of
level 2 administrator if it is
approved by level 1
administrator or has to be
resubmitted
Level 2 administrator approves
the approved work order by
level 1 administrator or has to
be resubmitted
This waits for the

Approval Work order


Level 1

Approval Work order


Level 2

Click Submit to add the


policies for the work
order
- Click Save after doing
any changes and Discard
to leave the changes
- Click Cancel to go to the
previous page
Actions similar auto
implementation.
Click Resubmit to submit
work order post changes
- Click Approve to
proceed the
implementation
- Click Reject to deny the
approval
- Click Resubmit to
proceed the rejected
work order
- Actions similar to level 1
administrator

Page 188 of 190

APPVIEWX V 10.3.X USER GUIDE

Implement Work order


Rollback Work order

implementation by the level 3


administrator (admin)
The work order is implemented
The work order is not approved by
the administrator or the
configuration implemented is
incorrect

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

Page 189 of 190

APPVIEWX V 10.3.X USER GUIDE

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

Page 190 of 190