N1 Grid Service Provisioning System 5.0 Command-Line Interface Reference Manual

cdb.rsrc: Managing Components

The cdb.rsrc commands provide general-purpose controls for managing components.

Table 3–36 CLI Commands for Managing Components

Command 

Description 

cdb.rsrc.ci 

Checks in certain components and their resources to the repository. 

cdb.rsrc.cib 

Checks in all the components listed in a batch file. 

cdb.rsrc.co 

Checks out the specified component. 

cdb.rsrc.rci 

Rechecks in a component. 

cdb.rsrc.showopts 

Shows the check-in options that are supported by a particular type. 

cdb.rsrc.ci

Use the cdb.rsrc.ci command to check in certain components and their source objects. You will need to use this command in the following scenarios.

Each invocation of the cdb.rsrc.ci command is considered a “check-in job,” and can be managed with the CLI commands for managing check-in jobs. For example, to determine which cdb.rsrc.ci commands are running, you can run the cdb.cj.la command, which lists all the current check-in jobs. You can also pass compCheckInID value returned by cdb.rsrc.ci as an argument to cdb.cj.lo to get status information about a specific check-in job.

Table 3–37 Arguments and Result for the cdb.rsrc.ci Command

Argument/Result 

Syntax 

Description 

src 

[R] 

String 

The local file/directory being checked in 

dst 

[R] 

String 

Which component name to check in as 

type 

[R] 

String 

The type of the component 

platform 

[O] 

HostSetID 

The platform of the component 

desc 

[O] 

String 

A description of the component 

major 

[O] 

Boolean 

Whether the version increment should be major or minor, default false 

config 

[O] 

Boolean 

Whether the component is a config file; the default is false 

hidePrev 

[O] 

Boolean 

Whether to hide the latest component; the default is true 

includeOwners 

[O] 

Boolean 

Whether to include owner information; the default is true 

includeGroups 

[O] 

Boolean 

Whether to include group information; the default is true 

addTo 

[O] 

Boolean 

Whether the files being checked in should be added to the existing files to create a new version of the component, instead of completely replacing the existing files to create a new component 

hostID 

[O] 

HostID 

The ID of the local host 

redun 

[O] 

Boolean 

Whether redundancy checking should apply; the default is true 

pickerName 

[O] 

String 

The name of the component picker to use (defaults to null for the default picker). 

extraOpts 

[O] 

Hashtable 

Names and values for any additional options for the type. config, includeOwners, includeGroups, addTo, and redun cannot be specified using the extraOpts argument. Instead, use the command-line equivalent options described in this table to specify these values.

result 

CompCheckInID 

The ID for this component check in job. 

cdb.rsrc.cib

The command is the “check-in batch” command. It checks in all the components listed in a batch file.

Table 3–38 Arguments and Result of the cdb.rsrc.cib

Argument/Result 

Syntax 

Description 

batchfile 

[R] 

String 

The name of the batch file listing the components to be checked in 

haltonerror 

[O] 

Boolean 

When true, first error will halt batch execution, default true 

pwdrelative 

[O] 

Boolean 

When true, relative paths are relative to the user directory; otherwise they are relative to the batchfile location, defaults to false 

result 

String 

Message indicating the operation is complete 

Overview of Batch Files

The rsrc.cib operates on a batch file that includes a line for each component that will be checked in. Batch files enable you to check-in large numbers of component with a single command.

Each line in the batch file corresponds to a single component on the local machine that will be checked in as a single component. Each line consists of a series of fields that are separated by the pipe character (|). Some fields are optional and may be omitted. If an optional field is omitted but is followed by other fields, the omitted field should be followed by a | character, so that rsrc.cib can accurately identify each field.

