BLCLI commands added, updated, or removed in recent versions

This topic provides a reference summary of the BLCLI commands added or updated in the past few versions of BMC Server Automation. It includes the following sections:

BLCLI commands added or updated in recent versions

BLCLI commands added in version 8.6.00

The following BLCLI commands are new in version 8.6.00:

Namespace	Command
`Impersonation`	`createAutomationPrincipalWithPrivateKey` `updateAutomationPrincipalPrivateKeyFile`
`NSHScriptJob`	`getNSHScriptParamValues`
`PropertyInstance`	`listAllFullyResolvedNonDeprecatedPropertyValues`
`Utility`	`exportComplianceSummaryReport` `exportComplianceDetailsServerReport` `exportComplianceDetailsServerReportWithServerName` `exportJSONComponentTemplateDetails` `exportJSONComplianceJobRunDetails` `exportJSONServerWiseSummaryReport` `exportJSONServerDetailedReport` `exportJSONServerDetailedReportWithServerName` `exportJSONRuleWiseSummaryReport` `exportComplianceRuleDetailsReport` `exportJSONRuleDetailsReport` `generateDashboardReport`
`Virtualization`	`addVMwareVCAMO`

BLCLI commands added in version 8.5.01

The following BLCLI commands have been added or updated in BMC Server Automation 8.5 SP1:

BLCLI commands added in version 8.5.00

The following BLCLI commands are new or have been updated in version 8.5.00:

Namespace	Command
`AgentBundle`	`clearDefaultConfigFileContent` `clearOverriddenConfigFileContent`
`AppServerLauncher`	`listAppServerHostNames`
`BlAclPolicy`	`listObjectsDependentUponAclPolicy`
`BlPackage`	`applyAclPolicy`
`DBManager`	`blGatherSchemaStats`
`DepotFile`	`moveByGroupAndName` `copyFileContentsToPath` `replaceFileContents`
`DepotObject`	`copyDepotObject`
`ImportExport`	`importObjectUseDestinationProperty` `importObjectMergeEnumProperties`
`Job`	`getTargets` `moveByJobKeyAndGroup`
`JobRun`	`findLastRunKeyByJobKeyIgnoreVersion` `getExecutingUserAndRoleByRunKey`
`NSHScript`	`addNSHScriptToDepotByGroupName`
`PatchCatalog`	`executeDebianCatalogUpdateAndWait` `deleteObsoletePatchesFromDebianLinuxCatalog`
`PatchingJob`	`addQNumbersToExcludeListForDevices` `createDebianPatchingJobWithTargetGroup` `createDebianPatchingJobWithTargetServer` `getExcludePatchListForDevice` `getWindowsDeviceListForExcludePatch` `removeQNumbersFromExcludeListForDevices` `resetExcludePatchListForAllWindowsDevices` `resetExcludePatchListForSpecifiedDevices`
`PropertyInstance`	`applyAclPolicy` `getDBKeyByPropertyInstanceName`
`ProxyServer`	`listAllProxyServers`
`RBACRole`	`syncUsersWithNameSuffix`
`RBACUser`	`clearDefaultNSHRole`
`Schedule`	`findScheduleDetailsByExecutingRole` `findScheduleDetailsByExecutingUser` `findJobScheduleDetailsForDeletedOrDisabledUsers` `findJobScheduleDetailsForDeletedRole`s
`Server`	`bulkSetServerPropertyValuesAndLogResults` `getBulkServerPropertyValuesAndLogResults` `findAllServerObjectsByGroupInCustomServerObject`
`Utility`	`exportFileDeployRun`
`Virtualization`	`abortVirtualGuestJob` `cancelVirtualGuestJob`

BLCLI commands added in version 8.3.03

The following BLCLI commands have been introduced in BMC Server Automation 8.3 SP3:

