Manual Chapter : GLOBAL-SITE Administator Guide v1.0: Administrative Commands

Applies To:

Show Versions Show Versions

GLOBAL-SITE Controller

  • 1.0 PTF-03, 1.0 PTF-02, 1.0 PTF-01, 1.0.0
Manual Chapter


B

Administrative Commands



Using global/SITE commands

This appendix contains an alphabetic listing of the various global/SITE Controller commands, and a syntax sample. Most entries include descriptions of their typical usage, and some contain additional information about the command.

Available options include:

-i interactive, prompts you for next parameter as you enter each one. Some commands that require only two or three arguments, and/or very repetitive by nature, do not have this option.

Options specific to only a few commands are documented with the command.

Arguments enclosed in brackets [ ] are optional.

Note that there are some differences in terminology between the browser interface and the command line utility. Following is a quick reference chart. For a listing of command utility terminology refer to Appendix A; for a complete browser interface glossary, refer to the Glossary.

command utility browser interface
edition edition
primary publisher
pub group publication
publication target subscriber
repeater distributor
repository section


gsActivatePubGroupRepos

gsActivatePubGroupRepos <pubgroup name> <repository name> gsActivatePubGroupRepos [-i]

Description

This command activates a section, <repository name>, attached to publication, <pubgroup name>, for use by that publication. By default, a section is active, unless specifically declared inactive (see command gsInactivatePubGroupRepos). Active sections can be included when creating new editions. When updating sections, only active sections are to be updated, unless a specific list of sections to be updated is given (see gsUpdateReposFromStage).

The second form is the interactive form and is either without any arguments or simply with the -i option.



gsCancelCommitPhase

gsCancelCommitPhase [-v] <pub group name>

Description

This command cancels an active publication in any of the commit states:

  • CommitPhase
  • CommitPhaseSuspended
  • CommitPhaseCanceled
  • CommitPhaseFailed
  • CommitPhaseDone

    If successful, the publication returns to Idle state.

    The optional -v switch can be included to give additional verbose printout.



gsCancelCopyPhase

gsCancelCopyPhase [-C][-v] <pub group name>

Description

This command cancels an active publication in any of the change tree or copy states:

  • CreateChangeTree
  • ChangeTreesSusupended
  • ChangeTreesCanceled
  • ChangeTreesFailed
  • ChangeTreesDone
  • CopyPhase
  • CopyPhaseSuspended
  • CopyPhaseCanceled
  • CopyPhaseFailed
  • CopyPhaseDone

    The -C option sets the overall pubgroup state to Idle, allowing the publishing process to be restarted from the beginning. Without the
    -C option, any completed or failed operation will not be canceled. Only operations in process, as well as those that have not started yet will be canceled.

    The optional -v switch can be included to give additional verbose printout.



gsCancelEdition

gsCancelEdition <pub group name>

Description

This command cancels an active publication in any of the edition states:

  • CreatingEdition
  • EditionReadySuspended
  • EditionReady
  • EditionFailed

    The publication is set to Idle state.



gsCancelUpdateFromStage

gsCancelUpdateFromStage [-C] <pub group name>

Description

This command will stop updates in process, as well as cancel those that have not started yet.

Using this command with -C option sets the publication back to Idle (in the event that the gsUpdateReposFromStage command was interrupted before all updates were complete).



gsCancelWanSync

gsCancelWanSync [-C] [-v] <pub group name>

Description

This command cancels a publication in the following states:

  • WANSync
  • WANSyncSuspended
  • WANSyncCanceled
  • WANSyncDone
  • WANSyncFailed

    The -C option cancels and sets the publication back to Idle state. Without the -C option, any completed or failed operation will not be canceled. Only operations in process, as well as those that have not started yet, will be canceled.

    The optional -v switch can be included to give additional verbose printout.



gsChangeFtpPath

gsChangeFtpPath <node name> <user name> <old path> <new path>

Description

Allows the user to modify the FTP path name.

