Difference between revisions of "Action page"

From Veloopti Help
Jump to: navigation, search
(Created page with "Home > Using > Standard User Interface > Pages > Action page|Actio...")
 
m
Line 7: Line 7:
  
 
=== Permissions ===
 
=== Permissions ===
−
There are three levels of permissions in Actions.
+
There are three levels of permissions with running an action.
−
;Operator
+
;'''Operator'''
−
: Operator level actions require the lowest level of permissions to be run.
+
: Operator level actions require the lowest level of permissions to be run.  Any user in an application that is a member of the ''Operator'' role can run an operator level action.
−
;Power User
+
;'''Power User'''
−
: Power User level actions require more permissions than Operator level and lower than Administrator level actions. Users that can run Power User level actions can also run Operator level actions.
+
: Power User level actions require more permissions than Operator level actions. Users that can run Power User level actions can also run Operator level actions. Any user in an application that is a member of the "Power User" role can run Power User and Operator level actions.
−
;Administrator
+
;'''Administrator'''
−
: Administrator level actions require the highest level of permissions. Users that are able to run Administrator level actions can also run Power User and Operator actions.  
+
: Administrator level actions require the highest level of permissions. Users that are able to run Administrator level actions can also run Power User and Operator actions.  Any user in an application that is a member of the "Administrators" role can run Administrator, Power Users and Operator level actions.
  
 
=== Where actions can be run ===
 
=== Where actions can be run ===
Line 19: Line 19:
  
 
==== Actions on servers ====
 
==== Actions on servers ====
−
Actions can be run directly on a server that has a Veloopti agent. When clicking on the server name in either the main node page, or the node page in an application; there is a item named Actions where they can be run.
+
Actions can be run directly on a server that has a Veloopti agent. To do this, click on the server name in either the main node page, or the node page of an application. There is a side menu item named ''Actions'' where they can be run.
  
 
==== Actions on events ====
 
==== Actions on events ====
Line 42: Line 42:
 
|-
 
|-
 
