Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(#1028) docs update - fix emojis #1072

Merged
4 changes: 2 additions & 2 deletions src/content/docs/en-us/central-management/usage/api/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import Xref from '@components/Xref.astro';
## Description

As of CCM v0.4.0, the API for Chocolatey Central Management is exposed via Swagger.
The API documentation and examples can be reached from your CCM dashboard by selecting the :gear: **API** option on the left sidebar.
The API documentation and examples can be reached from your CCM 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 Expand Up @@ -52,7 +52,7 @@ Invoke-WebRequest -Uri "https://$CcmServerHostname/$endpointUrl" -Method $Method
## Endpoints

Below is a list of the API endpoints available for CCM as of v0.10.0.
For more detailed information on the API endpoints and their parameters for your version of CCM, select the :gear: **API** option from the sidebar on the Central Management dashboard, or navigate to `https://CCM_SERVER_HOSTNAME/swagger/`.
For more detailed information on the API endpoints and their parameters for your version of CCM, select the **API** option from the sidebar on the Central Management dashboard, or navigate to `https://CCM_SERVER_HOSTNAME/swagger/`.

### AuditLog

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 `Refresh` button will show

![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 :mag: button to the left-hand side of the table.
It is possible to see all available information for an operation by clicking the 🔍 button to the left-hand side of the table.

If required, the available results can be exported to an Excel document using the `Export | Export to Excel` button.
This will generate a file named something similar to the following `Chocolatey_AuditLogs_20231122_095144.xlsx`.
Expand All @@ -40,4 +40,4 @@ The length of time that Operation logs are stored within the Chocolatey Central

<Callout type="warning">
This section of the Chocolatey Central Management Website does not actually provide any functionality, and will be removed in a future version.
</Callout>
</Callout>
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 window will allow you to sel

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

Click :floppy_disk: **Save** to close the window and create the new role.
Click 💾 **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 :gear: **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 **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 :gear: **Actions** button on the left-hand side of the role, and then select **Edit** to open the _Edit Group_ window.
Select the **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** window, 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 :gear: **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 **Actions** buttons, please see your Administrator to determine if your account has the _Edit Roles_ permissions.

Roles labelled **Static** 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 :gear: **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 **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
Expand Up @@ -20,14 +20,14 @@ The **Sensitive Variables** page can be accessed from the Administration section
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 :heavy_plus_sign: **Create new sensitive variable** button at the top of the page.
1. Select the **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 :heavy_plus_sign: in the upper right corner.
Alternatively, variables can also be added from an Deployment Step Advanced script by clicking the 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)

Expand All @@ -44,7 +44,7 @@ Alternatively, variables can also be added from an Deployment Step Advanced scri
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 :wastebasket: **Delete** beside the Sensitive Variable you wish to delete.
1. Select 🗑 **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)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,47 +32,47 @@ Next you'll want to click over to `Roles`. This window will allow you to select

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

Click :floppy_disk: **Save** to close the window and create the new User.
Click 💾 **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 :gear: **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 **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 :gear: **Actions** button on the left-hand side of the User, and then select **Edit** to open the _Edit User_ window.
Select the **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** window, 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 :floppy_disk: **Save** button.
Once modifications are complete, click the 💾 **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 speicial permissions for an individual User.

On the main Users page, [find](#searching-for-a-user) the User you want to edit.
Select the :gear: **Actions** button on the left-hand side of the User, and then select **Permission** to open the _Permissions_ window.
Select the **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 :floppy_disk: **Save** button.
Once modifications are complete, click the 💾 **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 :gear: **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 **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 :gear: **Actions** button on the left-hand side of the User, and then select **Delete**.
Select the **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 +81,13 @@ 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 :gear: **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 **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 :gear: **Actions** button on the left-hand side of the User, and then select **Unlock**.
Select the **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 All @@ -109,4 +109,4 @@ This will generate a file name similar to `Chocolatey_Users_20231122_130612.xlsx

## Pre-Configured Users

In a fresh installation of Chocolatey Central Management, there is a single pre-configured User called `ccmadmin`, which has been allocated the `CCM Admin` Role.
In a fresh installation of Chocolatey Central Management, there is a single pre-configured User called `ccmadmin`, which has been allocated the `CCM Admin` Role.
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ 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 :gear: **Actions** menu in the corresponding left-hand column, and click **Details**.
Select the **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 +47,11 @@ 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 :gear: **Actions** menu which will display a **Create New Deployment Plan** option.
1. In the leftmost column of the Computer table you will find an **Actions** menu which will display a **Create New Deployment Plan** option.

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

1. From the Computer Details page, click the :gear: **Actions** button and select the **Create New Deployment Plan** option.
1. From the Computer Details page, click the **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-new-deployment-plan.png)

Expand All @@ -71,11 +71,11 @@ 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 :gear: **Actions** menu which will display a **Upgrade Outdated Software** option.
1. In the leftmost column of the Computer table you will find an **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 :gear: **Actions** button and select the **Upgrade Outdated Software** option.
1. From the Computer Details page, click the **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 +104,7 @@ From the Computer details page, click the `Export` button and select the `Export
</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 :gear: **Actions** menu in the corresponding left-hand column, and click **Delete**. You will be prompted to confirm the deletion.
Select the **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
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ You will also need to have at least one Group of computers already defined.

![Chocolatey Central Management dashboard, arrow pointing to Deployment Plans menu in the left sidebar](/images/ccm-playwright/dashboard/left-menu-deployment-plans.png)

1. Select the :heavy_plus_sign: **Create New Deployment Plan** button at the top of the page.
1. Select the **Create New Deployment Plan** button at the top of the page.

![Chocolatey Central Management Deployment Plans page, arrow pointing to Create New Deployment Plan button](/images/ccm-playwright/deployment-plans/button-create-new-deployment-plan.png)

Expand All @@ -45,11 +45,11 @@ You will also need to have at least one Group of computers already defined.

![Chocolatey Central Management Deployment Step modal, arrow pointing to execution timeout in seconds](/images/ccm-playwright/deployment-plans/edit/modal-step-input-execution-timeout-in-seconds.png)

1. (Optional, Requires Chocolatey Central Management v0.4.0+) Add a schedule by selecting the :heavy_plus_sign: **Add Schedule** button.
1. (Optional, Requires Chocolatey Central Management v0.4.0+) Add a schedule by selecting the **Add Schedule** button.

![Chocolatey Central Management New Deployment Plan page, arrow pointing to Add Schedule button](/images/ccm-playwright/deployment-plans/edit/button-add-schedule.png)

* Enter a date and time, or click the :calendar: button to pick the date and time from a calendar UI.
* Enter a date and time, or click the 📅 button to pick the date and time from a calendar UI.

![Chocolatey Central Management Deployment Plan schedule picker](/images/ccm-playwright/deployment-plans/edit/calendar-start-date-time.png)

Expand All @@ -61,7 +61,7 @@ You will also need to have at least one Group of computers already defined.

![Chocolatey Central Management Deployment Plan Repeat Period](/images/ccm-playwright/deployment-plans/edit/select-repeat-period.png)

1. Select :heavy_plus_sign: **Add Step** to add your first Deployment Step.
1. Select **Add Step** to add your first Deployment Step.

![Chocolatey Central Management Deployment Plan add Deployment Step button](/images/ccm-playwright/deployment-plans/edit/button-add-deployment-step.png)

Expand Down Expand Up @@ -99,7 +99,7 @@ You will also need to have at least one Group of computers already defined.

![Chocolatey Central Management Deployment Step Select Target Groups modal](/images/ccm-playwright/deployment-plans/edit/modal-step-select-target-groups.png)

1. Click the :floppy_disk: **Save** button to save the Deployment Step.
1. Click the 💾 **Save** button to save the Deployment Step.

![Chocolatey Central Management Deployment Step Save button](/images/ccm-playwright/deployment-plans/edit/modal-step-button-save.png)

Expand All @@ -109,7 +109,7 @@ You will also need to have at least one Group of computers already defined.

![Chocolatey Central Management Deployment Step Duplicate button](/images/ccm-playwright/deployment-plans/edit/button-duplicate-step.png)

1. Select :floppy_disk: **Save** to save the changes to the Deployment Plan.
1. Select 💾 **Save** to save the changes to the Deployment Plan.

<ImportDeploymentPlan />

Expand Down
Loading