You can include comments in a batch file. Any line that begins with the pound character (#) is interpreted as a comment.

The following table describes the syntax of a line of a batch file.

Table 3–39 Syntax of a Line in a Batch File

Content 

Optional/Required 

The location of the component on the local machine 

Required 

The name to be assigned to the component when checked in 

Required 

The component type 

Required 

The platform the component is intended for expressed as a HostSetID in the form NM:<platform_name>, where <platform_name> is one of the platform names listed in Table 3–40.

Optional 

A description of the component 

Optional 

A boolean designation of whether the file is a configuration file 

Optional (Default is false) 

A boolean designation of whether check-in should be assigned a major version number (e.g., 2.0) 

Optional (Default is false) 

A boolean designation of whether to hide the previous most recent version of the component 

Optional (Default is true) 

A boolean designation of whether to include owner information when storing permissions information 

Optional (Default is true) 

A boolean designation of whether to include group information when storing permissions information 

Optional (Default is true) 

A boolean designation of whether the files being checked in should be added to the existing files to create a new version, instead of creating a new version by completely replacing the existing files 

Optional (Default is true) 

If this component is being checked in a from a host, the host ID of the host from which the component is being checked in  

Optional 

A boolean designation of whether redundancy checking should apply  

Optional (Default is true) 

The name of the picker to use (optional, defaults to null for the default picker) 

 

A Hashtable in string form containing extra options supported by the type's exporter. Note that the boolean values for the following cannot be specified using the extraOpts argument:

  • Whether the file is a configuration template

  • Whether to include owner information

  • Whether to include group information

  • Whether the files being checked in should be added to existing files

  • Whether to perform redundancy checking

Instead, use the batch file format equivalent options to specify these values. 

 

The following table lists the names that you can use in the fourth field of a batch file line to specify a platform for the component.

Table 3–40 Names for Platforms

Platform Name 

Description 

any

Any platform supported by the N1 Grid Service Provisioning System software 

AIX - any version

Either IBM AIX 5.1 or IBM AIX 5.2 

AIX 5.1

IBM AIX 5.1 

AIX 5.2

IBM AIX 5.2 

Solaris - any version

SolarisTM 6, Solaris 7, or Solaris 8 releases

Solaris 7

Solaris 7 release 

Solaris 8

Solaris 8 release 

Solaris 9

Solaris 9 release 

Solaris 10

Solaris 10 release 

Windows 2000 Server

Microsoft Windows 2000 Server 

Red Hat Linux

Red Hat Advanced Server 2.1 

Example of a Line in a Batch File

To check in a local file named home/etc/myfile as the component mypath/mycomponentname as the component type file for the platform Solaris 7 with the description “this is my file” and no designation as a configuration file, you would enter the following line in a batch file:


/home/myfile|mypath/mycomponentname|file|NM:Solaris 7|this is my file

If the file being checked in was a configuration file, you would add a boolean field to the end of the line and the field to true. For example:


/home/myfile|mypath/mycomponentname|file|NM:Solaris 7|this is my file|true 

If you wanted to omit a description for the mycomponent, you do change this line to the following (note the adjacent pipe separators):

/home/myfile|mypath/mycomponentname|file|NM:Solaris 7||true

To check in the component as a major version (e.g., 2.0 as opposed to 1.7), you would add true in the boolean field for major version check-ins:

/home/myfile|mypath/mycomponentname|file|NM:Solaris 7||true |true

If the check in was desired to not hide the previous component, the line above would become (note the additional false in the final field):

/home/myfile|mypath/mycomponentname|file|NM:Solaris 7||true |true|false

Similar format considerations apply to the optional boolean specifying whether to include owner and group information when storing permissions information.

Batch File Syntax

The N1 Grid Service Provisioning System software applies these rules when parsing batch files.

Invocation

Batch check in via text file is invoked via a cdb.src.cib command (“cib” = check in batch) of the form


cdb.rsrc.cib -batchfile [batchfile location] [-haltonerror true|false]
[-pwdrelative true|false]

Before checking in any components, the cdb.rsrc.cib command performs a syntax check of the file. Next it verifies the existence of all the local files that are to be checked in. If cdb.rsrc.cib detects errors in either of these processes, it reports the errors and halts execution (regardless of the setting of the --haltonerror boolean argument).

The haltonerror Argument

The command line includes an optional -haltonerror argument (false by default) that designates whether or not an error from the check-in of a single file should halt the check-in of subsequent files. This boolean argument applies only to errors encountered after cdb.rsrc.cib has performed its preliminary error-checking (described in the section above).

The pwdrelative Argument

The command line includes an optional -pwdrelative provision (false by default) that designates whether relative paths in the batch file should be interpreted as being relative to the current working directory (pwdrelative = true) or relative to the location of the batchfile (pwdrelative = false).

Batch File Processing

Batchfile processing is non-transactional. This means that if batch file processing fails and/or halts before completion, any components that have been successfully checked in remain checked in, and are not “un”-checked in.

Concurrent batch check ins are not arbitrated. If two different batch check-ins targeting the same set of components begin to run at the same time, there is no mechanism throttling the processing of one batch file while another completes. Both batch files will be processed in the interleaved manner that results from their proximate timing.

cdb.rsrc.co

This command checks out the specified component. It transfers a copy from the repository to the local machine.

Table 3–41 Arguments and Result for the cdb.rsrc.co

Argument/Result 

Syntax 

Description 

src 

[R] 

String 

The name of the component to transfer 

[R] 

String 

The version of the component 

dst 

[R] 

String 

The location where the component is to be placed 

result 

String 

Message indicating the operation is complete 

cdb.rsrc.rci

This command re-checks in a component. If a check-in job has been interrupted, you can use this command to repeat the check-in without artificially incrementing the version number of the checked-in component.

Table 3–42 Argument and Result for the cdb.rsrc.rci Command

Argument/Result 

Syntax 

Description 

ID

[R] 

ComponentID 

The ID of the component to re-check in. 

result 

CompCheckInID 

The ID of the resulting check in job.  

cdb.rsrc.showopts

The command shows the checkin options supported by a particular component type.

Table 3–43 Arguments and Result of the cdb.rsrc.showopts

Argument/Result 

Syntax 

Description 

type 

[R] 

String 

The type of the component 

result 

BrowserInfo[] 

The component picker names and options supported by the exporter