The <node name> variable is node name to which FTP access entry applies. The <user name> variable is the current user name. The <old path> variable is the old full path, for example, /usr/websrc/seahawks. The <new path> variable is the new full path, for example, /usr/websrc/seahawks.



gsCompletePublish

gsCompletePublish <pub group name>

Description

This command completes the publication process once the publication is in either CommitSuspended, CommitDone, or CommitCanceled state.

Paths for which the Commit phase completed successfully will be updated with the appropriate edition, version(s), section(s), and a state of Idle.

Note: Paths for which the Commit phase failed will be set to a state of CommitIncomplete. Edition, version(s), section(s) information for that path will NOT change.

The publication is set to Idle state, and if any path at all was successful, its published edition is set to the edition just published.



gsConnectFtpPathRepeater

usage: gsConnectFtpPathRepeater name=<nodename> user=<username> path=<directory path> repeater=<nodename> usage: gsConnectFtpPathRepeater [-i]

Description

This command associates a particular path with a specific distributor. Both must already exist (see gsCreateRepeater and gsCreateFtpPath).

The second form is the interactive form and is either without any arguments, or simply with the -i option.



gsConnectPubGroupPath

gsConnectPubGroupPath name=<pub group>, node=<node name> user=<user name> [accesstype=<type>] path=<directory path> gsConnectPubGroupPath [-i]

Description

This command assigns a particular path to a specific publication as a potential target for publication. Both must already exist (see
gsCreatePubGroup and gsCreateFtpPath).

The second form is the interactive form and is either without any arguments or simply with the -i option.



gsConnectPubGroupRepos

gsConnectPubGroupRepos <pubgroup name> <repository name> gsConnectPubGroupRepos [-i]

Description

This command assigns a specific section to be used as a source of content for a specific publication. Both must already exist (see
gsCreatePubGroup and gsCreateRepos).

The second form is the interactive form and is either without any arguments or simply with the -i option.



gsConnectReposSource

gsConnectReposSource name=<reposname> node=<nodename> [accesstype=<access type string>] access=<username> path=<access path> gsConnectReposSource [-i]

Description

This command assigns a particular path as a staging source for this section. Both must already exist (see gsCreateRepos and
gsCreateFtpPath).

The second form is the interactive form and is either without any arguments or simply with the -i option.



gsConnectSourceToTarget

gsConnectSourceToTarget name=<pub group>, repository=<repository> node=<nodename> user=<username> [accesstype=<type>] path=<directory path> gsConnectSourceToTarget [-i]

Description

For the specified publication, this command specifies a section to be used as a source for content for the specified path. The publication, section, and path must already exist (see
gsCreatePubGroup, gsCreateRepos, and gsCreateFtpPath). If the section and (or) the path have not already been associated with this specified publication, an attempt to do so will be made by this command. (For example, it will effectively attempt a
gsCommitPubGroupRepos and/or gsCommitPubGroupPath.)

The second form is the interactive form and is either without any arguments or simply with the -i option.



gsCreateEdition

gsCreateEdition pubgroup=<pubgroup name> version=<vers. number>:<repos. name> ... gsCreateEdition [-i]

Description

This command creates a new edition for the publication. If the non-interactive form of this command is used, the version/section pair for each section to be published as a part of this edition must be specified. If the interactive -i form of this command is used, the user will be prompted to enter the version for each active section.

The second form is the interactive form and is either without any arguments or simply with the -i option.



gsCreateFtpAccess

gsCreateFtpAccess name=<nodename> [description=<string>] user=<username> password=<password> gsCreateFtpAccess [-i]

Description

Creates FTP access to the created primary, repeater, staging, or target servers.

The <name> variable is the name of a node on which you want FTP access. The <description> variable is the string describing the access entry. The <user> variable is the user name for FTP logon. The <password> is the clear text password for this user name.

The second form is the interactive form and is either without any arguments or simply with the -i option.



gsCreateFtpPath

gsCreateFtpPath name=<nodename> user=<username> path=<directory path> [repeater=<nodename>] gsCreateFtpPath [-i]

Description

This creates a path associated with an access entry (and its node).