Namespace	Command
`AgentInstallerJob`	`createAgentInstallerJobWithOperationTypeAndTargetServer` `createAgentInstallerJobWithOperationTypeAndTargetGroup` `setAgentInstallerJobAclPushEnabledForUpgrade` `setAgentInstallerJobIgnoreRunningJobs` `setAgentInstallerJobSkipUpgrade`
`BlAclPolicy`	`listObjectsDependentUponAclPolicy`
`DepotFile`	`moveByGroupAndName` `copyFileContentsToPath` `replaceFileContents`
`Job`	`moveByJobKeyAndGroup` `showPermissions`
`JobRun`	`findLastRunKeyByJobKeyIgnoreVersion` `getExecutingUserAndRoleByRunKey`
`RBACUser`	`clearDefaultNSHRole`
`Schedule`	`findJobScheduleDetailsByExecutingRole` `findJobScheduleDetailsByExecutingUser` `findJobScheduleDetailsForDeletedOrDisabledUsers` `findJobScheduleDetailsForDeletedRole`s
`Server`	`bulkSetServerPropertyValuesAndLogResults` `getBulkServerPropertyValuesAndLogResults` `findAllServerObjectsByGroupInCustomServerObject`

In addition, the PatchingJob - createAixPatchingJobWithTargetServer command was updated to include an additional input parameter that enables you to set the Analysis Mode to one of the following values:

1 - Install mode, which reports all missing filesets, the ones that are not installed on the target.
2 - Update mode, which reports only updates for the installed filesets on the target. This is the default value.

BLCLI commands added in version 8.3.02

The following BLCLI commands have been introduced in BMC Server Automation version 8.3 SP2:

Namespace	Command
`BlPackage`	`applyAclPolicy`
`DBManager`	`blGatherSchemaStats`
`DepotObject`	`copyDepotObject`
`ImportExport`	`importObjectUseDestinationProperty` `importObjectMergeEnumProperties`
`Job`	`getTargets`
`NSHScript`	`addNSHScriptToDepotByGroupName`
`PropertyInstance`	`applyAclPolicy`
`ProxyServer`	`listAllProxyServers`
`RBACRole`	`syncUsersWithNameSuffix`
`Virtualization`	`abortVirtualGuestJob` `cancelVirtualGuestJob`

BLCLI commands added in version 8.3.01

The following BLCLI command has been updated in BMC Server Automation 8.3 SP1:

Namespace Command

Delete

cleanupDatabase $logLevel$ $continueOnError$

$durationInMin$ $classType$

Example: blcli Delete cleanupDatabase 2 true 240 SDepotObject

This comand deletes database rows for the input object that were previously marked for deletion.

logLevel - Log level (valid values are 1 (ERROR), 2 (WARNING), 3 (INFO), 4 (DETAILED), 5 (VERY DETAILED), 6 (DEBUG))
continueOnError - Continue execution on error (true/false)
durationInMin - Maximum duration for the operation in minutes
classType - Name of the composite class

BLCLI commands added in version 8.3.00

The following BLCLI commands have been updated in BMC Server Automation version 8.3.00:

Namespace

Command

Virtualization

The listVirtualEntityTypes command now lists an additional entity type called SCVMMVMNetwork.

The new SCVMMVMNetwork type can be used as input for the following commands:

Utility The format of the CSV file generated by the simpleExportPatchAnalysisRunLatest command has been enhanced and now displays all patches, both missing patches and installed patches. A new Status column in the CSV file displays the status of the patch — Missing, Installed, or EffectivelyInstalled.

BLCLI commands added in version 8.2.02

Service Pack 2 for BMC Server Automation 8.2 (product version 8.2.02) includes the following updates to BLCLI commands:

Namespace

Command

Server

printPropertyValueAsString

This new command returns the value of the specified property, exactly like the existing command Server printPropertyValue, except when the property's type is a custom property class. In that situation, the property's value is a custom property instance, and this command returns the full path of the custom property instance. The path is in this format:

Class://SystemObject/<property_class_path>/<property_instance_name>

If the property's type is a custom property class, the command Server:printPropertyValue returns the DBKey of the property instance.

This command has the following inputs:

Property	Type	Description
`serverName`	String	Name of the server to which the property belongs.
`propertyName`	String	Name of the property.

Example

This example prints the value of the server property “NAME” of host server1.

blcli Server printPropertyValueAsString server1 NAME

DeployJob

setOverriddenParameterValueFromString

This new command specifies values for the unresolved local parameters of the BLPackage used by a Deploy Job. The command returns the DBKey of the altered Deploy Job.

When setting the value of encrypted parameters, the value provided to this command should be a clear text string. This command will encrypt the value and set it to the parameter. When setting the value of enumerated parameters, the value provided must be the display name of the value.

This command has the following inputs:

