ConfigFile(3) User Contributed Perl Documentation ConfigFile(3)NAME
ConfigFile - Parse a simple configuration file
SYNOPSIS
use ConfigFile;
my $config_hash = ConfigFile::read_config_file($configuration_file);
NOTES
In versions up to 1.0, the function read_config_file was exported to the calling program's namespace - Starting in version 1.1, nothing is
exported by default. You can either fully qualify read_config_file or explicitly import it into your namespace:
Fully qualifying read_config_file
use ConfigFile;
my $config_hash = ConfigFile::read_config_file($configuration_file);
Explicitly importing read_config_file
use ConfigFile qw(read_config_file);
my $config_hash = read_config_file($configuration_file);
DESCRIPTION
"read_config_file" parses a simple configuration file and stores its values in an anonymous hash reference. The syntax of the configuration
file is quite simple:
# This is a comment
VALUE_ONE = foo
VALUE_TWO = $VALUE_ONE/bar
VALUE_THREE = The value contains a # (hash). # This is a comment.
Options can be clustered when creating groups:
CLUSTER_ONE[data] = data cluster one
CLUSTER_ONE[value] = value cluster one
CLUSTER_TWO[data] = data cluster two
CLUSTER_TWO[value] = value cluster two
Then values can be fetched using this syntax:
$hash_config->{CLUSTER_ONE}{data};
There can be as many sub-options in a cluster as needed.
BIG_CLUSTER[part1][part2][part3] = data
is fetched by:
$hash_config->{BIG_CLUSTER}{part1}{part2}{part3};
The only restriction is no space in the key part of the line.
CLUSTER_ONE[data] = data cluster one # Right
CLUSTER_ONE[ data ] = data cluster one # Wrong
Function ";read_config_file"
Syntax
ConfigFile::read_config_file($file);
Arguments
$file is the configuration file.
Return value
This function returns a hash reference. Each key of the hash is a value defined in the configuration file.
Description
"read_config_file" parses a configuration file a sets up some values in a hash reference.
AUTHOR
Development was started by Sebastien J. Gross <seb@sjgross.org>
All rights reserved. This program is free software; you can redistribute it and/or modify it under the terms of the GPL.
VERSION
Version 1.1.0 Copyright (c) 2002 Sebastien J. Gross. All rights reserved. Copyright (c) 2003 Gunnar Wolf. All rights reserved. This
program is free software; you can redistribute it and/or modify it under the terms of the GPL.
perl v5.12.1 2003-10-27 ConfigFile(3)
Check Out this Related Man Page
cmdeleteconf(1m)cmdeleteconf(1m)NAME
cmdeleteconf - Delete either the cluster or the package configuration
SYNOPSIS
cmdeleteconf [-f] [-v] [-c cluster_name] [[-p package_name]...]
DESCRIPTION
cmdeleteconf deletes either the entire cluster configuration, including all its packages, or only the specified package configuration. If
neither cluster_name nor package_name is specified, cmdeleteconf will delete the local cluster's configuration and all its packages. If
the local node's cluster configuration is outdated, cmdeleteconf without any argument will only delete the local node's configuration. If
only the package_name is specified, the configuration of package_name in the local cluster is deleted. If both cluster_name and pack-
age_name are specified, the package must be configured in the cluster_name, and only the package package_name will be deleted. cmdelete-
conf with only cluster_name specified will delete the entire cluster configuration on all the nodes in the cluster, regardless of the con-
figuration version. The local cluster is the cluster that the node running the cmdeleteconf command belongs to.
Only a superuser, whose effective user ID is zero (see id(1) and su(1)), can delete the configuration.
To delete the cluster configuration, halt the cluster first. To delete a package configuration you must halt the package first, but you do
not need to halt the cluster (it may remain up or be brought down). To delete the package VxVM-CVM-pkg (HP-UX only), you must first delete
all packages with STORAGE_GROUP defined.
While deleting the cluster, if any of the cluster nodes are powered down, the user can choose to continue deleting the configuration. In
this case, the cluster configuration on the down node will remain in place and, therefore, be out of sync with the rest of the cluster. If
the powered-down node ever comes up, the user should execute the cmdeleteconf command with no argument on that node to clean up the config-
uration before doing any other Serviceguard command.
Options
cmdeleteconf supports the following options:
-f Force the deletion of either the cluster configuration or the package configuration.
-v Verbose output will be displayed.
-c cluster_name
Name of the cluster to delete. The cluster must be halted already, if intending to delete the cluster.
-p package_name
Name of an existing package to delete from the cluster. The package must be halted already. There should not be any
packages in the cluster with STORAGE_GROUP defined before having a package_name of VxVM-CVM-pkg (HP-UX only).
RETURN VALUE
Upon completion, cmdeleteconf returns one of the following values:
0 Successful completion.
1 Command failed.
EXAMPLES
The high availability environment contains the cluster, clusterA , and a package, pkg1.
To delete package pkg1 in clusterA, do the following:
cmdeleteconf -f -c clusterA -p pkg1
To delete the cluster clusterA and all its packages, do the following:
cmdeleteconf -f -c clusterA
AUTHOR
cmdeleteconf was developed by HP.
SEE ALSO cmcheckconf(1m), cmapplyconf(1m), cmgetconf(1m), cmmakepkg(1m), cmquerycl(1m).
Requires Optional Serviceguard Software cmdeleteconf(1m)