The <name> variable is a node name to which FTP access entry applies. The <user> variable is the user name. The <path> variable is the full path, that is, /usr/websrc/seahawks. The <repeater> variable specifies the repeater name, if applicable and preferred at this point.

Both the node name, user name, and repeater must already be known to the global/SITE Controller at this point (see gsCreateNode, gsCreateFtpAccess, and gsCreateRepeater).



gsCreateNode

gsCreateNode name=<nodename> [description=<string>] [cpu=<string>] [opsys=<string>] gsCreateNode [-i]

Description

Create global/SITE Controller nodes for primary, distributor FTP accesses. Note that the local node is automatically created.

The primary is the main device performing most of the processing of content replication. Configuration and operational elements are stored in the configuration database resident on this device.

The <name> variable is a name by which the node can be accessed.

Note that if the node is to be used as a distributor, gsCreateRepeater will change the node name to a fully-qualified node name, if it is not already. For example, if gsCreateNode creates a node named dist1, gsCreateRepeater will change that node name to a fully-qualified node name. For example, assume gsCreateNode is used to create a node named dist1. If gsCreateRepeater is given the same name, the node and the repeater will be changed to a fully-qualified name; for example, dist1.dev.net.

The <description> variable is any additional description other than CPU type and operating system, that is, Western Region Production Machine.

The <cpu> variable is a string describing the CPU, that is, Intel PII or Alpha 8400.

The <opsys> variable is a string describing the operating system, that is, Linux or Windows NT.

The second form is the interactive form and is either without any arguments or simply with the -i option.



gsCreatePubGroup

gsCreatePubGroup name=<pubgroup name> [pubstop=<pubstop type...>] [puberror=<puberror option>][description=<string>] gsCreatePubGroup [-i]

Description

This command creates a new publication. The pubstop= argument can be used as many times as necessary to specify the desired pub stops (None, AfterEditionCreation, AfterPubPrep, AfterWANSync, AfterChangeTrees, AfterCopy, AfterCommit).

Note that only AfterWANSync, AfterCopy, and AfterCommit are supported via the browser-based interface.

The puberror= option specifies action to be taken when a publication phase detects an error. Currently, the browser interface supports only one action, Cancel, but the command utility supports three: Cancel, Pause, LogAndContinue.

The second form is the interactive form and is either without any arguments or simply with the -i option.



gsCreateRepeater

usage: gsCreateRepeater name=<nodename> [description=<string>] [identifier=<installation ID>] [secret=<encryption string>] where installation ID is either decimal or hexadecimal (0xffff) usage: gsCreateRepeater [-i]

Description

This command creates a repeater (distributor) that distributes the primary's (publisher) content to the target servers. Repeaters are remotely located and serve remote content servers (subscribers).

The <name> variable is the node name (already created by gsCreateNode) of the repeater/distributor.

The <identifier> variable is the installation ID (GSID) assigned when the global/SITE Controller was shipped.

The <description> variable is any description string.

The <secret> variable is the string used to create the 56-bit encryption key used to communicate with the distributor.

The second form is the interactive form and is either without any arguments or simply with the -i option.

The repeater name will be used to look for a node (see gsCreateNode) as shown in the following table:

gsCreateRepeater
has fully-qualified name
gsCreateNode
has already created node with fully-qualified name
Result
No No Renames node to fully-qualified name. Creates repeater with fully-qualified name.
No Yes Creates repeater with fully-qualified name.
Yes No Creation fails because it either has no node created or it uses a short name.
Yes Yes Creates repeater with fully-qualified name.


gsCreateRepos

gsCreateRepos name=<reposname> [type=FTPStage] [description=<string>] [node=<nodename> [accesstype=<access type string>] access=<username> path=<accesspath>] gsCreateRepos [-i]

Description

This command creates a repository. A repository (section) is a collection of related directories and files stored at the primary server (publisher). The data was extracted from staging servers.

Note that the FTP path must be created before creating a repository.

The <name> variable is a name given to the repository that is useful to the user of the global/SITE Controller.

The <type> variable is the type of source for this repository, currently only FTPStage is available.

