Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Search for | Example | Results |
---|---|---|
A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |
Search for | Operator | Example |
---|---|---|
Two or more words in the same topic |
|
|
Either word in a topic |
|
|
Topics that do not contain a specific word or phrase |
|
|
Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
A combination of search types | ( ) parentheses |
|
Running an OGFS Script
The Run OGFS Script, as shown the following figure, allows you to run an OGFS script and consists of the following steps:
Script
This step allows to specify an OGFS script for execution.
To select an OGFS script perform the following steps:
- From the Navigation pane, perform one of the following steps:
- Select Library > By Type > Scripts. The scripts list appears in the Content pane.
- Select Library > By Folder. The folder hierarchy in the Library appears in the Content pane.
- From the Content pane, select an OGFS script.
- From the Actions menu, select Run. The Run OGFS Script window appears.
- In the Script Properties section, select script from the Name drop-down list or click Select Script to open the Select Script window. Select the script from the Select Script window.
- The script properties such as version, type, location, description are displayed in the content pane. To view the contents on the script, click View Script. The contents of the script are displayed in the Run OGFS Script window.
- In the Script Execution Path section, enter the OGFS directory path for executing the script or click Browse to specify the directory path in the OGFS.
- Click Next to proceed to the Options step.
Options
This step allows you to specify the runtime options and output options for executing a script. In this step you can specify the script time-out value, any additional parameters for executing the script, and the output options for the script.
To specify the runtime and output options for a script perform the following steps:
- In the Script timeout field enter the script timeout value in minutes. The time out value is the amount of time required for a script to complete execution activities. If the script is not executed when the timeout value is reached, then the script is stopped by SA and a script error occurs. Select a timeout value greater than the time required for execution to complete.
- In the Specify any needed parameters for this script execution field, enter any parameters if required.
- In the Output Options, select Discard all script output to discard script output or else select Retain script output.
- Select the output size of the script from the Size of the output to retain drop-down list.
- Click Next to proceed to the Scheduling step.
Scheduling
This step allows you to schedule the script execution job. You can choose to run the script execution job immediately, or on a specified date and time, or on a recurring basis.
To schedule a script execution job, perform the following steps:
- In the Schedule Frequency section, choose to run the script once, daily, weekly, monthly, or on a custom schedule. Select any one of the following options:
- Once: Choose this option to run the job immediately or only once at a specified date and time.
- Daily: Choose this option to run the job on a daily basis at a specified time.
- Weekly: Choose this option to specify the day or days of the week to run the job.
- Monthly: Choose this option to specify the months to run the job, and the days of the month.
- Custom: In the Custom Crontab string field, enter a string the indicates a time schedule. The crontab string can include serial (1,2,3,4) and range (1-5) values.
- In the Time and Duration section, for each type of schedule, specify the start time for the job. You must also specify the start date and end date for the job. The Time Zone is set according to the time zone set in your user profile.
- Click Next to proceed to the Notifications step.
Notifications
This step allows you to set email notifications to alert users on the success or failure of a job. You can also associate a Ticket ID with the job. This setting is optional.
To set email notifications, perform the following steps:
- Click Add Notifier.
- Enter the addresses in the Email Address of Recipientfield.
- To send email to the address if the job succeeds, select the checkbox On Success.
- To send email if the job fails, select the select the checkbox On Failure.
- Enter an ID to be associated with this job in the Ticket ID field.
- Click Next to proceed to the Job Status step.
Job Status
This step allows you to start the job, view the job progress, view the job results, view the script output for a managed server, and export the script output from all the servers.
SA supports the following file formats for exporting script output results:
- A Zip file with folders for each managed server
- A Zip file containing no folders
- Consolidated raw text file
- Consolidated formatted text file
- Consolidated CSV file
You can also view jobs in the Jobs Log window of the SA Client. See Browsing job logs for information about job logs.
To start a job, perform the following steps:
- To start the job, click Start Job.
If you selected Immediately in the Scheduling step, the job will begin now. If you scheduled the job for a later time, the job will run later. You can then view the job in the Jobs Log window of the SA Client.
The job’s progress information appears in the Job Status window. You can view the server on which the script was executed, the job status, and the exit code. If the job status is displayed as Pending Approval, then the job is blocked until it is approved by a process that is external to SA. See Browsing job logs for information about job logs. - (Optional) To view the script output from all the managed servers, select the option Show output in table. The output for each server appears in the Output column in the table.
- (Optional) To view the output for all the servers in separate columns, select the option Show output in table and enter the delimiter character in the Delimiter checkbox. The output for each server appears in separate columns in the table.
- (Optional) To export the script output results, click Export All Results. In the Browse window specify the location and the file type and click Export.
- Click Close to exit the Run OGFS Script window.
We welcome your comments!
To open the configured email client on this computer, open an email window.
Otherwise, copy the information below to a web mail client, and send this email to hpe_sa_docs@hpe.com.
Help Topic ID:
Product:
Topic Title:
Feedback: