This action lets you assign a software group or a procedure group to target computers or computer groups (including software templates). If the software group contains subgroups, the subgroups take part in the assignment recursively.
Besides other information, the name of the job container or distribution used is printed on standard output.
This action has the following format:
swLibrary action=assignGroupToTarget name=group_name
{{computer=computer_name} |
{compgrp=computer_group_name | ccompgrp=(computer_group_name sep groupScope)}
[sep=separator_sign]
| {swTemplates=software_template_name}}
cname=[name]
[dname=distribution_name]
[unsealed]
[{nolinkage|transaction[rollback]|synchronized}[nocascade]]
[deliveryTime="YYYY-MM-DD hh:mm"]
[atTime="YYYY-MM-DD hh:mm"]
after={exacttime|boottime}
[calendarname=delivery_calendar]
[preaction={none|reboot|logoff}]
[postaction={none|reboot|logoff|rebootAtEnd|logoffAtEnd|shutdownAtEnd}]
[promptUser[={y|n}]]
[allowCancel[={y|n}]]
[execTimedOut[={y|n}]]
[prompt=days.hours]
[offline[={y|n}]]
[runAtShutdown[={y|n}]]
[preventLogon[={y|n}]]
[globalTime]
[nocalendar]
[resolveQuery]
[parameters=user_parameters]
[repeat={y|n}]
[stagingserver]
[jobTimeout=d.h]
[procedures=procedures_file]
[{{area=area_name} | {domain=domain_name} | toAllAreas}]
[sendTime="YYYY-MM-DD hh:mm"]
[haltTime="YYYY-MM-DD hh:mm"]
[jcPriority={1,...,10}]
[distPriority={1,...,10}]
[reinstall[={y|n}]]
Start time of the procedure at the target system.
The following values are valid:
The procedure is started immediately after reaching atTime.
The start of the procedure is delayed until the first boot after atTime has been passed.
If "allowCancel" or "allowCancel=y" is coded, the user will be granted to cancel the job's execution.
If "allowCancel=n" is coded, the user will not be granted.
If the parameter is not coded, the default is given by the related procedure's job option value.
If neither promptUser is set by this call nor already enabled, then this parameter is ignored. No warning is given.
Specifies the name of a Client Automation domain the distribution will be sent to.
The parameter can be coded more than once to specify a list of Client Automation domains.
If this parameter is coded then the distribution will be sealed and automatically sent to its destinations after the command has been successfully completed.
If neither the area nor the domain nor the toAllAreas parameter is coded, the distribution remains unsealed and can further be manipulated.
This parameter should not be coded with the domain or toAllAreas parameters.
(enterprise manager only)
Specifies the Specifies the date and time when the action will be started.
The date has the ISO format "YYYY-MM-DD hh:mm".
If the parameter is not coded, the actual date and time are used.
Specifies the name of the calendar that controls the time when the evaluation can take place.
Specifies the computer group to be addressed as a pair of group name and scope. By default, name and scope are separated by a dot ("."), but an alternate separator can be specified with the "sep" option. The separator should not be used as part of the names.
For the group scope only the following values are valid.
The group is created at the local domain manager,
The group has been created at the enterprise manager and may be replicated.
The "ccompgrp" can be coded with the "compgrp" in one call.
Specifies the the optional unique name of a job container.
If no cname parameter is given, a name is generated internally and the command line interface returns this identifier.
The generated jobs will be assigned to it.
If this job container does not exist, it will be created.
If it exists, then the generated jobs will be added - if the container is unsealed.
If it is sealed, cadsmcmd terminates with an error.
Specifies the computer group to be addressed.
The parameter can be coded more than once to address more than one computer group.
This parameter should not be coded with the computer or swTemplates parameters.
Specifies the name of a computer to be addressed.
The parameter can be coded more than once to address more than one computer.
This parameter should not be coded with the compgrp or swTemplates parameters.
(domain manager only)
Specifies the start time of delivery from the domain manager.
The date has the ISO format "YYYY-MM-DD hh:mm".
If the parameter is not coded, the actual date and time are used.
Specifies the priority that will be assigned to the distribution.
The priority specified has to be numeric and its value has to be greater or equal 1 and less or equal 10.
If not coded priority 5 is assumed.
Specifies the name of the distribution the jobs and job container will be stored in.
If the distribution already exists, then this distribution is used - if it is still open for manipulations, otherwise an error message is launched. If the distribution does not exist, it will be created.
If the parameter is not coded, a distribution of default name is generated.
(enterprise manager only)
Specifies the name of a Client Automation domain group the distribution will be sent to.
The parameter can be coded more than once to address a list of Client Automation domain groups.
If this parameter is coded then the distribution will be sealed and automatically sent to its destinations after the command has been successfully completed.
If neither the area nor the domain nor the toAllAreas parameter is coded, the distribution remains unsealed and can further be manipulated.
This parameter should not be coded with the area or toAllAreas parameters.
(enterprise manager only)
If "execTimedOut " or "execTimedOut=y" is coded, the job's execution will be automatically started when the user prompt times out.
If "execTimedOut=n", the job will not automatically be started.
If the parameter is not coded, the default is given by the related procedure's job option value.
If neither promptUser is set by this call nor is already enabled, then this parameter is ignored. No warning is given.
If "globalTime" or "globalTime=y" is coded, then the time specifications are based on the enterprise manager time.
If "globalTime=n" is coded, it is based on domain manager time. (default)
Specifies the date and time at which a distribution order should be halted. The date has to be specified in the ISO format "YYYY-MM-DD hh:mm".
For more information about resuming a halted distribution, see the resume command.
Specifies the priority of the job container.
The priority specified has to be numeric and its value has to be greater or equal 1 and less or equal 10.
If not coded the priority is not changed.
Specifies the jobTimeout expiration period of a job in the form “d.h” where d specifies the number of days and h the number of hours. The range of the parameter is configurable at the manager’s site. When the specified value exceeds the configured upper limit then the value is set to the upper limit, if the specified value goes below the lower limit then the lower limit is taken. No warning is given in any case.
jobTimeout should not be coded with the timeout parameter otherwise an error is reported. If none of the parameters is coded the default is given by 7.0.
Specifies the name of the group. If it is a software group the members of the group will be installed at the targets site.
The procedure of the members to run at the target can be specified and configured with the procedures option. If it is not coded the default install procedures of the members are taken.
If it is a procedure group the contained procedures will be executed at the target site.
If "noCalendar" is coded, a possible calendar at the target computer will be ignored for this job's execution.
If the parameter is not coded, the default is given by the related procedure's job option value.
The job linkage option is set to "Ignore cascading".
This parameter is allowed only if "transaction" or "synchronized" are coded.
Run the job independently of the other jobs in the container.
If "offline" or "offline=y" is coded, the connection between the target computer and the server will be released for the job's execution and reestablished thereafter.
If "offline=n" the connection will not be released.
If the parameter is not coded, the default is given by the related procedure's job option value.
Specifies the user parameters for the procedure.
Multiple user parameters must be separated by spaces inside double quotes.
If an empty string is coded, then no parameters are assumed.
If the parameter is not coded, the default is given by the related procedure's job option value.
Specifies the necessary actions that must take place after completion of the specified procedure. The following values are valid:
Performs no post-action.
Restarts the system after completion of the procedure.
Logs off the user after completion of the procedure.
Restarts the system after completion of all the jobs of this container.
Logs off the user after completion of all the jobs of this container.
Shuts down the target computer after completion of the jobs.
If the parameter is not coded, the default is given by the related procedure's job option value.
Specifies that necessary actions must take place before the specified procedure starts. The following values are valid:
Performs no pre-action.
Restarts the system before the start of the procedure.
Logs off the user before the start of the procedure.
If the parameter is not coded, the default is given by the related procedure's job option value.
If "preventLogon" or "preventLogon=y" is coded, then the user logon will be rejected during the job's runtime. If a user is already logged on, the execution of the job is delayed until the user logs off.
If "preventLogon=n" the user logon will not be rejected.
If the parameter is not coded, the default is given by the related procedure's job option value.
Specifies the name of the file defining the procedures to be used for the software group and / or to define individual job options for the procedures (software and procedure groups).
The content of this procedures file is shown in Procedures File Format.
Specifies the time period in which the user will be prompted for the job's start.
The period’s format is "d.h" where d means days and h means hours.
The range of this parameter is from three hours to seven days (from 0.3 to 7.0). If the specified value falls below the valid minimum, the value is replaced by the minimum. If the specified value exceeds the valid maximum, then the value is replaced by the maximum. No warning is given.
If "promptUser" or "promptUser=y" is coded, the user will be prompted for the job's execution.
If "promptUser=n", the user will not be prompted.
If the parameter is not coded, the default is given by the related procedure's job option value.
The “reinstall” option is optional, the default is “reinstall=n”.
If “reinstall” or “reinstall=y” is coded then a possible installation record related to the order is removed before the job is evaluated by the domain manager.
If “reinstall=n” is coded then such records will remain.
Note: Option only applies to install jobs. In any other cases it is ignored.
Evaluate a possibly related query group before the job is generated.
Set the job linkage option to "Enable Transaction".
If "runAtShutdown" or "runAtShutdown=y" is coded, the job's execution will start at shutdown only.
If "runAtShutdown=n", the job will start at any other time too.
If the parameter is not coded, the default is given by the related procedure's job option value.
This parameter is for Unix targets only.
Specifies the time to send the associated distribution to the addressed domain managers. The date has to be specified in the ISO format "YYYY-MM-DD hh:mm". If the parameter is not coded, the actual date and time is used.
(Enterprise manager only)
Specifies an alternate separator used with the "ccompgroup" option. The separator should not be part of the group name code with the "ccompgroup" options.
Deliver the related product also to the staging libraries of the scalability servers of the target computers.
This parameter applies to procedures of task type "install" only!
Specifies the name of the software template.
The parameter can be coded more than once to address more than one software template.
If it is coded, then the cname parameter becomes obsolete, the jobs to be generated are not assigned to any job container but to the software template. To do so, the software templates of the list should not be sealed.
This parameter should not be coded with the computer or compgrp parameters.
The job linkage option is set to "Synchronized job execution".
If coded the related distribution will be sent to all Client Automation domains registered at the enterprise manager.
"toAllAreas" should not be coded with the "area" or "domain" parameters.
If neither the area nor the domain nor the toAllAreas parameter is coded, the distribution remains unsealed and can further be manipulated.
(enterprise manager only)
The job linkage option is set to "Batch job execution".
This is the default.
The addressed job container remains unsealed after the generated job has successfully been created.
(domain manager only)
Notes:
If neither area, nor domain, nor toAllAreas is coded, the distribution container remains unsealed and further manipulation is possible.
The parameters "allowCancel," "execTimedOut" and "prompt" are valid, if the "promptUser" option is already set or is set by this command using the "promptUser" parameter.
If neither the "promptUser" option of a job nor the "promptUser" parameter of the command is set, these parameters will be ignored.
No warning is given.
|
Copyright © 2014 CA Technologies.
All rights reserved.
|
|