/ 
Siebel-Srvrmgr-0.19
River stage zero No dependents
/ Siebel::Srvrmgr::ListParser::Output::Tabular::ListParams

NAME

Siebel::Srvrmgr::ListParser::Output::Tabular::ListParams - subclass to parse output of the command list comp params.

SYNOPSIS

use Siebel::Srvrmgr::ListParser::Output::Tabular::ListParams;

my $comp_params = Siebel::Srvrmgr::ListParser::Output::Tabular::ListParams->new({ data_type => 'list_params', 
                                                                                  raw_data => \@com_data, 
                                                                                  cmd_line => 'list params for server XXXX component YYYY'});
my $server_params = Siebel::Srvrmgr::ListParser::Output::Tabular::ListParams->new({ data_type => 'list_params', 
                                                                                    raw_data => \@server_data,
                                                                                    cmd_line => 'list params for server XXXX'});

DESCRIPTION

This module parses the output of the command list comp params. Beware that those parameters may be of the server if a component alias is omitted from the command line.

This is most probably the default configuration of the output:

srvrmgr> configure list params
    PA_ALIAS (76):  Parameter alias
    PA_VALUE (256):  Parameter value
    PA_DATATYPE (31):  Parameter value datatype
    PA_SCOPE (31):  Parameter level
    PA_SUBSYSTEM (31):  Parameter subsystem
    PA_SETLEVEL (31):  Internal level at which value was set
    PA_DISP_SETLEVEL (61):  Display level at which value was set (translatable)
    PA_EFF_NEXT_TASK (2):  Parameter effective at next task (bool)
    PA_EFF_CMP_RSTRT (2):  Parameter effective at component restart (bool)
    PA_EFF_SRVR_RSTRT (2):  Parameter effective at server restart (bool)
    PA_REQ_COMP_RCFG (2):  Parameter requires component reconfiguration (bool)
    PA_NAME (76):  Parameter name

This is what the parser of this class will expected to find:

srvrmgr> configure list params
    PA_ALIAS (76):  Parameter alias
    PA_VALUE (256):  Parameter value
    PA_DATATYPE (31):  Parameter value datatype
    PA_SCOPE (31):  Parameter level
    PA_SUBSYSTEM (31):  Parameter subsystem
    PA_SETLEVEL (31):  Internal level at which value was set
    PA_DISP_SETLEVEL (61):  Display level at which value was set (translatable)
    PA_EFF_NEXT_TASK (16):  Parameter effective at next task (bool)
    PA_EFF_CMP_RSTRT (16):  Parameter effective at component restart (bool)
    PA_EFF_SRVR_RSTRT (17):  Parameter effective at server restart (bool)
    PA_REQ_COMP_RCFG (16):  Parameter requires component reconfiguration (bool)
    PA_NAME (76):  Parameter name

The data_parsed attribute will return the following data estructure:

'data_parsed' => {
	'Parameter1' => {
		'PA_NAME' => 'Private key file name',
		'PA_DATATYPE' => 'String',
		'PA_SCOPE' => 'Subsystem',
		'PA_VALUE' => '', 
		'PA_EFF_NEXT_TASK' => '',
		'PA_EFF_CMP_RSTRT' => '',
		'PA_EFF_SRVR_RSTRT' => '',
		'PA_REQ_COMP_RCFG' => '',
		'PA_ALIAS' => 'KeyFileName',
		'PA_SETLEVEL' => 'SIS_NEVER_SET',
		'PA_DISP_SETLEVEL' => 'SIS_NEVER_SET',
		'PA_SUBSYSTEM' => 'Networking'
		},
	'Parameter2' => {
		'PA_NAME' => 'Private key file name',
		'PA_DATATYPE' => 'String',
		'PA_SCOPE' => 'Subsystem',
		'PA_VALUE' => '', 
		'PA_EFF_NEXT_TASK' => '',
		'PA_EFF_CMP_RSTRT' => '',
		'PA_EFF_SRVR_RSTRT' => '',
		'PA_REQ_COMP_RCFG' => '',
		'PA_ALIAS' => 'KeyFileName',
		'PA_SETLEVEL' => 'SIS_NEVER_SET',
		'PA_DISP_SETLEVEL' => 'SIS_NEVER_SET',
		'PA_SUBSYSTEM' => 'Networking'
		},
		# N parameters
}

For this release there is no method implemented that would return a parameter name and it's properties, it's necessary to access the hashes directly.

ATTRIBUTES

Additionally to the parent class, these attributes are all generated from the command line given to new, if available.

Since they are set automatically, none is required. It is assumed that if a attribute is set to undef, there are no corresponding options in the list parameter command.

All these attributes are read-only.

server

An string representing the server from the command executed.

comp_alias

An string of the component alias respective to the command executed.

named_subsys

A string representing the named subsystem used in the command.

task

A integer representing the task number used in the executed command.

param

A string representing the specific parameter requested in the executed command.

BUILD

Set values for some class attributes depending on the command line used during object creation.

CAVEATS

This class is capable to parse the output from list advanced params but during tests it was identified that configuring output from list params will not provided the expected results. It was possible to parse the output without any configuration, but results may differ from version to version.

SEE ALSO

AUTHOR

Alceu Rodrigues de Freitas Junior, <arfreitas@cpan.org>.

COPYRIGHT AND LICENSE

This software is copyright (c) 2012 of Alceu Rodrigues de Freitas Junior, <arfreitas@cpan.org>.

This file is part of Siebel Monitoring Tools.

Siebel Monitoring Tools is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Siebel Monitoring Tools is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Siebel Monitoring Tools. If not, see http://www.gnu.org/licenses/.