< Back
Remove-ChefAutomateComplianceProfile
Post
NAME Remove-ChefAutomateComplianceProfile
SYNOPSIS
Deletes the nominated compliance profile.
SYNTAX
Remove-ChefAutomateComplianceProfile [-automateServer] <Object> [-automateOrgName] <Object> [-automateUser]
<Object> [-automateUserToken] <Object> [-complianceName] <Object> [<CommonParameters>]
DESCRIPTION
Deletes the nominated compliance profile from the Chef Automate compliance store.
PARAMETERS
-automateServer <Object>
Chef Automate Server (e.g. chef-automate.company.com)
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-automateOrgName <Object>
Chef Automate Enterprise Name (e.g. MyOrg)
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-automateUser <Object>
Chef Automate User (e.g. 'john')
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-automateUserToken <Object>
Chef Automate USer Token (https://YOUR_AUTOMATE_HOST/e/YOUR_AUTOMATE_ENTERPRISE/#/dashboard?token)
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-complianceName <Object>
Compliance Profile Name e.g. 'ssh')
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Takes the DNS-resolvable name of the Chef Automate server (e.g. 'chef-automate' or 'chef-automate.company.com'),
the Chef Automate Enterprise name (e.g. OrgName), the Chef Automate user who 'owns' the compliance profiles, the
user token for authentication (https://YOUR_AUTOMATE_HOST/e/YOUR_AUTOMATE_ENTERPRISE/#/dashboard?token) and the
Compliance profile name (e.g. 'ssh')
OUTPUTS
Verification that the profile has been deleted.
-------------------------- EXAMPLE 1 --------------------------
C:\\PS>Remove-ChefAutomateComplianceProfile -automateServer 'chef-automate.company.com' -automateOrgName OrgName
-automateUser admin -automateUserToken <USER-TOKEN> -complianceName 'ssh'
RELATED LINKS
SYNOPSIS
Deletes the nominated compliance profile.
SYNTAX
Remove-ChefAutomateComplianceProfile [-automateServer] <Object> [-automateOrgName] <Object> [-automateUser]
<Object> [-automateUserToken] <Object> [-complianceName] <Object> [<CommonParameters>]
DESCRIPTION
Deletes the nominated compliance profile from the Chef Automate compliance store.
PARAMETERS
-automateServer <Object>
Chef Automate Server (e.g. chef-automate.company.com)
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-automateOrgName <Object>
Chef Automate Enterprise Name (e.g. MyOrg)
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-automateUser <Object>
Chef Automate User (e.g. 'john')
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-automateUserToken <Object>
Chef Automate USer Token (https://YOUR_AUTOMATE_HOST/e/YOUR_AUTOMATE_ENTERPRISE/#/dashboard?token)
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-complianceName <Object>
Compliance Profile Name e.g. 'ssh')
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
Takes the DNS-resolvable name of the Chef Automate server (e.g. 'chef-automate' or 'chef-automate.company.com'),
the Chef Automate Enterprise name (e.g. OrgName), the Chef Automate user who 'owns' the compliance profiles, the
user token for authentication (https://YOUR_AUTOMATE_HOST/e/YOUR_AUTOMATE_ENTERPRISE/#/dashboard?token) and the
Compliance profile name (e.g. 'ssh')
OUTPUTS
Verification that the profile has been deleted.
-------------------------- EXAMPLE 1 --------------------------
C:\\PS>Remove-ChefAutomateComplianceProfile -automateServer 'chef-automate.company.com' -automateOrgName OrgName
-automateUser admin -automateUserToken <USER-TOKEN> -complianceName 'ssh'
RELATED LINKS