Tuxedo::Admin - Runtime Tuxedo administration
use Tuxedo::Admin; $admin = new Tuxedo::Admin( 'TUXDIR' => '/opt/bea/tuxedo8.1', 'TUXCONFIG' => '/home/keith/runtime/TUXCONFIG', 'BDMCONFIG' => '/home/keith/runtime/BDMCONFIG' ); foreach $server ($admin->server_list()) { print server->servername(), "\n"; }
This module aims to make runtime administration of a Tuxedo environment simpler and less error-prone than the usual method of navigating the tmadmin, dmadmin and qmadmin menus or writing multiple adhoc ud32 scripts to make TMIB calls.
It provides a simple object-oriented Perl interface to the Tuxedo MIBs allowing the caller to query, add or update the various components of the Tuxedo environment, such as servers, groups, access points etc.
Certain environment variables need to be set in order to access a Tuxedo environment. These are:
TUXDIR TUXCONFIG BDMCONFIG APP_PW
These can either be set in the environment itself or they can be passed as parameters to the Tuxedo::Admin constructor. (Note that APP_PW need only be set if application passwords are being used.)
$admin = new Tuxedo::Admin( 'TUXDIR' => '/opt/bea/tuxedo8.1', 'TUXCONFIG' => '/home/keith/runtime/TUXCONFIG', 'BDMCONFIG' => '/home/keith/runtime/BDMCONFIG' );
or just:
$admin = new Tuxedo::Admin;
if the required variables are set in the environment.
Retrieves the resource settings for the current Tuxedo application.
$resources = $admin->resources();
where $resources is a reference to a Tuxedo::Admin::Resources object.
Retrieves information about a specific server instance.
$server = $admin->server($group_name, $server_id);
where $group_name is the name of the group the server is in and $server_id is the server's identifier in this server group. Together these parameters uniquely identify a server. $server is a reference to a Tuxedo::Admin::Server object.
Retrieves a list of server instances.
@servers = $admin->server_list(\%filter)
where %filter is an optional reference to a hash that specifies attributes that each server instance in the returned list must have and @servers is a list of references to Tuxedo::Admin::Server objects that match the filter.
For example:
@servers = $admin->server_list( { 'servername' => 'GWTDOMAIN', 'restart' => 'Y' } );
Retrieves information about a specific group.
$group = $admin->group($group_name);
where $group_name is the name of the group and $group is a reference to a Tuxedo::Admin::Group object.
Retrieves a list of groups.
@groups = $admin->group_list(\%filter);
where %filter is an optional reference to a hash that specifies attributes that each group in the returned list must have and @groups is a list of references to Tuxedo::Admin::Group objects that match the filter.
Retrieves information about a specific service.
$service = $admin->service($service_name, $group_name);
where $service_name is the name of the service and $group_name is the name of the group that the server that advertised this service is in. $service is a reference to a Tuxedo::Admin::Service object.
Retrieves a list of services.
@services = $admin->service_list(\%filter);
where %filter is an optional reference to a hash that specifies attributes that each service in the returned list must have and @services is a list of references to Tuxedo::Admin::Service objects that match the filter.
Retrieves information about a specific local access point.
$local_access_point = $admin->local_access_point($access_point_name, $access_point_id, $group_name);
where $access_point_name is the local name of the access point, $access_point_id is the external identifier for the access point and $group_name is the name of the server group to which the local access point server instances belong. These parameters uniquely identify a local access point. $local_access_point is a reference to a Tuxedo::Admin::LocalAccessPoint object.
Retrieves a list of local access points.
@local_access_points = $admin->local_access_point_list(\%filter);
where %filter is an optional reference to a hash that specifies attributes that each local access point in the returned list must have and @local_access_points is a list of references to Tuxedo::Admin::LocalAccessPoint objects that match the filter.
Retrieves information about a specific remote access point.
$remote_access_point = $admin->remote_access_point($access_point_name, $access_point_id);
where $access_point_name is the local name for the remote access point and $access_point_id is the external identifier for the remote access point. These parameters uniquely identify a remote access point. $remote_access_point is a reference to a Tuxedo::Admin::RemoteAccessPoint object.
Retrieves a list of remote access points.
@remote_access_points = $admin->remote_access_point_list(\%filter);
where %filter is an optional reference to a hash that specifies attributes that each remote access point in the returned list must have and @remote_access_points is a list of references to Tuxedo::Admin::RemoteAccessPoint objects that match the filter.
Retrieves the TDomain configuration for a specific access point.
$tdomain = $admin->tdomain($access_point_name, $network_address);
where $access_point_name is the local name for the access point that this TDomain configuration is for and $network_address is the network address (host and port) for this access point. $tdomain is a reference to a Tuxedo::Admin::TDomain object.
Retrieves a list of TDomain configurations.
@tdomains = $admin->tdomain_list(\%filter);
where %filter is an optional reference to a hash that specifies attributes that each TDomain configuration in the returned list must have and @tdomains is a list of references to Tuxedo::Admin::TDomain objects that match the filter.
Retrieves information about a specific imported resource.
$imported_resource = $admin->imported_resource($resource_name);
where $resource_name is the name of the imported resource. $imported_resource is a reference to a Tuxedo::Admin::ImportedResource object.
Retrieves a list of imported resources.
@imported_resources = $admin->imported_resource_list(\%filter);
where %filter is an optional reference to a hash that specifies attributes that each imported resource in the returned list must have and @imported_resources is a list of references to Tuxedo::Admin::ImportedResource objects that match the filter.
Retrieves information about a specific exported resource.
$exported_resource = $admin->exported_resource($resource_name);
where $resource_name is the name of the exported resource. $exported_resource is a reference to a Tuxedo::Admin::ExportedResource object.
Retrieves a list of exported resources.
@exported_resources = $admin->exported_resource_list(\%filter);
where %filter is an optional reference to a hash that specifies attributes that each exported resource in the returned list must have and @exported_resources is a list of references to Tuxedo::Admin::ExportedResource objects that match the filter.
Returns a description of the status of the last call that changed the current Tuxedo application.
$status = $admin->status();
Prints a description of the status of the last call that changed the current Tuxedo application to the given file handle, or to STDOUT if no file handle is given.
$admin->print_status(*STDERR); $admin->print_status();
To install Tuxedo::Admin, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Tuxedo::Admin
CPAN shell
perl -MCPAN -e shell install Tuxedo::Admin
For more information on module installation, please visit the detailed CPAN module installation guide.