|[[Action_page#Audit_Log|Audit log]]
 
|[[Action_page#Audit_Log|Audit log]]
−
|The Audit log  
+
|This is the audit log for the action.  It contains a list of the things that have been changed on the action over time.
 
|-
 
|-
 
|}
 
|}
Line 50: Line 50:
 
'''Name'''
 
'''Name'''
  
−
The name of the policy is used to reference it from different places in Veloopti. An action needs to have a unique name in the [[Application|Application]] that it is in.
+
The name of the policy is used as a reference in different places in Veloopti. An action needs to have a unique name in the [[Application|Application]] that it resides in.
  
 
'''Description'''
 
'''Description'''
  
−
The description is where you enter some text that describes what the action does.
+
The description is where you enter some text that describes what the action does. This description is used in other places like in policies.
  
 
'''Type'''
 
'''Type'''
Line 62: Line 62:
 
'''Level'''
 
'''Level'''
  
−
There are three levels of actions in Veloopti: Operator; Power User and Administrator.  Each level is able to be run by users who are members of a role that have the appropriate permission assigned to it.  
+
There are three levels of actions in Veloopti: Operator; Power User and Administrator.  Each action level is able to be run by users who are members of certain roles.  
  
  
Line 71: Line 71:
 
|-
 
|-
 
|'''Property'''
 
|'''Property'''
 +
|'''Property type'''
 
|'''Description'''
 
|'''Description'''
 
|-
 
|-
−
|ID
+
|Executable
−
|A [[Glossary_of_acronyms#G|GUID]] that distinguishes all of the messages.  Primarily used to tell similar events apart.
+
|Free text
 +
|The name of the binary executable or script that the action runs
 
|-
 
|-
−
|Severity
+
|Initial Directory
−
|Standard categorisation based on the significance of an event:
+
|Free text
−
*'''Information''' - The event does not require any immediate action and does not represent an exception.
+
|The directory that the binary executable is located in. Use this if you want to use relative paths for either the Executable or any of the Arguments.
−
*'''Warning''' - The event is generated when an [[Application|application]] is approaching a threshold. Warnings are intended to notify you in order for you to take the necessary actions to prevent an exception occurring.
 
−
*'''Exception''' - This mean that the [[Application|application]] is impacted and presents a failure, performance degradation or loss of functionality (web server down, database stopped responding, ''etc'').
 
 
|-
 
|-
−
|Status
+
|Description
−
|The state of event being either open or closed.
+
|Free text
 +
|A description of the argument that is there to help you remember what it is used for
 
|-
 
|-
−
|Node
+
|Argument
−
|The name of the [[Node|node]] where the event was received.
+
|Free text
 +
|The name of the argument as it should appear on the command line.  Generally it is the field proceeding the "=" sign.  ''i.e.'' '''path'''=c:\program files\
 
|-
 
|-
−
|First Occurred
+
|Value
−
|The date/time that the event was detected by the management application.  
+
|Free text
−
{| class="wikitable" style="text-align: left;"
+
|The value that should be represented by the argument. Generally it is the field that follows the "=" sign. ''i.e.'' path='''c:\program files\'''
−
|'''Type'''
 
−
|'''First occurred'''
 
 
|-
 
|-
−
|Policy
+
|Prompt for value
−
|The time that the Veloopti agent detected the event
+
|Check box
 +
|
 
|-
 
|-
−
|Logfile
+
|Surround with quotes
−
|The date/time that appears in the logfile. If this does not exist then it is the date/time that the Veloopti agent performed the logfile scan.
+
|Check box
 +
|
 
|-
 
|-
−
|SNMP Trap
+
|Add
−
|The date/time that appears in the SNMP trap
+
|Button
 +
|
 
|-
 
|-
−
|API
+
|Timeout
−
|The date/time that is sent through the API. If this does not exist then it is the date/time that the Veloopti agent received the API event.
+
|Numeric > 0
 +
|The amount of seconds that the action can run for before it is killed by the Veloopti Agent
 
|-
 
|-
−
|}
+
|Name
 +
|Free text
 +
|The name of the environment variable that should be created before the action is started.  This can be helpful for binaries/scripts that need environment variables set up before they can be run.
 
|-
 
|-
−
|Received
+
|Value
−
|The date/time that the event was received by the Veloopti [[Agent_controller|agent controller]].
+
|Free text
 +
|This is the value that the environment variable should be set to.
 
|-
 
|-
−
|Last Occurred
+
|Add
−
|This is the last time that an event was received that matched the event parameters. It is the latest "First Occurred" date of the last event that was received.
+
|Button
 +
|After the environment name and value has been set you use this add button to add it and move on to the next, if there is one.
 
|-
 
|-
−
|ITIL Component
+
|Delete
−
|The [[Glossary_of_acronyms#I|ITIL]] component that the event relates to: Availability, Capacity, Performance or Security.
+
|Button
 +
|The Delete button is located in the [[Glossary_of_terms#F|feedback]] section.  It allows for you to delete the action.  
 
|-
 
|-
−
|Custom event properties
+
|Save
−
|Custom event properties appear at the bottom of the standard event properties. These are properties that are specific to the event. This can be things like: eventID for windows event logs; URL for URL monitor policy; or anything for an inbound API policy.
+
|Button
 +
|The Delete button is located in the [[Glossary_of_terms#F|feedback]] section. It allows you to save any changes that you may have made to the action.
 
|-
 
|-
 
|}
 
|}
−
 
−
=== Attributes ===
 
−
 
−
Type in the section that say "Add a new comment" and click on the [[file:Add comment.png|70px]] button to add your comments to the event.
 
  
 
=== History ===
 
=== History ===
Line 130: Line 136:
  
 
=== Audit Log ===
 
=== Audit Log ===
−
This tab contains the audit log for the event. Anything that occurs in relation to the event occurs here.
+
This tab contains the audit log for the Action. Anything that occurs in relation to the Action occurs here.
−
# The time the event was first opened
+
# The time the Action was created
−
# Severity increases and decreases
+
# All of the times the action was edited
−
# Notifications that were sent to users
+
# Any time the action is run on a node or from an event
−
# Action results
 
−
# The closure time
 
  
 
[[Category:Pages]] [[Category:Actions]]
 
[[Category:Pages]] [[Category:Actions]]

Revision as of 22:13, 19 March 2018

Home > Using > Standard User Interface > Pages > Action page


1 Overview

An action is a command that can be remotely run on a node that has a Veloopti agent installed on it. Actions come in three levels of permissions: Operator; Power User; and Administrator.

1.1 Permissions

There are three levels of permissions with running an action.

Operator
Operator level actions require the lowest level of permissions to be run. Any user in an application that is a member of the Operator role can run an operator level action.
Power User
Power User level actions require more permissions than Operator level actions. Users that can run Power User level actions can also run Operator level actions. Any user in an application that is a member of the "Power User" role can run Power User and Operator level actions.
Administrator
Administrator level actions require the highest level of permissions. Users that are able to run Administrator level actions can also run Power User and Operator actions. Any user in an application that is a member of the "Administrators" role can run Administrator, Power Users and Operator level actions.

1.2 Where actions can be run

Actions can be run in two different locations: on servers and through an event.

1.2.1 Actions on servers

Actions can be run directly on a server that has a Veloopti agent. To do this, click on the server name in either the main node page, or the node page of an application. There is a side menu item named Actions where they can be run.

1.2.2 Actions on events

Actions can also be run from an Event. <more here>

2 Action tabs

Action tabs
Tab Description
Overview This tab contains the main overview of the Action
Attributes The attributes of the action are the commands and parameters that are run on the node.
History This shows the results of an action that has been run while the event was open.
Audit log This is the audit log for the action. It contains a list of the things that have been changed on the action over time.

2.1 Overview

Name

The name of the policy is used as a reference in different places in Veloopti. An action needs to have a unique name in the Application that it resides in.

Description

The description is where you enter some text that describes what the action does. This description is used in other places like in policies.

Type

The action type is currently limited to a command type action. More of these will be released in the future.

Level

There are three levels of actions in Veloopti: Operator; Power User and Administrator. Each action level is able to be run by users who are members of certain roles.


2.2 Attributes

Event properties
Property Property type Description
Executable Free text The name of the binary executable or script that the action runs
Initial Directory Free text The directory that the binary executable is located in. Use this if you want to use relative paths for either the Executable or any of the Arguments.
Description Free text A description of the argument that is there to help you remember what it is used for
Argument Free text The name of the argument as it should appear on the command line. Generally it is the field proceeding the "=" sign. i.e. path=c:\program files\
Value Free text The value that should be represented by the argument. Generally it is the field that follows the "=" sign. i.e. path=c:\program files\
Prompt for value Check box
Surround with quotes Check box
Add Button
Timeout Numeric > 0 The amount of seconds that the action can run for before it is killed by the Veloopti Agent
Name Free text The name of the environment variable that should be created before the action is started. This can be helpful for binaries/scripts that need environment variables set up before they can be run.
Value Free text This is the value that the environment variable should be set to.
Add Button After the environment name and value has been set you use this add button to add it and move on to the next, if there is one.
Delete Button The Delete button is located in the feedback section. It allows for you to delete the action.
Save Button The Delete button is located in the feedback section. It allows you to save any changes that you may have made to the action.

2.3 History

Any actions that have been run that are associated with this event appear here.

2.4 Audit Log

This tab contains the audit log for the Action. Anything that occurs in relation to the Action occurs here.

  1. The time the Action was created
  2. All of the times the action was edited
  3. Any time the action is run on a node or from an event
Retrieved from "http://help.veloopti.com.au/index.php?title=Action_page&oldid=4316"