Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
5498f20
(#1028) Update save and actions icon with accessibility in mind inclu…
LeaDevelop Oct 6, 2024
a9f5abf
(#1028) Fix emoticons in groups.mdx - Font Awesome accessibility
LeaDevelop Oct 6, 2024
3ed690e
(#1028) Fix emoticons in roles.mdx - Font Awesome accessibility
LeaDevelop Oct 6, 2024
21aa787
(#1028) Fix emoticons in groups.mdx - Font Awesome accessibility, dis…
LeaDevelop Oct 6, 2024
72d30d5
(#1028) Fix emoticons in deployments.mdx - Font Awesome accessibility
LeaDevelop Oct 6, 2024
30d68ef
(#1028) Fix emoticons in sensitive-variables.mdx - Font Awesome acces…
LeaDevelop Oct 6, 2024
c34a02c
(#1028) Fix emoticons in software.mdx - Font Awesome accessibility
LeaDevelop Oct 6, 2024
0bc44a5
(#1028) Fix emoticons in computers.mdx - Font Awesome accessibility
LeaDevelop Oct 6, 2024
5d5d535
(#1028) Fix emoticons in api\index.mdx - Font Awesome accessibility
LeaDevelop Oct 6, 2024
c5c04ef
(#1028) Fix emoticons in reports.mdx - Font Awesome accessibility
LeaDevelop Oct 6, 2024
cdcb2f7
(#1028) Fix emoticons in audit-logs.mdx - Font Awesome accessibility
LeaDevelop Oct 6, 2024
269b631
(#1028) Added export icon
LeaDevelop Oct 6, 2024
b150bee
(#1028) Add export icon
LeaDevelop Oct 6, 2024
b415452
(#1028) Add deploy icon
LeaDevelop Oct 6, 2024
1e85e84
Merge remote-tracking branch 'origin/(#1028)-docs-update-fix-emojis' …
LeaDevelop Oct 6, 2024
5dc00b5
Merge branch 'chocolatey:master' into (#1028)-docs-update-fix-emojis
LeaDevelop Dec 14, 2024
1038fb3
Merge branch 'master' into (#1028)-docs-update-fix-emojis
LeaDevelop Sep 21, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/content/docs/en-us/central-management/usage/api/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,10 @@ import Xref from '@components/Xref.astro';

## Description


As of Chocolatey Central Management v0.4.0, the API is exposed via Swagger.
The API documentation and examples can be reached from your Chocolatey Central Management dashboard by selecting the **API** option on the left sidebar.

The information contained there is referenced here, but you can additionally try out the various API endpoints directly from the Swagger API page for your own CCM environment.

<Callout type="warning">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Once the required filters have been set, pressing the **Apply filters** button w

![Operation logs tab within the Audit logs section of the Administration | Settings page](/images/ccm-playwright/administration/audit-logs/left-menu-active.png)

It is possible to see all available information for an operation by clicking the **Details** button in the **Quick Actions** column of the table.
It is possible to see all available information for an operation by clicking the <i class="fa-solid fa-magnifying-glass" aria-hidden="true"></i> magnifying glass button to the left-hand side of the table.

If required, the available results can be exported to an Excel document using the **Actions for Audit Logs** button menu.
This will generate a file named something similar to the following `Chocolatey_AuditLogs_20231122_095144.xlsx`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,18 @@ Next you'll want to click over to Permissions. This tab will allow you to select

![Creating New Role Setting Permissions](/images/ccm-playwright/administration/roles/modal-new-role-tab-permissions.png)

Click **Save** to close the modal and create the new role.
Click <i class="fa-regular fa-floppy-disk" aria-hidden="true"></i> **Save** to close the window and create the new role.

## Editing a Role

<Callout type="info">
If you do not see the **Edit** menu entry or the **Actions** buttons, please see your Administrator to determine if your account has the _Edit Roles_ permission.
If you do not see the **Edit** menu entry or the <i class="fa-solid fa-gear" aria-hidden="true"></i> **Actions** buttons, please see your Administrator to determine if your account has the _Edit Roles_ permission.
</Callout>

On the main Roles page, find the role you want to edit.
You can also use **Select permissions (0)** to filter the Roles listed based on them having the permissions you select.

Select the **Actions** button on the left-hand side of the role, and then select **Edit** to open the **Edit Group** modal.
Select the <i class="fa-solid fa-gear" aria-hidden="true"></i> **Actions** button on the left-hand side of the role, and then select **Edit** to open the _Edit Group_ window.

![Edit menu entry in role actions flyout menu](/images/ccm-playwright/administration/roles/table-row-button-action-dropdown-menu-edit.png)

Expand All @@ -48,14 +48,14 @@ From the **Edit Role** modal, you can modify the name, set it to be the Default
## Deleting a Role

<Callout type="info">
If you do not see the **Delete** menu entry or the **Actions** buttons, please see your Administrator to determine if your account has the _Edit Roles_ permissions.
If you do not see the **Delete** menu entry or the <i class="fa-solid fa-gear" aria-hidden="true"></i> **Actions** buttons, please see your Administrator to determine if your account has the _Edit Roles_ permissions.

Roles labelled **Built-in role** cannot be deleted.

You cannot delete a Role if the account you are using also has the Role assigned to it.
</Callout>

On the main Roles page, find the role you want to delete. You can also use **Select permissions (0)** to filter the roles listed based on permission. Similar to the [Edit Role](#editing-a-role) action, select the **Actions** button on the left-hand side of the role, and select **Delete**. You will be prompted to confirm the deletion.
On the main Roles page, find the role you want to delete. You can also use _Select Permissions (0)_ to filter the roles listed based on permission. Similar to the [Edit Role](#editing-a-role) action, select the <i class="fa-solid fa-gear" aria-hidden="true"></i> **Actions** button on the left-hand side of the role, and select **Delete**. You will be prompted to confirm the deletion.

## Pre-Configured Roles

Expand Down
Original file line number Diff line number Diff line change
@@ -1,50 +1,53 @@
---
order: 30
xref: ccm-administration-sensitive-variables
title: Sensitive Variables
description: Information on sensitive variables within Chocolatey Central Management
---
import Callout from '@choco-astro/components/Callout.astro';
import Iframe from '@choco-astro/components/Iframe.astro';
import Xref from '@components/Xref.astro';
import SensitiveVariablesNote from '@components/docs/SensitiveVariablesNote.mdx';

Chocolatey Central Management gives you the ability to create sensitive variables for use in Deployment Steps.

The **Sensitive Variables** page can be accessed from the Administration section of Chocolatey Central Management. The page is only visible to users who have permissions to create or delete sensitive variables.

![Chocolatey Central Management dashboard, arrow pointing to Sensitive Variables menu in the left sidebar entry.](/images/ccm-playwright/dashboard/left-menu-sensitive-variables.png)

## Creating a new Sensitive Variable

1. From the Chocolatey Central Management dashboard, select **Administration** then **Sensitive Variables** from the left sidebar and select the **Create Sensitive** option.

![Chocolatey Central Management dashboard, arrow pointing to the Create Sensitive Variable menu option in the left sidebar](/images/ccm-playwright/dashboard/left-menu-create-sensitive-variable.png)
1. Fill in the details and click **Save**.

![Fill in Sensitive Variables information](/images/ccm-playwright/administration/sensitive-variables/modal-new-sensitive-variable.png)

Alternatively, variables can also be added from an Deployment Step Advanced script by clicking the **Plus sign** button in the upper right corner.

![Sensitive Variables Added from the Advanced script of a Deployment Step](/images/ccm-playwright/deployment-plans/edit/modal-step-button-create-sensitive-variable.png)

## Adding Sensitive Variables to scripts

<SensitiveVariablesNote />

1. In an Advanced script of a Deployment Step, select the variable to insert from the Sensitive Variables drop down.

![Deployment Step Advanced script, with an arrow pointing to the Sensitive Variables selection dropdown.](/images/ccm-playwright/deployment-plans/edit/modal-step-advanced-command-select-sensitive-variable.png)

## Deleting Sensitive Variables

1. From the Chocolatey Central Management dashboard, select **Administration** then **Sensitive Variables** from the left sidebar and select the **View Sensitive** option.

![Central Management dashboard, arrow pointing to View Sensitive Variables menu option in the left sidebar entry.](/images/ccm-playwright/dashboard/left-menu-view-sensitive-variables.png)
1. Select **Delete** button beside the Sensitive Variable you wish to delete.

![Sensitive Variables page with arrow to a delete button](/images/ccm-playwright/administration/sensitive-variables/button-quick-action-delete.png)

## Editing / Changing Sensitive Variables

You cannot change or edit a Sensitive Variable directly. If you need to change the value a Sensitive Variable has, please [delete it](#deleting-sensitive-variables) and [create it](#creating-a-new-sensitive-variable) again.
---
order: 30
xref: ccm-administration-sensitive-variables
title: Sensitive Variables
description: Information on sensitive variables within Chocolatey Central Management
---
import Callout from '@choco/components/Callout.astro';
import Iframe from '@choco/components/Iframe.astro';
import Xref from '@components/Xref.astro';
import SensitiveVariablesNote from '@components/docs/SensitiveVariablesNote.mdx';

Chocolatey Central Management gives you the ability to create sensitive variables for use in Deployment Steps.

The **Sensitive Variables** page can be accessed from the Administration section of Chocolatey Central Management. The page is only visible to users who have permissions to create or delete sensitive variables.

![Chocolatey Central Management dashboard, arrow pointing to Sensitive Variables menu in the left sidebar entry.](/images/ccm-playwright/dashboard/left-menu-nested-sensitive-variables.png)

## Creating a new Sensitive Variable

1. From the Chocolatey Central Management Dashboard, select `Administration` > `Sensitive Variables` from the left sidebar.

![Chocolatey Central Management dashboard, arrow pointing to Sensitive Variables menu in the left sidebar entry.](/images/ccm-playwright/dashboard/left-menu-nested-sensitive-variables.png)
1. Select the <i class="fa-solid fa-plus" aria-hidden="true"></i> **Create new sensitive variable** button at the top of the page.

![CCM Sensitive Variables page, arrow pointing to Create new sensitive variable button](/images/ccm-playwright/administration/sensitive-variables/button-create-new-sensitive-variable.png)
1. Fill in the details and click Save.

![Fill in Sensitive Variables information](/images/ccm-playwright/administration/sensitive-variables/modal-new-sensitive-variable.png)

Alternatively, variables can also be added from an Deployment Step Advanced script by clicking the <i class="fa-solid fa-plus" aria-hidden="true"></i> plus in the upper right corner.

![Sensitive Variables Added from the Advanced script of a Deployment Step](/images/ccm-playwright/deployment-plans/edit/modal-step-button-create-sensitive-variable.png)

## Adding Sensitive Variables to scripts

<SensitiveVariablesNote />

1. In an Advanced script of a Deployment Step, select the variable to insert from the Sensitive Variables drop down.

![Deployment Step Advanced script, with an arrow pointing to the Sensitive Variables selection dropdown.](/images/ccm-playwright/deployment-plans/edit/modal-step-advanced-command-select-sensitive-variable.png)

## Deleting Sensitive Variables

1. From the Chocolatey Central Management Dashboard, select `Administration` > `Sensitive Variables` from the left sidebar.

![Central Management dashboard, arrow pointing to Sensitive Variables menu in the left sidebar entry on the CCM Dashboard](/images/ccm-playwright/dashboard/left-menu-nested-sensitive-variables.png)
1. Select <i class="fa-solid fa-trash-can" aria-hidden="true"></i> **Delete** beside the Sensitive Variable you wish to delete.

![Sensitive Variables page with arrow to a delete button](/images/ccm-playwright/administration/sensitive-variables/button-quick-action-delete.png)

## Editing / Changing Sensitive Variables

You cannot change or edit a Sensitive Variable directly. If you need to change the value a Sensitive Variable has, please [delete it](#deleting-sensitive-variables) and [create it](#creating-a-new-sensitive-variable) again.
Original file line number Diff line number Diff line change
Expand Up @@ -32,47 +32,53 @@ Next you'll want to click over to **Roles** tab. This will allow you to select w

![Creating New User Setting Roles](/images/ccm-playwright/administration/users/modal-new-user-tab-roles.png)

Click **Save** to close the modal and create the new User.
Click <i class="fa-regular fa-floppy-disk" aria-hidden="true"></i> **Save** to close the window and create the new User.

A green toast notification will be shown once the operation completes successfully.

## Editing a User

<Callout type="info">
If you do not see the **Edit** menu entry or the **Actions** buttons, please see your Administrator to determine if your account has the _Editing user_ permission.
If you do not see the **Edit** menu entry or the <i class="fa-solid fa-gear" aria-hidden="true"></i> **Actions** buttons, please see your Administrator to determine if your account has the _Editing user_ permission.
</Callout>

On the main Users page, [find](#searching-for-a-user) the User you want to edit.
Select the **Actions** button on the left-hand side of the User, and then select **Edit** to open the **Edit User** modal.
Select the <i class="fa-solid fa-gear" aria-hidden="true"></i> **Actions** button on the left-hand side of the User, and then select **Edit** to open the _Edit User_ window.


![Edit menu entry in User actions flyout menu](/images/ccm-playwright/administration/users/table-row-button-action-dropdown-menu-edit.png)

From the **Edit Role** modal, you can modify all the properties for a User, for example, `First Name`, `Phone number`, etc. In addition, you can alter the <Xref title="Roles" value="ccm-administration-roles" /> associated with the User.

Once modifications are complete, click the **Save** button.
Once modifications are complete, click the <i class="fa-regular fa-floppy-disk" aria-hidden="true"></i> **Save** button.

A green toast notification will be shown once the operation completes successfully.

## Fine grained permissions

In addition to configuring a set of Roles for an individual User, so can set special permissions for an individual User.

On the main Users page, [find](#searching-for-a-user) the User you want to edit.
Select the **Actions** button on the left-hand side of the User, and then select **Permission** to open the **Permissions** modal.
Select the <i class="fa-solid fa-gear" aria-hidden="true"></i> **Actions** button on the left-hand side of the User, and then select **Permission** to open the _Permissions_ window.


![Permissions menu entry in User actions flyout menu](/images/ccm-playwright/administration/users/modal-permissions.png)

From the tree of permissions, check/uncheck the permissions that are needed.

Once modifications are complete, click the **Save** button.
Once modifications are complete, click the <i class="fa-regular fa-floppy-disk" aria-hidden="true"></i> **Save** button.

A green toast notification will be shown once the operation completes successfully.

## Deleting a User

<Callout type="info">
If you do not see the **Delete** menu entry or the **Actions** buttons, please see your Administrator to determine if your account has the _Deleting user_ permission.
If you do not see the **Delete** menu entry or the <i class="fa-solid fa-gear" aria-hidden="true"></i> **Actions** buttons, please see your Administrator to determine if your account has the _Deleting user_ permission.
</Callout>

On the main Users page, [find](#searching-for-a-user) the User that needs to be deleted.
Select the **Actions** button on the left-hand side of the User, and then select **Delete**.
Select the <i class="fa-solid fa-gear" aria-hidden="true"></i> **Actions** button on the left-hand side of the User, and then select **Delete**.

A prompt will be shown asking `Are you sure?`.
Click **Cancel** to not continue with the operation.
Click **Yes** to proceed with the operation.
Expand All @@ -81,13 +87,14 @@ A green toast notification will be shown once the operation completes successful
## Unlocking a User

<Callout type="info">
If you do not see the **Unlock** menu entry or the **Actions** buttons, please see your Administrator to determine if your account has the _Editing user_ permission.
If you do not see the **Unlock** menu entry or the <i class="fa-solid fa-gear" aria-hidden="true"></i> **Actions** buttons, please see your Administrator to determine if your account has the _Editing user_ permission.
</Callout>

If a User enters the wrong login information 5 times, their account will become locked.
To allow them to attempt to login again, the account will need to be unlocked.
On the main Users page, [find](#searching-for-a-user) the User that is locked out.
Select the **Actions** button on the left-hand side of the User, and then select **Unlock**.
Select the <i class="fa-solid fa-gear" aria-hidden="true"></i> **Actions** button on the left-hand side of the User, and then select **Unlock**.

A green toast notification will be shown once the operation completes successfully.

## Searching for a User
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ Please see <Xref title="Central Management Client Setup" value="ccm-client" /> f
</Callout>

From the main Computers page in Central Management, locate the computer of interest in the list or by providing a search term in the table filter.
Select the **Actions** button in the corresponding left-hand column, and click **Details**.
Select the <i class="fa-solid fa-gear" aria-hidden="true"></i> **Actions** menu in the corresponding left-hand column, and click **Details**.


![Finding a computer's details menu option](/images/ccm-playwright/computers/table-row-button-action-dropdown-menu-details.png)

Expand All @@ -47,11 +48,13 @@ You will be presented with a list of the installed software packages for the mac

Creating a Draft Deployment Plan for a Computer can be done from two pages:

1. In the leftmost column of the Computer table you will find an **Actions** button which will display a **Create Deployment Plan** option.
1. In the leftmost column of the Computer table you will find an <i class="fa-solid fa-gear" aria-hidden="true"></i> **Actions** menu which will display a **Create New Deployment Plan** option.


![Finding the Create Deployment Plan menu entry for a specific Computer on the Computers page](/images/ccm-playwright/computers/table-row-button-action-dropdown-menu-create-deployment-plan.png)

1. From the Computer Details page, click the **Actions for Computer** button and select the **Create Deployment Plan** option.
1. From the Computer Details page, click the <i class="fa-solid fa-gear" aria-hidden="true"></i> **Actions** button and select the **Create New Deployment Plan** option.


![Button to create a new draft Deployment Plan from the Computer Details page](/images/ccm-playwright/computers/details/button-action-dropdown-menu-create-deployment-plan.png)

Expand All @@ -71,11 +74,12 @@ From here, the Deployment Plan can be edited and deployed as outlined in the <Xr

Upgrading all outdated Software installed on a Computer can be done from two pages:

1. In the leftmost column of the Computer table you will find an **Actions** button which will display a **Upgrade Outdated Software** option.
1. In the leftmost column of the Computer table you will find an <i class="fa-solid fa-gear" aria-hidden="true"></i> **Actions** menu which will display a **Upgrade Outdated Software** option.

![Finding the Upgrade Outdated Software menu entry for a specific Computer on the Computers page](/images/ccm-playwright/computers/table-row-button-action-dropdown-menu-upgrade-outdated-software.png)

1. From the Computer Details page, click the **Actions for Computer** button and select the **Upgrade Outdated Software** option.
1. From the Computer Details page, click the <i class="fa-solid fa-gear" aria-hidden="true"></i> **Actions** button and select the **Upgrade Outdated Software** option.


![Button to create a new Deployment Plan to upgrade all outdated Software on a Computer from the Computer Details page](/images/ccm-playwright/computers/details/button-action-dropdown-menu-upgrade-outdated-software.png)

Expand Down Expand Up @@ -104,7 +108,8 @@ From the Computer details page, click the **Actions for Computer** button and se
</Callout>

From the main Computers page in Central Management, locate the computer of interest in the list or by providing a search term in the table filter.
Select the **Actions** button in the corresponding left-hand column, and click **Delete**. You will be prompted to confirm the deletion.
Select the <i class="fa-solid fa-gear" aria-hidden="true"></i> **Actions** menu in the corresponding left-hand column, and click **Delete**. You will be prompted to confirm the deletion.


![Deleting a computer in Central Management](/images/ccm-playwright/computers/table-row-button-action-dropdown-menu-delete.png)

Expand Down
Loading
Loading