The <description> variable is any descriptive string.

The <node> variable is the source node (stage) for FTP access.

The <accesstype> variable is currently unnecessary as there is only one type of source access, FTP.

The <access> variable is the user name of access entry.

The <path> variable is the source stage path from which this repository will retrieve its new versions.

The second form is the interactive form and is either without any arguments or simply with the -i option.



gsDeleteFtpAccess

gsDeleteFtpAccess <nodename> <username>

Description

This command removes the FTP access to the primary, repeater, staging, or target server.

The <name> variable is the node name on which FTP access is to be deleted.

The <user> variable is the user name for FTP logon.

All paths that use this access (this node and user) must have already been deleted (see gsDeleteFtpPath).



gsDeleteFtpPath

gsDeleteFtpPath node=<nodename> user=<username> path=<directory path> gsDeleteFtpPath [-i]

Description

This command removes the FTP path.

The <node> variable is the node name to which FTP access entry applies.

The <user> variable is the current user name. The <path> variable is the full path; for example, /usr/websrc/seahawks.

The second form is the interactive form and is either without any arguments or simply with the -i option.

The path cannot be deleted if it is recorded as having published content on it.

You must either:

  • Actually publish an edition with the null revision (currently version -1) for that section, requiring that you set other paths served by that section(s) to unavailable so their data will not be removed, also
  • Use the command gsSetPublished to simply record this path as empty, using an edition with version -1, without actually publishing to it.


gsDeleteNode

gsDeleteNode <nodename>

Description

This command removes a node used by a repeater, staging, or target server.

The node cannot be deleted if there is a repeater by that name or any FTP access entries that reference the node to be deleted.



gsDeletePubGroup

gsDeletePubGroup <pubgroup name>

Description

This command deletes the publication. All connected objects (paths, sections) must be disconnected first.



gsDeleteRepeater

gsDeleteRepeater <node name>

Description

This command deletes a repeater. All paths must be disconnected first (see gsDisconnectFtpPathRepeater).



gsDeleteRepos

gsDeleteRepos <reposname>

Description

This command removes repository information. The repository must no longer be connected to any publication (see gsDisconnectPubGroupRepos).

The <reposname> is a name given to the repository.

Warning: We do not recommend use of this command, until cleanup of the repository copies on distributors is complete.



gsDeleteVersions

usage: gsDeleteVersions repos=<repository name> [begin=<version number>] [end=<version number>] [keep=<min. number to keep>] [age=<min. age to delete>] [verbose=<y/n>] usage: gsDeleteVersions [-i]

Description

This command deletes versions from a section.

The [begin] variable is the optional first version number to consider deleting.

The [end] variable is the optional last version number to consider deleting.

The [keep] variable is the minimum number of versions to keep.

The [age] variable is the minimum age in days to delete.

The [verbose] variable provides the option to get detailed information.

The second form is the interactive form and is either without any arguments or simply with the -i option.



gsDestroyPubSubscriber

usage: gsDestroyPubSubscriber name=<pub group>, node=<nodename> user=<username> [accesstype=<type>] usage: gsDestroyPubSubscriber [-i]

Description

For the specified publication, this command tries to remove as much of the specified subscriber as possible.

First, an edition is temporarily created that specifies removal of all content for each section. For each path serviced by this subscriber, that edition is recorded as that path's published edition. This effectively means that nothing is published on that path. The path is then disconnected from the section(s) that is its source of content.

Next, the path is disconnected from the publication and from the distributor, after which the path is deleted. Once all paths have been processed, the FtpAccess entry <user> is deleted, including its node.

Finally, the newly created edition is deleted. There may be failures during the process, such as being unable to delete the user because other publications also use it; consequently, errors are ignored and as much as possible is done.

Warning: This procedure is dangerous. Be sure you understand the consequences before you use it.

The second form is the interactive form and is either without any arguments or simply with the -i option.



gsDisconnectFtpPathRepeater

usage: gsDisconnectFtpPathRepeater name=<nodename> user=<username> path=<directory path> usage: gsDisconnectFtpPathRepeater [-i]

