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 or updated in version 8.9.02

Namespace	Command	Description
Delete	cleanupHistoricalData OldVersionComponent	(New) Deletes older version of components that have no association in Snapshot, Audit, or Compliance modules.
Delete	cleanupHistoricalData OldVersionJob	(New) Deletes older version of jobs that have no runs associated with that version.
AgentInstallerJob	setAgentInstallerJobInstallVCRuntime	(New) Update the MSVC option (Install Microsoft Visual C++ 2015 Redistributable (Windows Only)) for the new Agent Installer Job.
PatchingJob	createRedhatPatchingJobWithTargetServer_2	(New) Creates a Patching Job that is run against an individual server, using an existing Red Hat catalog.
PatchingJob	createRedhatPatchingJobWithTargetServer	(Updated) Creates a Patching Job that is run against an individual server, using an existing Red hat catalog.
JobRun	getJobRunIdByScheduleId	(New) Returns the Job Run ID for a given Schedule ID.
JobRun	getJobRunKeyByScheduleId	(New) Returns the Job Run Key for a given Schedule ID.
NSHScript	getNSHScriptParamValuesString	(New) Retrieves the parameters for the NSH Script Job as a string where each entry is shown as `name::valuepairs`.
BlPackage	createEmptyPackageReturnDBKey	(New)This command creates an empty BLPackage and returns handle to it.

BLCLI commands added or updated in version 8.9.01

Namespace	Command	Description
BlAclTemplate	listAllAclTemplates	(Updated) Provides a list of ACL templates without further details.
	listAllAclTemplatesWithDetails	(New) Provides a list of ACL templates that includes details of template properties.
ComponentException	createComponentExceptionWithOneRuleWithExpirationDate	(New) Creates a compliance exception with one rule, reference number, and expiration date and sets it on a component.
Delete	cleanupFileServerWithEmptyDirectoryScan	(New) Cleans all the unused files from the file server and runs the empty directory scan.

BLCLI commands added in version 8.9.00

Namespace	Command	Description
DeployJob	setPauseOnWindowTimeout	Sets a pause on the timeout of a Maintenance Window or Exclusion Window for a Deploy Job.
DeployJob	setWindowTimoutTolerance	Sets the amount of time (in minutes) before the timeout of a Maintenance Window or Exclusion Window at which a Deploy Job should pause.
ExclusionWindow	All commands in this new name space: activateWindow addPermission addServerGroups addServers applyAclPolicy clearServers createWindowWithDailySchedule createWindowWithMonthlySchedule createWindowWithOneTimeSchedule createWindowWithWeeklySchedule deactivateWindow delete listAllServers listAllWindows removeAclPolicy removePermission showPermissions updateWindowWithDailySchedule updateWindowWithMonthlySchedule updateWindowWithOneTimeSchedule updateWindowWithWeeklySchedule	Management of exclusion windows.
FileDeployJob	deleteJobByGroupAndName	Deletes a File Deploy Job (specified by job name and path) and all of its dependents.
MaintenanceWindow	All commands in this new name space: activateWindow addPermission addServerGroups addServers applyAclPolicy clearServers createWindowWithDailySchedule createWindowWithMonthlySchedule createWindowWithOneTimeSchedule createWindowWithWeeklySchedule deactivateWindow delete listAllServers listAllWindows removeAclPolicy removePermission showPermissions updateWindowWithDailySchedule updateWindowWithMonthlySchedule updateWindowWithOneTimeSchedule updateWindowWithWeeklySchedule	Management of maintenance windows.
Server	exportExclusionAndMaintenanceWindowsByGroupId	Exports details in CSV format of all maintenance and exclusion windows associated with servers in a specified group (either smart group or static group).
Server	exportExclusionAndMaintenanceWindowsForServers	Exports details in CSV format of maintenance and exclusion windows associated with all enrolled servers.

BLCLI commands added in version 8.7.00

New BLCLI commands in 8.7.00

Namespace	Command	Description
AuthorizationProfile	listAllAuthorizationProfiles	Lists all Authorization Profiles in the system, one profile on each line.
ExecutionTask	deleteExecutionTaskByGroupAndName	Deletes an Execution Task by group and name.
Job	executeJobAndReturnScheduleID	Executes a job and returns the schedule ID.
PropertyInstance	applyAclPolicy	Applies an ACL Policy to a Property Instance and returns the DBKey of the updated instance.
RBACRole	deleteRole	Deletes an existing role.
Template	listPropertyInstanceNamesByGroupAndName	Lists the names of all local property instances for a Component Template.
Utility	exportDeployRunStatusWithUndoByGroup	Exports the server/phase status of the latest run of all Deploy Jobs in a specified group including undo. It places this status information in a CSV file.

Updated BLCLI commands in 8.7.00

Namespace	Command	Description
ComponentException	createComponentExceptionWithOneRule	Updated to include the rule reference number in the input.
Delete	cleanupHistoricalData	Option added for deleting historical data from Deploy Jobs.
Job	showPermissions	Option added to return the permissions contained in the policy along with the policy name.

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

blcliCommands8501

The multiexcerpt named 'blcliCommands8501' was not found. Please check the page name and MultiExcerpt name used in the MultiExcerpt Include macro.

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

blcliCommands8301

The multiexcerpt named 'blcliCommands8301' was not found. Please check the page name and MultiExcerpt name used in the MultiExcerpt Include macro.

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

blcliCommands8202

The multiexcerpt named 'blcliCommands8202' was not found. Please check the page name and MultiExcerpt name used in the MultiExcerpt Include macro.

BLCLI commands updated in version 8.2.01 and its patches

blcliCommands8201

The multiexcerpt named 'blcliCommands8201' was not found. Please check the page name and MultiExcerpt name used in the MultiExcerpt Include macro.

The following BLCLI commands were updated in 8.2.01 patches:

Namespace	Command	Patch
`DeployJob`	MultiExcerpt named '8201001cli' was not found The multiexcerpt named '8201001cli' was not found. Please check the page name and MultiExcerpt name used in the MultiExcerpt Include macro.	Patch 1 (version 8.2.01.001)
`Server`	MultiExcerpt named '8201002cli' was not found The multiexcerpt named '8201002cli' was not found. Please check the page name and MultiExcerpt name used in the MultiExcerpt Include macro.	Patch 2 (version 8.2.01.002)

BLCLI commands updated in version 8.2.00

blcliCommands8200

The multiexcerpt named 'blcliCommands8200' was not found. Please check the page name and MultiExcerpt name used in the MultiExcerpt Include macro.

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