Property	Type	Description
`groupName`	String	Name of the job folder containing the job.
`jobName`	String	Name of the Deploy Job.
`parameterName`	String	Name of the BLPackage property.
`valueAsString`	String	The clear text value you want to set for the parameter.

Example

This example assumes that the Deploy Job referenced uses a BLPackage that has an unresolved parameter called encrypted_passwd.

blcli DeployJob setOverriddenParameterValueFromString /Jobs/DeployTest Deploy1 encrypted_passwd "myPassword"

BLCLI commands updated in version 8.2.01 and its patches

Service Pack 1 for BMC Server Automation 8.2 (product version 8.2.01) includes the following updates to BLCLI commands:

Namespace

Command

Server

addServer

This new command lets you add a server, even if the server is not up, or does not have an agent yet. This commmand returns the ID of the newly added server. You can later obtain this server's intrinsic properties by running an Update Server Properties job.

This command has the following inputs:

Property	Type	Description
`serverName`	String	Name of the server.
`shouldUpdate IntrinsicProperties`	Boolean	Whether the add process should contact the agent on each server and try to retrieve the server's intrinsic properties (true/false).

Example

The following example shows you how to add a server without attempting to retrieve that server's intrinsic properties.

blcli Server addServer myServer false

Job

getTargetServers

This new command returns a comma-separated list of servers that:

Are targets of a specified job
Are in a specified state

This command has the following inputs:

Property	Type	Description
`jobKey`	DBKey	DBKey of the job.
`serverState`	String	A comma separated list of strings that represent server states. Acceptable strings are: DECOMMISSIONED ENROLLED NOT-ENROLLED

Example
The following command returns a list of server names for servers that are decommissioned or not enrolled, and that are targets of the specified job:

JOB_KEY=`blcli AuditJob getDBKeyByGroupAndName /group1 auditJob1`

blcli Job getTargetServers $JOB_KEY DECOMMISSIONED,NOT-ENROLLED

AgentBundle

The following commands require an agentPlatform input argument:

The strings for specifying Solaris 10 platforms through this argument have changed.

New string	Old string
`SOLARIS 10/11 SPARC`	`SOLARIS 10 SPARC`
`SOLARIS 10/11 x86`	`SOLARIS 10 x86`

Virtualization

createVirtualGuestPackage

The Virtual Guest Package (VGP) schema has been updated to support RunOnce commands for VMware Windows-based virtual machines created using a template or from existing virtual machines.

The RunOnce commands you specify run after the guest operating system starts. The operating system starts in 'logged on' mode with Administrator credentials. If you do not want the virtual machine logged on automatically, then add a reboot command to the end of the RunOnce command list (for example, shutdown /r).

Example. Here is an example from a sample VGP XML file. The following example adds a specified route in the local IP routing table:

<RunOnceCommands>
   <Command> route -p add  192.168.1.13 mask 255.255.255.0 192.168.1.1</Command>
</RunOnceCommands>

Note

You can specify only OS commands in the RunOnceCommands list; there is no support for executing multi-line scripts.

Virtualization

changeVirtualGuestPowerStatus

This command changes the power status of a virtual guest. For version 8.2 SP1, two additional options have been added to the powerStatus variable for the IBM platform: GuestShutdown and GuestReboot.

ProvisionJob

createProvisionJob

There have been changes to the way you provision an AIX system.

New system package field

Version 8.2 SP1 adds the following new field to the system package you use to provision an AIX system: IP_ADDRESS.

Overriding system package values in target.csv file

Version 8.2 SP1 also adds support for overriding AIX system package values, using the target.csv file. The possible entries in the target.csv file remain the same as in previous releases:

MAC_ADDRESS,COMPUTER_NAME,OM_SERVER_NAME,IP_ADDRESS, SUBNET_MASK,DEFAULT_GATEWAY,OS_LICENSE,NIM_CLIENT_NAME

You can populate the target.csv file with the following values, and the target.csv values will override corresponding values in the AIX system package:

IP_ADDRESS - This is the target client LPAR IP address (new field in the AIX system package).

SUBNET_MASK - This is the client LPAR subnet mask. In previous releases, you could not use the target.csv file to override this value.

DEFAULT_GATEWAY - This is the client LPAR default gateway. In previous releases, you could not use the target.csv file to override this value.

Utility

The following commands now produce reports in XML format, rather than CSV format:

The following BLCLI commands were updated in 8.2.01 patches:

Namespace	Command	Patch
`DeployJob`		Patch 1 (version 8.2.01.001)
`Server`		Patch 2 (version 8.2.01.002)

BLCLI commands updated in version 8.2.00

The following BLCLI commands were added in BMC Server Automation 8.2.00:

Namespace	Command
`AgentBundle`	`addAgentPackageToBundle` `agentBundleExists` `agentPackageExists` `createAgentBundleByGroupAndName` `deleteAgentBundle` `findByGroupAndName` `getDBKeyByGroupAndName` `listAgentPlatforms` `listConfigurationFileTypes` `removeAgentPackageFromBundle` `setDefaultConfigFileContent` `setOverriddenConfigFileContent` `updateAgentPackageOfBundle`
`AgentInstallerJob`	`createAgentInstallerJobWithTargetGroup` `createAgentInstallerJobWithTargetServer` `deleteJobByGroupAndName` `executeJobAndWait` `executeJobAndWaitWithApproval` `executeJobGetJobResultKey` `getDBKeyByGroupAndName` `setAgentInstallerJobAclPushEnabled` `setAgentInstallerJobBundle` `setAgentInstallerJobConfigObjectsRegistrationEnabled` `setAgentInstallerJobPreserveStagingAreaOnFailure` `setAgentInstallerJobUpdateServerPropertiesEnabled`
`ApplicationMiddleware`	`addWeblogic81ApplicationServer` `addWeblogicApplicationServer` `addWebsphereApplicationServer` `performAction`
`BlPackage`	`addLocalEnumProperty` `addNewValuesToEnumProperty` `clearEnumPropertyNameValues` `listEnumPropertyValues` `undeprecateEnumPropertyValue`
`CustomCmd`	`createLocalGuiCustomCmd` `createLocalTabularCustomCmd` `createRemoteGuiCustomCmd` `createRemoteIntCustomCmd` `createRemoteTabularCustomCmd`
`Delete`	`hardDeleteAllSharedObjects` `hardDeleteSharedObjectsByClass`
`DeployJob`	`listLocalPropertyNamesByGroupAndName` `setAdvanceDeployJobPhaseScheduleWithEMailNotificationByDBKey` `setAdvanceDeployJobPhaseScheduleWithSNMPNotificationByDBKey` `setDefaultEMailNotifier` `setDefaultSNMPNotifier` `setDeployJobOverwriteReadOnlyFiles` `setDeployJobRegComComponents` (2 signatures) `undoDeployByDBKeyAndRunId`
`FileDeployJob`	`addJobSourceFilePath` `createJobByServerGroups` `createJobByServers` `removeJobDestinationBackupOptions` `removeJobPostCommand` `removeJobPreCommand` `removeJobRepeaterUsage` `removeJobSyncPushOptions` `setJobBlockLevelUpdateOptions` `setJobDestinationBackupOptions` `setJobMinimumDiskFreeSize` `setJobPostCommand` `setJobPreCommand` `setJobRepeaterUsage` `setJobSourceFilePathList` `setJobSyncPushOptions` `setJobTargetDestinationPath`
`Group`	`listAllJobGroupMembers` `listAllJobGroupMembersTabSeparated`
`Job`	`setMaxParallelism`
`JobRun`	`getLogItemsByJobRunId`
`NSHScript`	`listParameterNamesByGroupAndName`
`ProvisionDevice`	`addPermission` `applyAclPolicy` `applyAclTemplate` `is64bit` `removeAclPolicy` `removePermission` `reprovisionDeviceLater`
`ProvisionJob`	`addPMDevices` `clearAllPMDevices` `clearPMDevice` `createProvisionJob`
`PublishProductCatalogJob`	`createPublishProductCatalogJob` `deleteJobByGroupAndName`
`RemoteHostAuthentication`	`createPsExecRemoteHostAuthentication` `createSshRemoteHostAuthentication` `deleteRemoteHostAuthentication` `findRemoteHostAuthenticationByName` `getRemoteHostAuthenticationStatus` `listAllRemoteHostAuthentications` `listExecutionProtocols` `renameRemoteHostAuthentication` `setRemoteHostAuthenticationAutomationPrincipalName` `setRemoteHostAuthenticationDescription` `setRemoteHostAuthenticationMaximumExecutionParallelism` `setRemoteHostAuthenticationPsExecServerName` `setRemoteHostAuthenticationSuperUserAutomationPrincipalName`
`RemoteHostAuthenticationRule`	`addRemoteHostAuthenticationToRule` `addRoutingRule` (2 signatures) `addToRoutingRuleConditions` `clearRemoteHostAuthenticationsFromRule` `deleteRoutingRule` `findRoutingRuleByName` `listAllRoutingRules` `listRemoteHostAuthenticationsByRule` `listRoutingRuleConditions` `listRuleOperators` `removeRemoteHostAuthenticationFromRule` `renameRoutingRule` `resetRoutingRuleConditions` `setRoutingRuleDescription`
`SCAP`	`cleanupContentFiles` `exportOvalLog` `getDBKeyByGroupAndName`
`SystemPackage`	`deleteAllHiddenSysPacks` `deleteSysPack` `isRscdAgentSelected` `isRscdAgentSupported` `listAllHiddenSysPacks`
`Template`	`addLocalEnumProperty` `addNewValuesToEnumProperty` `clearEnumPropertyNameValues` `listEnumPropertyValues` `undeprecateEnumPropertyValue`
`UCSProvisioning`	`createUCSProvisionJob` `getDBKeyByGroupAndName` `provisionProfile`
`Utility`	`exportDeployRunStatusByGroup`
`Virtualization`	`createVGTemplateEnrollmentJobForServer` `createVGTemplateEnrollmentJobForServerGroup` `setGuestCustomizationConfiguration`
`VMCaptureJob`	`captureAndStageVM` `importVM`