Description

This command severs the connection between a path and its distributor, leaving the path disconnected from any distributor.

The second form is the interactive form and is either without any arguments or simply with the -i option.



gsDisconnectPubGroupPath

gsDisconnectPubGroupPath name=<pub group>, node=<nodename> user=<username> [accesstype=<type>] path=<directory path> gsDisconnectPubGroupPath [-i]

Description

This command disconnects the association between a content path and a publication leaving the path unserviced by any publication. Any connection between the path and a source section to be published on that path must be severed first (see
gsDisconnectSourceFromTarget).

The second form is the interactive form and is either without any arguments or simply with the -i option.



gsDisconnectPubGroupRepos

gsDisconnectPubGroupRepos <pubgroup name> <repository name> gsDisconnectPubGroupRepos [-i]

Description

This command disconnects the association between a section and a publication. The section must first be disconnected from any content targets (see gsDisconnectSourceFromTarget).

The second form is the interactive form and is either without any arguments or simply with the -i option.



gsDisconnectReposSource

usage: gsDisconnectReposSource name=<reposname> node=<nodename> [accesstype=<access type string>] access=<username> path=<access path> usage: gsDisconnectReposSource [-i]

Description

This command severs the relationship between a section and its staging (source) path, leaving the section without a source/stage.

The second form is the interactive form and is either without any arguments or simply with the -i option.



gsDisconnectSourceFromTarget

gsDisconnectSourceFromTarget name=<pub group> repository=<repository> node=<nodename> user=<username> [accesstype=<type>] path=<directory path> gsDisconnectSourceFromTarget [-i]

Description

This command disconnects the source section from the target content path, leaving both the section and path still associated with the publication.

The second form is the interactive form and is either without any arguments or simply with the -i option.



gsInactivatePubGroupRepos

gsInactivatePubGroupRepos <pubgroup name> <repository name> gsInactivatePubGroupRepos [-i]

Description

This command inactivates a section for the specified publication. While the section is inactivated, it cannot be used in any new editions created. It also will not be updated by gsUpdateReposFromStage, unless it is specifically included by the command line.

The second form is the interactive form and is either without any arguments or simply with the -i option.



gsPrepareToPublish

gsPrepareToPublish <pub group name> <edition number>

Description

This command prepares a publication and the distributors to be used for a publishing cycle using the specified edition.

The publication is left in the state PubPrepDone.

Normally, the gsPublish command should be used rather than this command. Use this command only if you only want to prepare to publish, and then pause.



gsPublish

usage: gsPublish [-v] [-d] <pub group name> <edition number>

Description

This command directs the publication to start publishing, or to resume publishing from some previously stopped publishing cycle. If <edition number> is zero, the publication will first update all active sections, and then create a new edition using the latest version from each section.

The optional -v switch can be included to give additional verbose printout.

The optional -d switch causes the process to fork (used primarily for testing at F5 Networks).



gsResetPubGroupState

gsResetPubGroupState <pub group name> <state>

Description

This command is used to set the pubgroup to Idle immediately after preparing a publication with gsPrepareToPublish, thus canceling the publishing process before proceeding further. Use one of the phase-specific gsCancel commands for all other states.



gsResetReposState

gsResetReposState <repos name> <state>

Description

This command is used to set the repositories to Idle after updating sections with gsUpdateReposFromStage only if some abnormal occurrence left the section in a state other than Idle.



gsSetFtpAccessInfo

gsSetFtpAccessInfo node=<nodename> user=<username> [newname=<new username>] [description=<string>] [password=<new password>] gsSetFtpAccessInfo [-i]

Description

This command allows modification of the FTP information.

The <node> variable is a node name to which FTP access entry applies.

The <user> variable is the current user name.

The <newname> is a new user name.

The <description> a new description.

The <password> is new clear text password.

The second form is the interactive form and is either without any arguments or simply with the -i switch.



gsSetFtpAccessPathState

gsSetFtpAccessState node=<nodename> user=<username> path=<full path> state=<state> gsSetFtpAccessState [-i]

Description

