Collecting System Information (asg_info)

Best Practice - Use the more advanced tool Check Point Support Data Collector (CPSDC) as described in sk164414.

Description

Use the "asg_info" command in Gaia gClishClosed The name of the global command line shell in Check Point Gaia operating system for Security Appliances connected to Check Point Quantum Maestro Orchestrators. Commands you run in this shell apply to all Security Appliances in the Security Group. or the Expert mode to collect information from the .

The "asg_info" command collects the information from these areas:

  • Log files

  • Configuration files

  • System status

  • System diagnostics

The "asg_info" command saves the collected information in this file:

/var/log/asg_info.<Hostname>.<Date>.tar

By default, this command collects the information from all Security GroupClosed A logical group of Security Appliances that provides Active/Active cluster functionality. A Security Group can contain one or more Security Appliances. Security Groups work separately and independently from each other. To the production networks, a Security Group appears a single Security Gateway. Every Security Group contains: (A) Applicable Uplink ports, to which your production networks are connected; (B) Security Appliances (the Quantum Maestro Orchestrator determines the applicable Downlink ports automatically); (C) Applicable management port, to which the Check Point Management Server is connected. Members and Virtual Systems (in VSXClosed Virtual System Extension. Check Point virtual networking solution, hosted on a computer or cluster with virtual abstractions of Check Point Security Gateways and other network devices. These Virtual Devices provide the same functionality as their physical counterparts. mode).

Granularity of Commands

The "asg_info" command in GaiaClosed Check Point security operating system that combines the strengths of both SecurePlatform and IPSO operating systems. gClish or the Expert mode executes the applicable commands with this granularity:

Source

Granularity

Security Group Members

  • All Security Group Members

  • Single Security Group Member

  • Specified Security Group Members

VSX

Collected Files

The "asg_info" command collects a predefined list of files from the Security Group Member and Virtual Systems.

A global file is located in the global folder.

Examples:

File

How the File is Collected and File Location

latest_policy.policy.tgz

  • Collected as a global file

  • Located in \global\VS0\var\CPbackup\asg_backup\

dist_mode.log

  • Collected from the Security Group Member and Virtual Systems folders

  • Located in \SGM_1_01\VS1\var\log\

start_mbs.log

  • Collected from the Security Group Member folder and not from the Virtual Systems folders

  • Located in \SGM_1_01\VS0\var\log\

Syntax and Parameters

Syntax

asg_info -h

asg_info [-b <SGM IDs>] [--vs <VS IDs>] <Collect Flags> [Options]

asg_info [-b <SGM IDs>] [--vs <VS IDs>] [--user_conf <Path to XML Configuration File>] [Options]

Parameters

Parameter

Description

-h

Shows the built-in help.

-b <SGM IDs>

Applies to Security Group Members as specified by the <SGM IDs>.

<SGM IDs> can be:

  • No <SGM IDs> specified, or all

    Applies to all Security Group Members and all Maestro Sites

  • One Security Group Member (for example, 1_1)

  • A comma-separated list of Security Group Members (for example, 1_1,1_4)

  • A range of Security Group Members (for example, 1_1-1_4)

  • In Dual Site, one Maestro Site (chassis1, or chassis2)

  • In Dual Site, the Active Maestro Site (chassis_active)

Default - Runs on all Security Group Members that are in the UP state.

-vs <VS IDs>

Applies to Virtual Systems as specified by the <VS IDs>.

<VS IDs> can be:

  • No <VS IDs> specified (default) - Applies to the context of the current Virtual System

  • One Virtual System

  • A comma-separated list of Virtual Systems (for example, 1,2,4,5)

  • A range of Virtual Systems (for example, 3-5)

  • all - Shows all Virtual Systems

This parameter is only applicable in a VSX environment.

<Collect Flags>

The collect flags are:

Flag

Instructions

--all

Collects all log files and command outputs.

-a

Collects archive files.

-c

Collects information about core dump files.

-f

Collects comprehensive log files and command outputs.

-i

Collects the "cpinfo" output.

-m | --cmm

This flag is not supported.

-q

Collects major log files and command outputs.

--user_conf <Path to XML Configuration File>

Collects the specified XML configuration file.

See Configuration Files below.

Options

The options are:

Option

Instructions

-h

Shows the built-in help.

-e <Email_1;...;Email_N>

Semicolon separated list of email addresses for upload notifications.

schedule

Specifies the periodic schedule to upload report to the Check Point User Center.

Notes:

  • This option must be the first or the last in the list of options.

  • This option asks to select the schedule (Daily, Weekly, or Monthly).

  • This option requires a valid CK (see the output of the "cplic print" command).

  • To see and delete the configured periodic jobs, run:

    asg_info schedule

-u

Interactive upload of the "asg_info" output file to the Check Point User Center.

-uk

Non-interactive upload of the "asg_info" output file to the Check Point User Center.

This option requires a valid CK (see the output of the "cplic print" command).

-v

Shows verbose output.

--list

Dry run - shows all the files and command outputs to be collected without actually collecting them.

Configuration Files

File

Instructions

Default

$FWDIR/conf/asg_info_config.xml

Files and commands are defined automatically.

User defined

You can define files and commands based on the same standard as appears in the default file.

Note - You can run the "asg_info" command either with the default file, or with the user-defined file. Not the two files at the same.

Copy
Example of a user-defined XML configuration file
<configurations>
<collect_file_list>
  <upgrade_wizard>
    <collect_mode>-f</collect_mode>
    <path>/var/log/upgrade_wizard.log*</path>
    <per_vs>0</per_vs>
    <per_sgm>1</per_sgm>
    <delete_after_collect>0</delete_after_collect>
  </upgrade_wizard>
  <active_cmm_debug>
    <collect_mode>-m</collect_mode>
    <path>/var/log/active_cmm_debug.log</path>
    <per_vs>0</per_vs>
    <per_sgm>1</per_sgm>
    <delete_after_collect>1</delete_after_collect>
  </active_cmm_debug>
</collect_file_list>
<cmd_list>
  <asg_if>
    <mode>-f</mode>
    <pre_command>g_all</pre_command>
    <command>asg if</command>
    <ipv6>0</ipv6>
    <esx>1</esx>
    <per_chassis>0</per_chassis>
    <per_vs>1</per_vs>
    <per_sgm>0</per_sgm>
    <vsx_only>0</vsx_only>
    <dest_file_name>asg_info</dest_file_name>
  </asg_if>
</cmd_list>
</configurations>