NAME

webjob-create-profile - Create a WebJob profile.

SYNOPSIS

webjob-create-profile [-C webjob-client-home] [-e {plain|base64}] [-g jqd-group[,jqd-group[...]]] [-H webjob-home] [-h host] [-i ip] [-n webjob-server-cn] [-o option[,option[,...]]] [-P password] [-r registration-code] [-S webjob-server-home] [-s webjob-server] [-T timeslot] -p {unix|winx} -c client [key=value [...]]

DESCRIPTION

This utility creates a WebJob profile.

OPTIONS

-C webjob-client-home

This option specifies the home directory for the WebJob client. Any config files created for the client will include this directory where appropriate. The default value is '/usr/local/webjob'. This value is stored in the client database as 'WebJobHome'.

Note: Take care to escape backslashes and use single quotes when specifying Windows paths. For example, 'C:\Program Files\WebJob' should be specified like so:

    -C 'C:\\Program Files\\WebJob'

-c client

This option specifies the client's profile name (a.k.a. client ID). By convention, the client ID is created by combining the string 'client_' with the first name of the client's hostname. For example, if the client's FQDN was 'foo.com', then its client ID would be 'client_foo'.

-e {plain|base64}

Encode passwords using the specified scheme. The default value is 'base64'.

-g jqd-group[,jqd-group[...]]

This option specifies one or more groups to which the client should be added. Note that all clients are added to the 'all' group by default. Similarly, local clients (-L) are added to the 'all_local' group by default. This option is for specifying additional groups beyond 'all' and 'all_local'.

-H webjob-home

This option specifies the home directory for the utilities used by this script. The default value is '/usr/local/webjob'.

-h host

This option specifies the client's hostname. If not specified, this value is derived from the client ID (-c). This value is stored in the client database as 'Hostname'.

-i ip

This option specifies the client's IP address. This value is stored in the client database as 'Ipv4Address', and it is used to set the initial value for 'HostAccessList'.

-n webjob-server-cn

This option specifies the common name of the WebJob server. If not specified, this value is automatically obtained using hostname(1).

-o option,[option[,...]]

Specifies the list of options to apply. Currently, the following options are supported:

Force

Force the creation (or recreation) of the specified profile. By default, profiles that already exist (in full or part) are not touched.

ForcePassword

Force the password to be reset to a user-specified or random value depending on whether the -P option has been set or not.

LocalProfile

Indicates that the profile should be created as a local profile, which means that it actually resides on the WebJob server.

LockProfile

Indicates that the profile should be locked upon creation.

-P password

This option specifies the client's password. The minimum password length is eight characters, and passwords must consist of characters from the following character set: [0-9A-Za-z/+]

-p {unix|winx}

This option indicates the client's platform (either UNIX or Windows). The platform determines which skeleton files to use during profile creation. This value is stored in the client database as 'OsClass'.

-r registration-code

This option specifies the client's registration code. This value is stored in the client database as 'RegistrationCode'.

-S webjob-server-home

This option specifies the home directory of the WebJob server. The default value is '/var/webjob'.

-s webjob-server

This option specifies the hostname or IP address of the the WebJob server. If not specified, this value is automatically obtained using hostname(1).

-T timeslot

This option specifies the client's timeslot, which should be a number in the range [0-29]. The timeslot represents the minute at which the client is supposed to check in for its hourly job. By default, the timeslot is computed automatically except for local profiles, which get a default value of zero. Specifying this option overrides that behavior. This value is stored in the client database as 'Timeslot'.

RETURN VALUES

Upon successful completion, a value of 0 (XER_OK) is returned. Otherwise, one of the following error codes is returned:

• 1 = XER_Usage

• 2 = XER_Abort

• 3 = XER_PartialSuccess

• 4 = XER_PasswordRequired

SEE ALSO

webjob-delete-profile(1) and webjob-lock-profile(1)

AUTHOR

Klayton Monroe with contributions from Andy Bair, Hank Leininger, and Jason Smith.

HISTORY

This utility was initially written to support WebJob deployments.

LICENSE

All documentation and code are distributed under same terms and conditions as WebJob.