This command is used to set the state of a path to either Idle or Unavailable.

Setting the path to Idle, allows publishing to that path.

Setting the path to Unavailable prohibits any publishing to that path.

The second form is the interactive form and is either without any arguments or simply with the -i switch.



gsSetNodeInfo

gsSetNodeInfo name=<nodename> [newname=<new nodename>] [description=<string>] [cpu=<string>] [opsys=<string>] gsSetNodeInfo [-i]

Description

This command allows the previously-entered information to be changed.

The <newname> variable is the new node name of the node. It can be the alias. If the node is to be a distributor node, be aware of the ramifications of renaming the node (see gsCreateNode).

The <description> variable is any additional description other than cpu type and operating system, for example, Western Region Production Machine.

The <cpu> variable is a string describing the cpu, for example, Intel PII or Alpha 8400.

The <opsys> variable is a string describing the operating system, for example, Linux or Windows NT.

An example:

[saxon@saxon mgmtdi]$ gsSetNodeInfo -i Enter Current Node Name: saxon55
Enter New Node Name [.=saxon55]: . Enter CPU description [.Pentium II]:. Enter Operating System description [.=Windows NT]: WNT Enter additional description [.=Personal Workstation]:. set info completed. [saxon@saxon mgmtcli]$

Notice the use of the period (.) to denote no change; the current value is displayed in brackets, showing what the entry of a period (.) will leave as the value.

The second form is the interactive form and is either without any arguments or simply with the -i switch.





gsSetPubGroupInfo

gsSetPubGroupInfo name=<pubgrp name> [newname=<new pubgrp name] [description=<description>] [protocol=<publishing protocol>]
[pubstop=<pubstop type> ...] [puberror=<puberror option>]
gsSetPubGroupInfo [-i]

Description

This command is used to modify publication information.

The <newname> variable is used to change the publication's name.

The <description> variable is used to change the description.

The <pubstop> variable is used to change the pubstops, and can be repeated as often as necessary (see gsCreatePubGroup).

The <puberror> variable is used to change the action taken when a phase detects that an error occurred (see gsCreatePubGroup).

The second form is the interactive form and is either without any arguments or simply with the -i switch.



gsSetPublished

usage: gsSetPublished pubgroup=<name> edition=<edition number> [[node=<nodename> user=<username>] path=<directory path>] [setedition=no] usage: gsSetPublished [-i]

Description

This command sets information as to the edition published without actually publishing the edition.

If <node>, <user>, and <path> are specified, only that path is set to say that <edition> (and the appropriate version/section) is published on it.

If only <node> and <user> are specified, all paths for that node/user pair are set for this publication.

If <node> and <user> are not specified, all paths for this publication are set.

If <set edition> is yes, <edition> is set as the published edition for this publication.

Warning: Use this command with CAUTION.

The second form is the interactive form and is either without any arguments or simply with the -i switch.



gsSetRepeaterInfo

usage: gsSetRepeaterInfo name=<nodename> [description=<string>] [identifier=<installation ID>] [secret=<encryption string>]

Where the installation ID is either decimal or hexadecimal (0xffffffff).

usage: gsSetRepeaterInfo [-i]

Description

This command changes the distributor information.

The second form is the interactive form and is either without any arguments or simply with the -i switch.



gsSetReposInfo

gsSetReposInfo name=<reposname> [newname=<new repos name] [description=<description>] [[exception=<full path> ... ] | [[exception+=<full path> ... ] [exception-=<full path> ... ]]] gsSetReposInfo [-i]

Description

This command modifies repository information.

The <reposname> variable is a name given to the repository.

Use of <exception> precludes use of <exception+ > or
<exception- >, and replaces the section's exception paths with the specified paths (can be used multiple times in one command).

Use of <exception+ > and/or <exception- > specifies adding and removing exception paths, respectively (can be used multiple times in one command).

The second form is the interactive form and is either without any arguments or simply with the -i switch.



gsShowAllFtpAccess

gsShowAllFtpAccess [-v]

Description

This command prints on screen a list of all <node> and <user> pairs.