The following BLCLI commands or arguments were removed in BMC Server Automation 8.2.00:

Namespace	Command
`ImportExport`	The following commands are deprecated. The `PropertySync` feature is no longer supported: `exportPropertyDictionary` (2 signatures) `importPropertyDictionary`
`Provision`	The following command is deprecated: `provisionDevice` Use the new `ProvisionJob:createProvisionJob` command instead. If you continue to use the deprecated `provisionDevice` command, it will generate hidden system packages. BMC recommends that you manage these hidden system packages by using the following new `SystemPackage` commands: `deleteAllHiddenSysPacks` `deleteSysPack` `listAllHiddenSysPacks`
`Server`	The `autoLicense` argument was removed from the following commands: `addServer` `bulkAddServers` `addServerIfIPUnique` `bulkAddServersWithUniqueIP` The `deregisterLicense` argument was removed from the following command: `decommissionServer` The following command is now unreleased: `licenseServer`
`SubscriptionManagement`	This namespace has been removed.

BLCLI commands removed in recent versions

The following command was removed in version 8.5.01:

Namespace	Command
`RBACUser`	`getAllUserNames` was deprecated; use `listAllUserNames` instead

The following BLCLI commands or arguments were removed in BMC Server Automation 8.2.00:

Namespace	Command
`ImportExport`	The following commands are deprecated. The `PropertySync` feature is no longer supported: `exportPropertyDictionary` (2 signatures) `importPropertyDictionary`
`Provision`	The following command is deprecated: `provisionDevice` Use the new `ProvisionJob:createProvisionJob` command instead. If you continue to use the deprecated `provisionDevice` command, it will generate hidden system packages. BMC recommends that you manage these hidden system packages by using the following new `SystemPackage` commands: `deleteAllHiddenSysPacks` `deleteSysPack` `listAllHiddenSysPacks`
`Server`	The `autoLicense` argument was removed from the following commands: `addServer` `bulkAddServers` `addServerIfIPUnique` `bulkAddServersWithUniqueIP` The `deregisterLicense` argument was removed from the following command: `decommissionServer` The following command is now unreleased: `licenseServer`
`SubscriptionManagement`	This namespace has been removed.

BLCLI commands added, updated, or removed in recent versions

BLCLI commands added or updated in recent versions

BLCLI commands added in version 8.6.00

BLCLI commands added in version 8.5.01

BLCLI commands added in version 8.5.00

BLCLI commands added in version 8.3.03

BLCLI commands added in version 8.3.02

BLCLI commands added in version 8.3.01

BLCLI commands added in version 8.3.00

BLCLI commands added in version 8.2.02

BLCLI commands updated in version 8.2.01 and its patches

BLCLI commands updated in version 8.2.00

BLCLI commands removed in recent versions

Comments