The -v option prints out detailed information for each, including a clear-text password.



gsShowAllNodes

gsShowAllNodes [-v]

Description

This command prints, on screen, a list of all nodes.

The - v option prints out detailed information for each node.



gsShowAllPubGroups

gsShowAllPubGroups [-v]

Description

This command prints, on screen, a list of all publications.

The -v option prints out detailed information for each publication.



gsShowAllRepeaters

gsShowAllPubGroups [-v]

Description

This command prints, on screen, a list of all distributors.

The -v option prints out detailed information for each distributor.

Sample response with -v option:

Node: globalsite4.your.net Type: Repeater Description: Local node distributor State: Idle Mode: Direct Installation ID: 0x4 Encryption Secret: no paths currently connected to this repeater...

Another partial sample response:

Node: globalsite2.your.net Type: Repeater Description: State: Idle Mode: Direct Installation ID: 0x2c Encryption Secret: GlobalSiteTest Repeats to following trees: Node: 30.30.30.30 Type: FTP FTP Access Entry: gsite Path: /gSITE/prod/targ2/images Node: 30.30.30.30 Type: FTP Ftp Access Entry: gsite Path: /gSITE/prod/targ2



gsShowAllRepos

gsShowAllRepos [-v]

Description

This command prints on screen a list of all sections.

The -v option prints out detailed information for each section.



gsShowFtpAccess

gsShowFtpAccess <nodename> <username>

Description

This command displays FTP access information for one specific user, including clear-text password.

The <nodename> variable is a node name to which FTP access entry applies.

The <username> variable is the user name.



gsShowNode

gsShowNode <nodename>

Description

This command displays information pertaining to a specific primary, repeater, staging, or target server.



gsShowPubGroup

gsShowPubGroup <pubgroup name>

Description

This command displays information pertaining to a specific publication.



gsShowPubStatus

gsShowPubStatus <pubgroup name>

Description

This command displays information pertaining to the status of a specific publication step.



gsShowRepeater

gsShowRepeater <node name>

Description

This command shows the status of a repeater (in the browser interface, the distributor).



gsShowRepos

gsShowRepos <repository name>

Description

This command displays repository information.

The <reposname> is a name given to the repository.



gsStartCommitPhase

gsStartCommitPhase <pub group name>

Description

This command starts the commit phase of a publishing cycle. The previous phase, copy phase, must be completed, and is indicated by the publication state.



gsStartCopyPhase

gsStartCopyPhase [-v] [-w | -r]] <pub group name>

Description

This command starts the copy phase of a publishing cycle. The previous phase, WANSync phase, must be completed, and is indicated by the publication state.

The -w option stops processing after the change trees are prepared, but before they are actually copied to the publication targets. It can be used with the -v option, which displays additional status information. After the change trees are prepared, the user is queried as to whether to continue with the actual copy or not.

If the copy phase is not performed immediately (after saying "no" to the -w prompt), then the copies can be initiated without recreating the changed files by using the -r option to resume the copy phase. It can be used with the -v option, which displays additional status information.

The -v option alone proceeds with both change trees, and the copying of changed files to the publication targets, providing additional status information during the process.

Using none of the options proceeds with change trees and copying of changed files to the publication targets without providing the additional status information.



gsStartWanSync

gsStartWanSync [-v] <pub group name>

Description

This command starts the WANSync phase of publishing. Publication preparation must be successfully completed (see
gsPreparetoPublish).

The optional -v switch can be included to give additional verbose printout.



gsUpdateReposFromStage

gsUpdateReposFromStage <pub group name> [reposname ...]

Description

By specifying the optional list of repositories, this command initiates an update operation only for those repositories specified, as opposed to all active repositories in the pubgroup, which is the default.

Specifying the optional list can override a repository's inactive status temporarily by including it in the specified list, or override its active status temporarily by not including it in the list.

Example:

gsUpdateReposFromStage Pub1 section1 section2

Only Section 1 and Section 2 are being updated.

gsUpdateReposFromStage Pub1

All sections on the active list are being updated.

d to as section.