diff --git a/docs/administration/active-directory-and-openldap-support.mdx b/docs/administration/active-directory-and-openldap-support.mdx index 7aa834792..1bbb6f8dc 100644 --- a/docs/administration/active-directory-and-openldap-support.mdx +++ b/docs/administration/active-directory-and-openldap-support.mdx @@ -6,7 +6,7 @@ sidebar_position: 1 import ThemedImage from '@theme/ThemedImage' import useBaseUrl from '@docusaurus/useBaseUrl' -Device42 can now be configured to work with multiple Active Directory (AD) servers. AD servers can be used for both Active Directory-based logins and AD synchronization. +Device42 can be configured to work with multiple Active Directory (AD) servers. AD servers can be used for both Active Directory-based logins and AD synchronization. AD settings can be found and configured under **Tools > Settings > Active Directory Settings** and are only accessible to Device42 superusers. Multiple Active Directory settings and up to one OpenLDAP server setting can be configured at a time to properly describe your environment. Each Active Directory setting can also specify multiple domains. @@ -22,10 +22,10 @@ From the Active Directory/LDAP Settings list page, click **Create**. }} /> -Under **LDAP Type**, choose **Active Directory** or **Open LDAP**. +Under **LDAP Type**, choose **Active Directory** or **OpenLDAP**. +/> If you select **Domain\Username** as your **Username login Style**, users will be required to enter both their domain and username to log in to Device42. - +/> -For the **Open LDAP** type, you can choose an **OpenLDAP group attribute** to identify group members. The available options are **memberUid**, **uniqueMember**, **members**, and **member**. +For the **OpenLDAP** type, you can choose an **OpenLDAP group attribute** to identify group members. The available options are **memberUid**, **uniqueMember**, **members**, and **member**. - +/> You can add multiple **AD/LDAP Domains** and mark them as **Default**. - +/> -### Test Connections +### Test a Connection -Test a user account for permission to query AD: +To verify that a user account has permission to query AD, test the connection from the settings details page. -- Save your settings to display the settings details page, then open the **ellipsis** (...) menu and select **Test Connection**. +- Save your settings to display the settings details page, then open the **ellipsis** (...) menu and select **Test Connection**. - +/> - You will be prompted to provide credentials for initiating the test. Leave the credentials blank to use the currently selected username and password. - +/> -## Configuring an Active Directory User Sync / Discovery Job +## Configure an Active Directory User Sync or Discovery Job -You may now configure an AD Sync Job to pull AD users in bulk and/or keep them synced. Proceed to [the Active Directory Discovery Job docs page](auto-discovery/active-directory-sync.mdx) to view the AD discovery process. +You can configure an AD sync job to pull AD users in bulk and keep them synced. See the [Active Directory Discovery Job](/auto-discovery/active-directory-sync) page for details on the AD discovery process. diff --git a/docs/administration/add-an-active-directory-user-as-a-device42-administrator.mdx b/docs/administration/add-an-active-directory-user-as-a-device42-administrator.mdx index 782284f4c..24accf85f 100644 --- a/docs/administration/add-an-active-directory-user-as-a-device42-administrator.mdx +++ b/docs/administration/add-an-active-directory-user-as-a-device42-administrator.mdx @@ -6,11 +6,11 @@ sidebar_position: 3 import ThemedImage from '@theme/ThemedImage' import useBaseUrl from '@docusaurus/useBaseUrl' -You can create Active Directory (AD) settings in Device42 and use them to add AD users as administrators. +You can create Active Directory (AD) settings in Device42 and use them to add AD users as administrators. This page covers adding AD settings, manually adding an AD administrator, and configuring an AD user sync job. -First, add your AD settings under **Tools > Settings > Active Directory Settings**. See the [Active Directory and OpenLDAP](active-directory-and-openldap-support.mdx) page for details. +First, add your AD settings under **Tools > Settings > Active Directory Settings**. See the [Active Directory and OpenLDAP](/administration/active-directory-and-openldap-support) page for details. -Next, manually add an administrator user from the Active Directory domain you configured. Navigate to **Tools > Admins & Permissions > Administrators** and click **Create Active Directory Admin**. +Next, manually add an administrator user from the Active Directory domain you configured. Navigate to **Tools > Admins & Permissions > Administrators** and click **Create Active Directory Admin**. Templates & Bulk Operations > Auto Clean Rules**. -Note that the system rule, **Shared IPs maintenance**, uses a **Number of Days** option instead of the **Modify Search** option +Note that the system rule, **Shared IPs maintenance**, uses a **Number of Days** option instead of the **Modify Search** option. Templates & Bulk Operations > Auto Clean Rules** and then click **Create**. +Navigate to **Tools > Templates & Bulk Operations > Auto Clean Rules** and then click **Create**. -The combination of object types and the search criteria you select for those object types defines the Auto Clean rule. As you build your search criteria, the **Preview** list shows the objects that the Auto Clean rule will be applied to. +The combination of object types and search criteria you select defines the Auto Clean rule. As you build your search criteria, the **Preview** list shows the objects that the rule will be applied to. -- Name the rule and click the **pencil icon**. +- Name the rule and click the **pencil icon**. -- Select an **Object Type** for the rule to target – for example, **Devices**. +- Select an **Object Type** for the rule to target (for example, **Devices**). -Build search criteria for the selected object type using the basic dropdown filters and the advanced search option. +Build search criteria for the selected object type using the basic dropdown filters and the advanced search option. - For the Devices object type, for example, you could select **physical** under the **Type** dropdown. Click **More Filters** to display more basic dropdown filters to select values from. @@ -94,7 +91,7 @@ Build search criteria for the selected object type using the basic dropdown filt }} /> -- You can also use the [Advanced Search](/getstarted/using-device42/advanced-search-feature.mdx) feature to include search criteria. +- You can also use the [Advanced Search](/getstarted/using-device42/advanced-search-feature) feature to include search criteria. -- Click **Add** to apply the search for the object type. You can click the **pencil icon** again to add another device and define search criteria for it. +- Click **Add** to apply the search for the object type. Click the **pencil icon** again to add another device and define search criteria for it. -- **Delete the data:** Delete the object. +- **Delete the data:** Delete the object. - **Archive and delete the data:** Create an archive record for the object and delete the object. You can find archived records under **Analytics > Archived Objects**. -- **Clear all IPs:** Remove IPs from the Device. -- **Clear all IPs for this subnet:** Clear all device IPs from the entered or selected subnet. -- **Clear all Connectivity:** Clear all connectivity to the device. -- **Change to not in service:** Set the device status as not in service. +- **Clear all IPs:** Remove IPs from the device. +- **Clear all IPs for this subnet:** Clear all device IPs from the entered or selected subnet. +- **Clear all Connectivity:** Clear all connectivity to the device. +- **Change to not in service:** Set the device status to not in service. -- **Change device service level to:** Choose a service level that the device will be set to when the rule is triggered. -- **Send email to:** Send notification when the rule is triggered. +- **Change device service level to:** Choose the service level to assign when the rule is triggered. +- **Send email to:** Send a notification when the rule is triggered. Settings > Active Directory Settings** and click the **Create** button. +Go to **Tools > Settings > Active Directory Settings** and click **Create**. Settings > Active Directory Settings** and click the **Create** }} /> -Fill out the settings accordingly for your AD or LDAP server. See the [Active Directory and OpenLDAP Support](active-directory-and-openldap-support.mdx) page for more details. +Fill out the settings for your AD or LDAP server. See the [Active Directory and OpenLDAP Support](/administration/active-directory-and-openldap-support) page for details. Admins & Permissions > Administrators**. From this screen, click the **Create Active Directory Admin** button. +Navigate to **Tools > Admins & Permissions > Administrators** and click **Create Active Directory Admin**. Currently, the sync only works for members in the AD group itself. Group members that require recursive traversal of subgroups are not synced. -You can save group DN properties - it makes it easier to add new users to that AD group. Just choose the saved DN group as described below and add new users. - -## Choose Members and Groups (for Permission) +You can save group DN properties to make it easier to add new users to that AD group later. Choose the saved DN group as described below and add new users. -![Choose members and groups(for permission)](/assets/images/wpid4771-AD-save-dn.png) +## Choose Members and Groups for Permissions -The **Users** listed are AD users that were displayed as a result of the choices on the prior screen. Note the **Groups** are not AD groups - they are Device42 Groups. +![Choose members and groups for permissions](/assets/images/wpid4771-AD-save-dn.png) -1. In the **Users** box, select the users that you want to add as Device42 administrators and move them to the right side of the Users dialog. +The **Users** listed are AD users that were displayed as a result of the choices on the prior screen. Note that the **Groups** are not AD groups — they are Device42 Groups. -2. Next, in the **Groups** box, select one or more Device42 groups for these users and move them to the right dialog box. - -2. Click the **Add above users** button. The selected users will become Device42 administrators and receive the permissions of the selected groups. +1. In the **Users** box, select the users that you want to add as Device42 administrators and move them to the right side of the Users dialog. +2. In the **Groups** box, select one or more Device42 groups for these users and move them to the right side of the Groups dialog. +3. Click **Add above users**. The selected users will become Device42 administrators and receive the permissions of the selected groups. -## Example - Finding your Group DN in Active Directory +## Example: Find Your Group DN in Active Directory -The following example demonstrates finding a group in Active Directory. The group DN is: +The following example demonstrates finding a group in Active Directory. The group DN is: ``` cn=D42ReadOnly,cn=Users,dc=device42,dc=pvt ``` -In this example, the group name `D42ReadOnly` is in the container named "Users". +In this example, the group name `D42ReadOnly` is in the container named `Users`. -![An example - how to get Group DN in Active Directory](/assets/images/wpid4770-AD-group-DN.png) +![An example of how to get Group DN in Active Directory](/assets/images/wpid4770-AD-group-DN.png) Under the group properties with **advanced features** enabled in **Active Directory Users and Computers**, go to the attribute editor and copy the **distinguishedName** as shown in the image above. diff --git a/docs/administration/console-menu.mdx b/docs/administration/console-menu.mdx index b19776610..40519f716 100644 --- a/docs/administration/console-menu.mdx +++ b/docs/administration/console-menu.mdx @@ -3,11 +3,13 @@ title: "Setup and Troubleshooting Menu" sidebar_position: 14 --- -The following console menu, titled **Device42 Appliance Management**, is presented when you log in to the Device42 Virtual Machine: +The Device42 console menu provides low-level access to appliance settings, network configuration, and maintenance tasks without requiring access to the web UI. This page describes the options available in the console menu. + +The **Device42 Appliance Management** menu appears when you log in to the Device42 Virtual Machine: ![device42-console-menu](/assets/images/console-menu-19.06.png) -The current options are as follows: +The menu options are: ``` (a) Apply Update @@ -32,3 +34,5 @@ The current options are as follows: (x) Exit ``` + +The **Change Password** option (`p`) changes the password for the `device42` OS user account on the virtual machine. diff --git a/docs/administration/custom-column-views.mdx b/docs/administration/custom-column-views.mdx index 7345351f3..27d3653fb 100644 --- a/docs/administration/custom-column-views.mdx +++ b/docs/administration/custom-column-views.mdx @@ -6,11 +6,13 @@ sidebar_position: 6 import ThemedImage from '@theme/ThemedImage' import useBaseUrl from '@docusaurus/useBaseUrl' -You can customize the column views of all list pages in Device42. You can create and save multiple custom column views for each list page, then set a global default view or set specific custom column views as the default views for particular users. +Custom column views let you control which columns appear on any list page in Device42, along with their order, width, and filter settings. This page explains how to create and save custom column views and set them as defaults for yourself or other users. + +## Create a Custom Column View To add a custom column view, navigate to a list page, such as **Resources > Compute > All Devices**. -Click the **gear icon** on the far right of the screen - to right of the current view name. The default view is **System Column List**. +Click the **gear icon** on the far right of the screen, to the right of the current view name. The default view is **System Column List**. -- In the pop-up screen, name the new view (1), click the **Table Columns** dropdown, and select (2) and deselect the columns you want. - - - -- You can reorder the columns by clicking and dragging column headings and moving them to a new position. Adjust column widths by dragging the column edges, and save the desired column widths to the view by checking the **Custom Column Sizes** checkbox. - - - -- Check the **Custom Filters** checkbox to save the currently configured filters. You can filter the records for this view using the basic dropdown filters or the **Advanced** search feature for more fine-grained control. - - - -- Clicking the **Advanced** button reveals a text box where you can query specific field values using conditionals and equality selectors. See the [Advanced Search Feature page](/getstarted/using-device42/advanced-search-feature.mdx) for details. - - - -- Click the **Save As New** button to return to the list page with the new view applied. +In the dialog, name the new view (1), click the **Table Columns** dropdown, and select (2) and deselect the columns you want. + +Check the **System Default** checkbox to set this view as the default for all users, or check **User Default** to set it as the default for your own account only. + + + +Reorder the columns by clicking and dragging column headings to a new position. Adjust column widths by dragging the column edges, and save the desired column widths to the view by checking the **Custom Column Sizes** checkbox. + + + +Check the **Custom Filters** checkbox to save the currently configured filters. Filter the records for this view using the basic dropdown filters or the **Advanced** search feature for more fine-grained control. + + + +Clicking the **Advanced** button reveals a text box where you can query specific field values using conditionals and equality selectors. See the [Advanced Search Feature page](/getstarted/using-device42/advanced-search-feature) for details. + + + +Click the **Save As New** button to return to the list page with the new view applied. ## Customizable List Pages diff --git a/docs/administration/custom-key-value-pairs-explained.mdx b/docs/administration/custom-key-value-pairs-explained.mdx index 5732bcaca..cdc6826d3 100644 --- a/docs/administration/custom-key-value-pairs-explained.mdx +++ b/docs/administration/custom-key-value-pairs-explained.mdx @@ -6,16 +6,14 @@ sidebar_position: 7 import ThemedImage from '@theme/ThemedImage' import useBaseUrl from '@docusaurus/useBaseUrl' -Device42 offers users the ability to define their own fields. +Custom Fields let you define your own attributes for Device42 objects such as Buildings, Rooms, Racks, Customers, Devices, Assets, Application Components, Circuits, and Passwords. This page explains how to create and configure Custom Fields, set them in bulk, and use them via the API. -You can add custom fields to buildings, rooms, racks, customers, devices, assets, application components, circuits, and passwords as discussed below. This feature enables you to store any custom attributes you need to store in Device42. You can also display custom fields and filter on custom fields in Reports. +## Add Custom Fields -## Adding Custom Fields - -Navigate to the Custom Fields list page under **Tools > Custom Fields** and click on a custom field object type (for example, **Assets** or **Devices**). +Navigate to the Custom Fields list page under **Tools > Custom Fields** and click on a Custom Field object type (for example, **Assets** or **Devices**). Custom Fields** and clic style={{ width: '80%' }} /> -- From the list page for the selected custom field type, you can either edit an existing custom field or click the **Create** button to add a new one. - - - -- Input the name for the custom field and choose its data **Type**. Certain custom field types, when selected, will present more options specific to that field type. The available types are listed below. - - - **Text:** These fields use character-based values. - - **Number:** These fields use numeric values. - - **Date:** These fields use calendar date formatting. - - **Related Field:** These fields use the values of other fields (for example, if **Rack** is chosen, then rack names are possible values). - - **Yes/No:** These fields use yes or no values. - - **URL:** These fields use URL values. - - **Picklist:** These fields use values chosen from a picklist. - - You can create either single-select or multi-select picklists. - - After creation, you can adjust the picklist parameters without needing to recreate and reassign custom fields. - - - **JSON:** These fields use JSON formatting. - - **Markup:** These fields use markup formatting. +From the list page for the selected Custom Field type, you can either edit an existing Custom Field or click the **Create** button to add a new one. + +Enter a name for the Custom Field and choose its data **Type**. Selecting certain types will reveal additional options specific to that field type. The available types are: + +- **Text:** Character-based values. +- **Number:** Numeric values. +- **Date:** Calendar date formatting. +- **Related Field:** Values from another field (for example, if **Rack** is chosen, then Rack names are the possible values). +- **Yes/No:** Yes or no values. +- **URL:** URL values. +- **Picklist:** Values chosen from a picklist. You can create either single-select or multi-select picklists, and adjust the picklist parameters after creation without needing to recreate and reassign Custom Fields. +- **JSON:** JSON formatting. +- **Markup:** Markup formatting. + + Custom Fields** and clic style={{ width: '90%' }} /> -- If you check the **Filterable** box, the list view page for the object type (for example, Devices) will contain the custom field as a filter option, which allows you to filter the list view by the custom field value. You can find the filterable custom field in the **More Filters** dropdown. +Check the **Filterable** box to add the Custom Field as a filter option on the list view page for the object type (for example, Devices). You can find filterable Custom Fields in the **More Filters** dropdown. - + -- If a custom field is marked as **Mandatory**, the device (or other object) record can only be saved once a custom field value has been entered, as shown below. Please note that the field is only enforced as mandatory when objects are edited or added via the UI. The field is not mandatory when objects are edited or added via the API. +If a Custom Field is marked as **Mandatory**, the object record can only be saved once a value has been entered for that field. Note that the mandatory requirement is only enforced when objects are edited or added via the UI, not via the API. - + ## Bulk Set Custom Field Values -Set custom field values in bulk using the **Set Custom Field Value** action, which is available on most list pages from the **Actions** dropdown. +Set Custom Field values in bulk using the **Set Custom Field Value** action, available on most list pages from the **Actions** dropdown. - + -- Search for the custom field you want to set values for and input the necessary value(s). You can also add a note if desired. +Search for the Custom Field you want to set values for, enter the necessary values, and optionally add a note. - + ## Create a Custom Field for Secrets You can add a Custom Field to the Secrets form to store additional values. -- Navigate to **Tools > Custom Fields** and click on the **Secrets** link. +Navigate to **Tools > Custom Fields** and click the **Secrets** link. - - -- Name the custom field, choose its data **Type**, whether it is **Filterable**, and whether it is **Mandatory**. By default, the custom field is set to **Log for API**, which means any changes made to this custom field via the Device42 API will be recorded in the history log. + - +Name the Custom Field and choose its data **Type**, whether it is **Filterable**, and whether it is **Mandatory**. By default, the **Log for API** option is enabled, which means any changes made to this Custom Field via the Device42 API will be recorded in the history log. -- You can now assign a value to the newly created custom field when creating a new Secret, and add a note if desired. + - +You can assign a value to the newly created Custom Field when creating a new Secret, and add a note if desired. -## REST APIs for Custom Values + -You can find the documentation for adding Custom Fields to various objects using the API in the [API Documentation](https://api.device42.com). +## REST APIs for Custom Fields -For example, to see the API documentation for adding custom fields to Devices, navigate to **Devices > Custom fields**. +The [API documentation](https://api.device42.com) covers adding Custom Fields to various objects. For example, to see the API documentation for adding Custom Fields to Devices, navigate to **Devices > Custom fields**. -### Assigning Related Field Values by Object ID +### Assign Related Field Values by Object ID -You can populate a **related** custom field by sending the *object ID* instead of its name. +You can populate a **Related Field** Custom Field by sending the *object ID* instead of its name. Add two form parts to your `POST` or `PUT` request: @@ -164,10 +157,10 @@ Add two form parts to your `POST` or `PUT` request: ``` -The call above sets **End User Details** to the end user whose object ID is **6**. +The call above sets **End User Details** to the end user whose object ID is `6`. -For full parameter details, read the documentation for the [Customers](https://api.device42.com/#!/Customers) endpoint. +For full parameter details, see the [Customers](https://api.device42.com/#!/Customers) endpoint documentation. -## Exago Reports Note +## Exago Reports Compatibility -For Exago reports (which are not enabled by default), we've made changes to a couple of custom field data types that may affect existing queries. Custom numeric and date fields are now represented as `DATE` and `BIGINT` instead of `TEXT`, which might affect existing queries. Queries containing `TEXT`-related builtins, like `SUBSTRING`, may fail and need to be updated using the updated data type. Queries with basic operators in the `WHERE` clause, like `=` and `<>`, should all continue without issues. +For Exago reports, which are not enabled by default, some Custom Field data types have changed in a way that may affect existing queries. Custom numeric and date fields are now represented as `DATE` and `BIGINT` instead of `TEXT`. Queries that use `TEXT`-related functions such as `SUBSTRING` may fail and need to be updated to use the new data type. Queries with basic operators in the `WHERE` clause, such as `=` and `<>`, should continue to work without changes. diff --git a/docs/administration/customizing-device42.mdx b/docs/administration/customizing-device42.mdx index 3ac67edf9..65cbd95d8 100644 --- a/docs/administration/customizing-device42.mdx +++ b/docs/administration/customizing-device42.mdx @@ -6,7 +6,9 @@ sidebar_position: 8 import ThemedImage from '@theme/ThemedImage' import useBaseUrl from '@docusaurus/useBaseUrl' -You can add your logo and a message to the login screen of your Device42 instance. +Device42 lets you personalize the login screen with your company logo and a custom message for users. This page covers how to upload a logo and add user instructions via Global Settings. + +## Customize the Login Screen Navigate to **Tools > Settings > Global Settings** and scroll down to the **Login screen** section. @@ -20,7 +22,7 @@ Navigate to **Tools > Settings > Global Settings** and scroll down to the **Logi ## Add Your Company Logo to Device42 -If you upload a logo, it will replace the Device42 logo on the login screen. +Upload a logo to replace the default Device42 logo on the login screen. -## Add User Instructions to the Login Page +## Add User Instructions to the Login Screen -If you upload user instructions, they will appear on the login page. +Upload user instructions to display a custom message on the login screen, such as access policies or contact information for support. -![customization.png](/assets/images/2015-10-10-customization-3.png) +![Login page with custom user instructions](/assets/images/2015-10-10-customization-3.png) diff --git a/docs/administration/data-reset-tool.mdx b/docs/administration/data-reset-tool.mdx index 522cbdbba..d458b6c8a 100644 --- a/docs/administration/data-reset-tool.mdx +++ b/docs/administration/data-reset-tool.mdx @@ -3,16 +3,16 @@ title: "Data Reset Tool" sidebar_position: 9 --- -If you're looking to wipe your Device42 instance clean, grab the Python script available on [Github](https://github.com/device42/ResetDevice42Data) and use it to remove all devices from your Device42 Main Appliance. +The Data Reset Tool is a Python script that removes all devices from your Device42 Main Appliance, letting you wipe a Device42 instance clean. This page covers how to configure and run the script. ## Clear All Devices from Device42 -To use the tool, simply open it in your favorite text editor (ours are [Notepad++](https://notepad-plus-plus.org/) & [Atom](https://www.Atom.io)), and edit the Device42 URL to point at your instance. Update the username and password fields with credentials for your instance, and save. +Download the script from [GitHub](https://github.com/device42/ResetDevice42Data) and open it in a text editor. Update the Device42 URL to point at your instance, then update the username and password fields with credentials for your instance and save the file. -You can then run the script on any computer with Python 3.7+ installed. +You can then run the script on any computer with Python 3.7 or later installed. -**Note:** The Device42 reset script does not currently clear subnets from the application, they will need to manually be cleared. +**Note:** The script does not clear subnets from the application. Subnets must be removed manually. :::warning -**This script will clear all devices from Device42**. [Make a backup](appliance-manager/setting-up-backup-device42-appliance-manager.mdx) first if you're even a little bit unsure! -::: \ No newline at end of file +**This script will clear all devices from Device42.** [Make a backup](/administration/appliance-manager/setting-up-backup-device42-appliance-manager) first. +::: diff --git a/docs/administration/generating-csrs.mdx b/docs/administration/generating-csrs.mdx index 9136c02a8..44dacfa1f 100644 --- a/docs/administration/generating-csrs.mdx +++ b/docs/administration/generating-csrs.mdx @@ -3,48 +3,50 @@ title: "Generating CSRs" sidebar_position: 10 --- -Instructions to generate certificates with openSSL can also be found [documented here, on our support site.](https://support.device42.com/hc/en-us/articles/222221348-My-demo-certificate-for-https-expired-how-can-I-add-a-new-one-) +A Certificate Signing Request (CSR) is required to obtain a signed SSL certificate for your Device42 instance. This page covers how to generate a CSR and self-signed certificate using OpenSSL, and how to apply the certificate via the Appliance Manager. -To generate a CSR (Certificate Signing Request), open a terminal that has the **openssl** package installed. +Additional instructions for generating certificates with OpenSSL are available on the [Device42 support site](https://support.device42.com/hc/en-us/articles/222221348-My-demo-certificate-for-https-expired-how-can-I-add-a-new-one-). -The following commands will generate a (self-signed) SSL certificate from a new or existing OpenSSL installation: +## Generate a CSR with OpenSSL -1. Generate a **private** key for your server CA (Certificate Authority): +Open a terminal with the `openssl` package installed. The following commands generate a self-signed SSL certificate from a new or existing OpenSSL installation. + +1. Generate a private key for your server CA (Certificate Authority): ```bash - $ openssl genrsa -des3 -out ca.key 4096 + openssl genrsa -des3 -out ca.key 4096 ``` 2. Create a certificate file using the generated CA private key: ```bash - $ openssl req -new -x509 -days 3650 -key ca.key -out ca_file + openssl req -new -x509 -days 3650 -key ca.key -out ca_file ``` -3. Create a **private** key for your new SSL certificate: +3. Create a private key for your new SSL certificate: ```bash - $ openssl genrsa -des3 -out server.key 2048 + openssl genrsa -des3 -out server.key 2048 ``` -4. Create certificate signing request (CSR) for your SSL certificate: +4. Create a certificate signing request (CSR) for your SSL certificate: ```bash - $ openssl req -new -key server.key -out server.csr + openssl req -new -key server.key -out server.csr ``` -5. Sign the CSR we created above with our CA key, and export the signed x509 certificate: +5. Sign the CSR with your CA key and export the signed x509 certificate: ```bash - $ openssl x509 -req -days 365 -in server.csr -CA ca_file -CAkey ca.key -set_serial 01 -out cert_file + openssl x509 -req -days 365 -in server.csr -CA ca_file -CAkey ca.key -set_serial 01 -out cert_file ``` 6. Export the private key file in the correct format: ```bash - $ openssl rsa -in server.key -out key_file + openssl rsa -in server.key -out key_file ``` -Adding a new certificate is easy; See [add a new certificate via appliance manager instructions here](appliance-manager/set-up-https-cert.mdx). +Once you have the certificate files, see [Add an HTTPS Certificate via Appliance Manager](/administration/appliance-manager/set-up-https-cert) for instructions on applying them. ## Generate Non-Production CSRs :::caution -We recommend using the OpenSSL method outlined above. Use the following online generator at your own risk, and only for non-production purposes. A 'private' key generated by this link (or any third party) is unlikely to be truly private. +Use the OpenSSL method above for production environments. Online CSR generators should only be used for non-production purposes — a private key generated by a third party is unlikely to be truly private. ::: -If you need to quickly generate a non-production Certificate Signing Request (CSR), you can use this online CSR generator at your own risk: [CSR Generator](https://csrgenerator.com). +For a quick non-production CSR, you can use an online generator such as [csrgenerator.com](https://csrgenerator.com) at your own risk. diff --git a/docs/administration/index.mdx b/docs/administration/index.mdx index c5c82656c..81aca5420 100644 --- a/docs/administration/index.mdx +++ b/docs/administration/index.mdx @@ -3,11 +3,9 @@ title: "Administration" sidebar_position: 1 --- -This guide is designed to assist administrators in efficiently managing and configuring the Device42 platform. Navigate through the topics regarding various advanced features and configuration settings using the sidebar on the left. +The Administration section covers configuration and management settings for the Device42 platform. Use the sidebar to navigate to specific topics, or browse the subsections below. -The following subsections contain further topic breakdowns: - -- The [Appliance Manager](appliance-manager/index.mdx) section includes information on how to change your appliance hostname, make backups, manage HTTP certificates, generate logs, and more. -- See [Passwords](passwords/index.mdx) for information on password security, storage, permissions, operations, policy and reporting. -- [Role-Based Access Control](role-based-access-control/index.mdx) explains how to restrict access based on various criteria, including managing [permission groups](role-based-access-control/role-based-permissions-and-access.mdx) -- For information on how to provide feedback or contribute to our documentation, see the [Feedback and Contributions](feedback-and-contributions/index.mdx) section. +- The [Appliance Manager](/administration/appliance-manager) section covers changing your appliance hostname, making backups, managing SSL certificates, generating logs, and more. +- See [Passwords](/administration/passwords) for information on password security, storage, permissions, operations, policy, and reporting. +- [Role-Based Access Control](/administration/role-based-access-control) explains how to restrict access based on various criteria, including managing [permission groups](/administration/role-based-access-control/role-based-permissions-and-access). +- For information on how to provide feedback or contribute to the documentation, see the [Feedback and Contributions](/administration/feedback-and-contributions) section. diff --git a/docs/administration/licensing.mdx b/docs/administration/licensing.mdx index 84e827715..b8bf10a4b 100644 --- a/docs/administration/licensing.mdx +++ b/docs/administration/licensing.mdx @@ -6,76 +6,82 @@ sidebar_position: 11 import ThemedImage from '@theme/ThemedImage' import useBaseUrl from '@docusaurus/useBaseUrl' -Device42 licenses are valid for one year from the date of purchase. To continue using Device42 after the license expires, please [contact support](https://support.device42.com/hc/en-us) about renewing it. +Device42 licenses are valid for one year from the date of purchase. To continue using Device42 after the license expires, [contact support](https://support.device42.com/hc/en-us) about renewing it. This page answers common questions about finding, applying, and managing your Device42 license. -## Where Do I Find My License Information? +## Find Your License Information -- To see your current Device42 licenses, navigate to **Tools > Settings > Licensing** from the main menu to display the Licensing page. +To see your current Device42 licenses, navigate to **Tools > Settings > Licensing** from the main menu. - + -- The page displays the available license modules and whether they are enabled. +The page displays the available license modules and whether they are enabled. - + -## How Do I Get a License? +## Get a License -After [purchasing](https://www.device42.com/pricing/?nab=0) or renewing your Device42 license, you'll receive a license file via email to upload on the Licensing page of the Main Appliance. +After [purchasing](https://www.device42.com/pricing/) or renewing your Device42 license, you'll receive a license file via email to upload on the Licensing page of the Main Appliance. :::info -If you need a developer or test license, please email [support@device42.com](mailto:support@device42.com). +If you need a developer or test license, email [support@device42.com](mailto:support@device42.com). ::: -## How Do I Apply My License? +## Apply Your License -Go to the License page under **Tools > Settings > Licensing** and do the following: +Go to the Licensing page under **Tools > Settings > Licensing**. -- **Browse** to locate the `.lic` license file on your machine. Click **Upload & Apply**. +Click **Browse** to locate the `.lic` license file on your machine, then click **Upload & Apply**. - + -- Head back to the Main Appliance home page to register the license. If your instance has internet access, click **Register Now** to complete the registration process. If your instance doesn't have internet access, copy and email the registration code to [support@device42.com](mailto:support@device42.com) to complete the registration process. +Return to the Main Appliance home page to register the license. If your instance has internet access, click **Register Now** to complete registration. If your instance doesn't have internet access, copy the registration code and email it to [support@device42.com](mailto:support@device42.com). - + - You have 30 days to complete the registration process, but we recommend doing it right away. +You have 30 days to complete registration, but it's best to do it right away. - ![Registration success message](/assets/images/licensing/success-message-dark.png) + -- After registering your license, refresh the browser. The banner will disappear, and you'll see the updated expiration date on the Licensing page. +After registering your license, refresh the browser. The banner will disappear, and you'll see the updated expiration date on the Licensing page. -## When Will My License Expire? +## Check Your License Expiration Date -You can check the **License Valid Until(YYYYMMDD):** date on the License page under **Tools > Settings > Licensing**. +You can check the **License Valid Until (YYYYMMDD):** date on the Licensing page under **Tools > Settings > Licensing**. -Two weeks before your license expires, on your Main Appliance home page, you'll see a red banner with a notification message counting down the days to the expiration date. +Two weeks before your license expires, a red banner appears on the Main Appliance home page with a countdown of the days remaining until expiration. -## What Uses a License? +## Understand License Units -Device42 has a Core license for autodiscovery and offers additional license modules for more discovery and data retrieval capabilities. +Device42 has a Core license for discovery and offers additional license modules for more discovery and data retrieval capabilities. -The Core license includes the discovery of physical, virtual, and cloud components, IT inventory and asset management, all out-of-the-box integrations, RESTful APIs and webhooks, warranty and SSL certificate management, cable management, password management, and IP address management. +The Core license includes discovery of physical, virtual, and cloud components, IT inventory and asset management, all out-of-the-box integrations, RESTful APIs and webhooks, warranty and SSL certificate management, cable management, password management, and IP address management. -Device42 licensing is based on license units. The units are consumed at different rates by different discovered resources. For example: +Device42 licensing is based on license units. Units are consumed at different rates depending on the type of discovered resource: - 1 Device = 1 License Unit (1 : 1) - 10 Containers = 1 License Unit (10 : 1) @@ -114,4 +120,4 @@ The lower portion of the **Tools > Settings > Licensing** page displays the numb }} /> -For more information about Device42 Core licensing and available licensing modules, visit our [Licensing/Purchasing FAQs page.](https://www.device42.com/company/faqs/?__hstc=51647990.ff5a79f118fd1dd66635c3ee1a2d193e.1631544705170.1639762215281.1640032949648.107&__hssc=51647990.2.1640032949648&__hsfp=1853336022) +For more information about Device42 Core licensing and available licensing modules, visit the [Licensing/Purchasing FAQs page](https://www.device42.com/company/faqs/). diff --git a/docs/administration/main-appliance-remote-collector-faq.mdx b/docs/administration/main-appliance-remote-collector-faq.mdx index ea78673ae..ab1be48f8 100644 --- a/docs/administration/main-appliance-remote-collector-faq.mdx +++ b/docs/administration/main-appliance-remote-collector-faq.mdx @@ -5,36 +5,36 @@ sidebar_position: 12 This page answers frequently asked questions about downloading, updating, and managing the Device42 Main Appliance (MA) and Remote Collector (RC). -## How Do I Get the Download Files? +## Download Files -Go to [https://www.device42.com/update/](https://www.device42.com/update/), there are now two options for download - the latest Main Appliance (MA) or the latest Remote Collector (RC). Enter your email in the field shown and we will send the file to you, along with release notes and next steps. +Go to [https://www.device42.com/update/](https://www.device42.com/update/) to download the latest Main Appliance (MA) or Remote Collector (RC). Enter your email address and Device42 will send you the file along with release notes and next steps. -## Can I Download the Newest RC Despite My MA Version? +## RC and MA Version Compatibility -No, it’s required that you be on the immediately-prior Main Appliance release to get the latest RC update. For example, if the latest MA version was 17.07.00, you cannot download the RC release of 17.07.02 until you’re on 17.07.00. +You must be on the immediately prior Main Appliance release before downloading the latest RC update. For example, if the latest MA version is 17.07.00, you cannot download RC release 17.07.02 until you have upgraded to MA 17.07.00. -## What Happens if I Attempt to Download the RC Before I Install the Newest MA? +### Download the RC Before Installing the Newest MA -The download will stop and tell you that you must first upgrade the MA. +If you attempt to download the RC before installing the latest MA, the download will stop and prompt you to upgrade the MA first. -## What if I Install an Older RC Update Onto a Newer MA Version? +### Install an Older RC Update on a Newer MA Version -This action will fail - the installer will prompt you to get the correct version. +This will fail — the installer will prompt you to download the correct version. -## Will MA Updates Update My RCs? +## Update Remote Collectors with an MA Update -Yes, just as in the past, when you download the MA update, it will subsequently update your RCs to the latest version. +When you download an MA update, it will also update your Remote Collectors to the latest version. -## What if I'm on a Much Older Version of the MA? +## Upgrade from an Older MA Version -If you’re more than three or four versions behind our current Main Appliance release (the website will give the specific cut off point), you will need to contact support for upgrade assistance. +If you are more than three or four versions behind the current Main Appliance release, contact support for upgrade assistance. The Device42 update page shows the specific cutoff version. -If you’re less than three versions behind, downloading the new MA file will bring you fully up to date. +If you are fewer than three versions behind, downloading the new MA file will bring you fully up to date. -## If I Am on the Latest MA Release, How Do I Update My Remote Collectors? +## Update Remote Collectors on the Latest MA Release -This update will need to be pushed via the Appliance Manager once you have the upgrade file. Step by step instructions can be found here: [https://docs.device42.com/getstarted/using-device42/faqs/](/getstarted/using-device42/faqs.mdx). +Push the update via the Appliance Manager once you have the upgrade file. For step-by-step instructions, see the [Device42 FAQs](/getstarted/using-device42/faqs). -## How Is the Remote Collector Proxy Configured? +## Configure the Remote Collector Proxy -The proxy that you set up in the MA will be used for remote collector too. You can view and edit the inherited proxy settings from the [RC view and edit page](/auto-discovery/remote-collector-rc/#viewedit-remote-collector.mdx). +The proxy configured on the MA is also used by the Remote Collector. You can view and edit the inherited proxy settings from the [RC view and edit page](/auto-discovery/remote-collector-rc/#view-and-edit-remote-collectors). diff --git a/docs/administration/saml-2-0-configuration.mdx b/docs/administration/saml-2-0-configuration.mdx index b00f49a83..7e017a02b 100644 --- a/docs/administration/saml-2-0-configuration.mdx +++ b/docs/administration/saml-2-0-configuration.mdx @@ -3,41 +3,39 @@ title: "SAML 2.0 Configuration" sidebar_position: 13 --- -Device42 integrates with SAML 2.0 in conjunction with AD or LDAP user synchronizations to provide Single Sign On (SSO) support in Device42. Once users are added to Device42 via Active Directory or LDAP, they will automatically be logged into Device42 when they load the site. +Device42 integrates with SAML 2.0 alongside AD or LDAP user synchronization to provide Single Sign-On (SSO) support. Once users are added to Device42 via Active Directory or LDAP, they are automatically logged in when they load the site. :::note -Since authorization is handled by Device42, the SSO functionality only works if the user account already exists within Device42 before the user logs in. +Authorization is handled by Device42, so SSO only works if the user account already exists in Device42 before the user logs in. ::: -SAML configuration varies between providers, but we'll provide the steps for configuration with Microsoft ADFS, Okta, and Onelogin below as examples. Device42 SSO should also work with **any** SAML 2.0 compatible Identity Provider and has been confirmed to work with IDaaS providers, Centrify, and PingIdentity's PingOne and PingFederate. +SAML configuration varies between providers. This page covers configuration steps for Microsoft ADFS, Azure AD, Okta, and OneLogin as examples. Device42 SSO also works with any SAML 2.0 compatible Identity Provider and has been confirmed to work with IDaaS providers, Centrify, and PingIdentity's PingOne and PingFederate. -Should you need further assistance, please contact [Support](mailto:support@device42.com). +For further assistance, contact [Support](mailto:support@device42.com). -## Microsoft ADFS Configuration +## Configure Microsoft ADFS Add a new relying party trust. ![ADFS Party Trust](/assets/images/adfs-001.png) -Next screen: Add data manually. +On the next screen, select **Add data manually**. ![ADFS Party Trust](/assets/images/adfs-002.png) -Next screen: Specify your app display name. +Specify your app display name, then choose the **AD FS** profile. -Next screen: Choose **AD FS** profile. - -Next screen: Choose **SAML 2.0 SSO** and set proper D42 ACS URL: `https://___device42___url/saml2_auth/acs/`. +Select **SAML 2.0 SSO** and set the Device42 ACS URL: `https:///saml2_auth/acs/`. ![](/assets/images/SAML-admin_adfs-003.png) -Next screen: Set identifiers access: `https://___device42___url/saml2_auth/acs/`. +Set the identifier to `https:///saml2_auth/acs/`. ![](/assets/images/SAML-admin_adfs-004.png) -Next screen: Permit all users. +Select **Permit all users**. -Next screen: In the claims section (click **Edit claims** on the relying party / automatically go to this section after initial setup), add the following claims: +In the claims section (click **Edit claims** on the relying party, or go there automatically after initial setup), add the following claims: - The `username` claim @@ -47,51 +45,51 @@ Next screen: In the claims section (click **Edit claims** on the relying party / ![ADFS Party Trust](/assets/images/adfs-006.png) -Then, copy the metadata URL from the endpoints. +Copy the metadata URL from the endpoints. ![ADFS Party Trust](/assets/images/adfs-007.png) -If you receive a time synchronization error, please write this command in PowerShell: +If you receive a time synchronization error, run the following command in PowerShell: ```bash Set-ADFSRelyingPartyTrust -TargetIdentifier "" -NotBeforeSkew 5 ``` -## Azure AD Configuration +## Configure Azure AD -1. Navigate to Azure AD in the Azure portal via **Enterprise Applications > New Application > Create your own application**. Give your app a name (the app shown in the screenshots is `Device42SAML`) and select the third option **Integrate any other application...**, then click **Create**. +1. Navigate to Azure AD in the Azure portal via **Enterprise Applications > New Application > Create your own application**. Give your app a name (the app shown in the screenshots is `Device42SAML`) and select **Integrate any other application...**, then click **Create**. ![](/assets/images/image-5.png) -2. Open your newly created enterprise app. Then, under the **Getting Started** section, select the second option, **Set up Single sign on**. Alternatively, select **Single sign-on** under **Manage** in the left-hand toolbar. +2. Open your newly created enterprise app. Under the **Getting Started** section, select **Set up Single sign on**, or select **Single sign-on** under **Manage** in the left-hand toolbar. ![](/assets/images/image2.png) -3. In the first section, **Basic SAML Configuration**, enter `https:///saml2_auth/acs/` in the **Identifier (Entity ID)** and **Reply URL (Assertion Consumer Service URL)** fields. +3. In the **Basic SAML Configuration** section, enter `https:///saml2_auth/acs/` in both the **Identifier (Entity ID)** and **Reply URL (Assertion Consumer Service URL)** fields. ![](/assets/images/image3.png) -4. Navigate to the Device42 Appliance Manager and go to **Global Settings > SAML/SSO Settings**. Copy the **App Federation Metadata URL** in the **SAML Signing Certificate** section for the enterprise app you created in Azure AD, and paste the URL into the **Metadata auto conf url** field in the Device42 Appliance Manager. +4. Navigate to the Device42 Appliance Manager and go to **Global Settings > SAML/SSO Settings**. Copy the **App Federation Metadata URL** from the **SAML Signing Certificate** section of your Azure AD enterprise app, and paste it into the **Metadata auto conf url** field. ![](/assets/images/image4.png) -5. While still in the **SAML 2.0 Settings** of the Appliance Manager, enter `username` or another appropriate SAML attribute in the **Username field**. Unless you have signed responses configured on your Azure AD provider side, keep the **Require signed response** box unchecked; otherwise, you'll get an unavailable page message. +5. In the **SAML 2.0 Settings** of the Appliance Manager, enter `username` or another appropriate SAML attribute in the **Username field**. Unless you have signed responses configured on the Azure AD provider side, leave the **Require signed response** box unchecked — otherwise, you'll get an unavailable page error. - Azure's built-in claims like `emailaddress` may not work with Device42, even though they appear in the Azure interface, because the built-in claim uses a namespace URI format. The solution is to create a new claim for `emailaddress` in your Azure AD enterprise app, map the claim to the user attribute, and use the custom claim name in the Device42 SAML **Username field**. + Azure's built-in claims like `emailaddress` may not work with Device42, even though they appear in the Azure interface, because the built-in claim uses a namespace URI format. To resolve this, create a new claim for `emailaddress` in your Azure AD enterprise app, map the claim to the user attribute, and use the custom claim name in the Device42 SAML **Username field**. - Save and restart the appliance from the VM console menu. You may wish to complete steps 6 and 7 before saving or restarting, so that you can still log in to Device42 and create users with the local admin account you've used so far. + Save and restart the appliance from the VM console menu. You may want to complete steps 6 and 7 before saving or restarting, so that you can still log in to Device42 with the local admin account. ![Enter SAML username](/assets/images/enable-saml-2.0.png) -6. Assign users or groups to the SAML enterprise app you created in Azure AD. These should be users or groups that you want to allow authentication into Device42 via this SAML integration. +6. Assign users or groups to the SAML enterprise app in Azure AD — these should be the users or groups you want to allow to authenticate into Device42 via SAML. -7. For any users associated with the enterprise app in Azure AD, create the user in Device42 using the appropriate Azure AD value with a dummy password. The integration does not pull and create users directly from Azure AD, so the users must be created within Device42 prior to any attempt to authenticate via Azure AD. +7. For each user associated with the enterprise app in Azure AD, create the user in Device42 using the appropriate Azure AD value with a placeholder password. The integration does not create users directly from Azure AD, so users must exist in Device42 before they can authenticate via Azure AD. -8. Once the above has been completed, you should be able to log in to your Device42 instance with your Azure AD credentials. +8. Once the above steps are complete, you can log in to your Device42 instance with your Azure AD credentials. -## Okta Configuration +## Configure Okta -In Okta, click the **Admin** button: +In Okta, click the **Admin** button. ![Okta Admin Link](/assets/images/saml-001.png) @@ -99,7 +97,7 @@ Click the **Applications** button. ![Okta Applications Link](/assets/images/saml-002.png) -On the Applications page, find and click the **Add Application** button. +On the Applications page, click **Add Application**. ![Okta Admin Link](/assets/images/saml-003.png) @@ -115,23 +113,23 @@ Set your application preferences and click **Next**. ![Okta Admin Link](/assets/images/saml-006.png) -On the next page, set up the ACS URL and field mapping. Enter `https://yourdevice42address/saml2_auth/acs/` for both the **Single sign on URL** and the **Audience URI (SP Entity ID)** fields. In the **Attribute Statements** section, the **Value** should be the same AD or LDAP attribute that your users will use to log in to Device42. Note the attribute statement **Name**, as it is needed in the Device42 Appliance Manager configurations. +Set up the ACS URL and field mapping. Enter `https:///saml2_auth/acs/` for both the **Single sign on URL** and the **Audience URI (SP Entity ID)** fields. In the **Attribute Statements** section, the **Value** should be the same AD or LDAP attribute your users will use to log in to Device42. Note the attribute statement **Name**, as it is required in the Device42 Appliance Manager configuration. ![Okta Admin Link](/assets/images/saml-007.png) -Click **Next** and finish the setup. Open your application settings, go to the **Sign On** tab, and copy the URL of the **Identity Provider metadata** link. You will use this URL as the **Metadata auto conf url** in Device42's Appliance Manager. +Click **Next** and finish the setup. Open your application settings, go to the **Sign On** tab, and copy the URL of the **Identity Provider metadata** link. You will use this URL as the **Metadata auto conf url** in the Device42 Appliance Manager. ![Okta Admin Link](/assets/images/saml-008.png) -## OneLogin Configuration +## Configure OneLogin -To configure SAML 2.0 integration between OneLogin and Device42, you have to create a `SAML2 connector app` in OneLogin. Then, you need to add users to the `SAML2 connector app` so they can log in via a OneLogin account. +To configure SAML 2.0 integration between OneLogin and Device42, create a SAML2 connector app in OneLogin and add users to it so they can log in via their OneLogin accounts. -### Creating the SAML2 Connector App +### Create the SAML2 Connector App -1. Create and log in to your OneLogin account. +1. Log in to your OneLogin account. -2. Create an app connector in OneLogin: +2. Create an app connector: - Go to **Applications > Applications**. @@ -141,71 +139,67 @@ To configure SAML 2.0 integration between OneLogin and Device42, you have to cre ![](/assets/images/D42-26961_saml_config_2.jpg) -3. Search for **SAML custom connector** and select **SAML Custom Connector (Advanced)**. +3. Search for **SAML custom connector** and select **SAML Custom Connector (Advanced)**. ![](/assets/images/D42-26961_saml_config_3.jpg) -4. Type a display name and **Save**. +4. Enter a display name and click **Save**. -5. Go to the **Configuration** tab: +5. Go to the **Configuration** tab and fill in the following fields, then click **Save**: - - Put the value, `https://<>/saml2_auth/acs/`, in the **Audience (EntityID)**, **Recipient** and **ACS (Consumer) URL** fields. - - Put `.*` in the **ACS(Consumer) URL Validator** field. - - Save. + - **Audience (EntityID)**, **Recipient**, and **ACS (Consumer) URL**: `https:///saml2_auth/acs/` + - **ACS (Consumer) URL Validator**: `.*` ![](/assets/images/D42-26961_saml_config_4.jpg) -6. Go to the **Parameters** tab and add a new field by clicking on the **plus icon**. +6. Go to the **Parameters** tab and add a new field by clicking the **plus icon**. ![](/assets/images/D42-26961_saml_config_5.jpg) - - Type `username` as the **Field name**. - - Select the **Include in SAML assertion** checkbox. + - Enter `username` as the **Field name**. + - Select the **Include in SAML assertion** checkbox. ![](/assets/images/D42-26961_saml_config_6.jpg) - Click **Save**. - - Choose the **Username** from the dropdown as the **Value**. + - Choose **Username** from the dropdown as the **Value**. ![](/assets/images/D42-26961_saml_config_7.jpg) - Click **Save**. -7. In the **SSO** tab: - - - Copy the **Issuer URL**. You will enter this in the **Metadata auto conf url** field in Device42. +7. Go to the **SSO** tab and copy the **Issuer URL**. You will enter this in the **Metadata auto conf url** field in Device42. ![](/assets/images/D42-26961_saml_config_8.jpg) -After this, the SAML2 app is created and ready to be integrated with Device42. +The SAML2 app is now created and ready to integrate with Device42. + +### Configure the Device42 Appliance Manager -### Configuring the Device42 Appliance Manager +Log in to the Device42 Appliance Manager at `https://:4343`, go to **SAML/SSO Settings**, and paste the **Metadata auto conf url** you copied above. + +![](/assets/images/onelogin-enable-saml.png) -- Log in to the Device42 Appliance Manager, `https://yourdevice42address:4343`, go to **SAML/SSO settings** on the left, and set the **Metadata auto conf url** you obtained above. +Once saved, the SAML integration is complete. You now need to add users to the SAML Connector App so they can log in to Device42 via their OneLogin accounts. - ![](/assets/images/onelogin-enable-saml.png) +### Create a User in OneLogin -After this has been saved, the SAML integration should be complete. You now need to add users to the `SAML Connector App` so they can log in to Device42 via their OneLogin accounts. +Navigate to **Users > Users** and click **New User**. -### Creating a User in OneLogin +![](/assets/images/D42-26961_onelogin_user_1.jpg) -- Go to **Users > Users**. -- Click **New User**. +Fill in the user form. The username must match the username in Device42. - ![](/assets/images/D42-26961_onelogin_user_1.jpg) +![](/assets/images/D42-26961_onelogin_user_2.jpg) -- Fill in the form. **The username should match the username in the Device42 app**. +Click **Save**. - ![](/assets/images/D42-26961_onelogin_user_2.jpg) +### Add a User to the Application -- Click **Save**. +1. Click the username. -### Adding a User to the Application +2. Go to the **Applications** tab and add an application by clicking the **plus icon**. -1. Click on the username. - -2. Go to the **Applications** tab and add an **Application** by clicking on the **plus icon**. - ![](/assets/images/D42-26961_user_configuration_1.jpg) - Select the SAML Custom Application created above. @@ -213,18 +207,18 @@ After this has been saved, the SAML integration should be complete. You now need ![](/assets/images/D42-26961_user_configuration_2.jpg) - Click **Continue**. - - Make sure the **Allow the user to sign in** checkbox is selected. + - Make sure the **Allow the user to sign in** checkbox is selected. ![](/assets/images/D42-26961_user_configuration_3.jpg) - Click **Save**. -Now you can log in to Device42 using the OneLogin account. +The user can now log in to Device42 using their OneLogin account. -## Device42 Appliance Manager Configuration +## Configure the Device42 Appliance Manager -Log in to Device42 Appliance Manager, `https://yourdevice42address:4343`, go to the **SAML 2.0 Settings** on the left, and set the **Metadata auto conf url** you obtained above. Set the **Username field** to match the value you saved in the SAML configuration. +Log in to the Device42 Appliance Manager at `https://:4343`, go to **SAML 2.0 Settings**, and set the **Metadata auto conf url** you obtained from your identity provider. Set the **Username field** to match the value saved in your SAML configuration. ![](/assets/images/onelogin-enable-saml.png) -After this has been saved, SAML integration should be complete! +Once saved, SAML integration is complete. diff --git a/docs/administration/setting-time-zone-and-ntp.mdx b/docs/administration/setting-time-zone-and-ntp.mdx index 65bc30a94..468f4e0a7 100644 --- a/docs/administration/setting-time-zone-and-ntp.mdx +++ b/docs/administration/setting-time-zone-and-ntp.mdx @@ -1,18 +1,18 @@ --- -title: "Setting Time Zone and NTP" +title: "Set Time Zone and NTP" sidebar_position: 14 --- import ThemedImage from '@theme/ThemedImage' import useBaseUrl from '@docusaurus/useBaseUrl' -Here is a brief run-down on setting or changing your time zone in Device42. This is probably one of the first steps you should take so that autodiscovery scheduling and log history work correctly. The virtual appliance takes the clock from the virtual host, so make sure the time is correct on the host. It's also a good idea to set up an NTP time source to ensure the time stays correct. +Configuring the correct time zone and NTP source in Device42 ensures that discovery scheduling and log history work correctly. The virtual appliance takes its clock from the virtual host, so make sure the time is correct on the host before proceeding. -## Set the Time Zone +This page covers how to set the time zone via the Device42 UI and how to configure OS-level time and NTP settings via the console. -In the Device42 main menu, go to **Tools > Settings > Time Settings**. +## Set the Time Zone -Here, you can select the correct time zone for your location and click **Apply**. +In the Device42 main menu, go to **Tools > Settings > Time Settings**. Select the correct time zone for your location and click **Apply**. -## OS-Level Time Settings +## Configure OS-Level Time Settings -After you've selected the correct new time zone and received confirmation that it has been applied, go to the Device42 console and restart the Device42 application. When it restarts, the console menu will show the new time zone. +After selecting the new time zone and receiving confirmation that it has been applied, go to the Device42 console and select **Restart Services**. When the services restart, the console menu will show the new time zone. -- Use the VM console menu options, **NTP Settings** and **Set Timezone**, to set time at the OS level. +Use the VM console menu options **NTP Settings** and **Set Timezone** to set the time at the OS level. - ![NTP and Time Zone settings d42 Console](/assets/images/setting-time-zone-and-ntp/console-main-menu.png) +![NTP and Time Zone settings in D42 Console](/assets/images/setting-time-zone-and-ntp/console-main-menu.png) -- Select **NTP Settings** from the main menu and enter the IP or FQDN of the NTP server. Toggle on the **Daily sync** option to add the NTP server to the daily scheduled jobs. +Select **NTP Settings** from the main menu and enter the IP address or FQDN of the NTP server. Enable the **Daily sync** option to add the NTP server to the daily scheduled jobs. - ![Configure new NTP Server ](/assets/images/setting-time-zone-and-ntp/console-ntp-settings.png) +![Configure new NTP Server](/assets/images/setting-time-zone-and-ntp/console-ntp-settings.png) -- Go back to the main menu and select **Set Timezone** to set the time zone on the OS level. If you don't see your exact location, choose the location closest to you: +Return to the main menu and select **Set Timezone** to set the time zone at the OS level. If your exact location is not listed, choose the nearest location. - ![Update OS TZ from D42 console](/assets/images/setting-time-zone-and-ntp/console-set-timezone.png) +![Update OS time zone from D42 console](/assets/images/setting-time-zone-and-ntp/console-set-timezone.png) -- Select **Restart Services** for the new time zone settings to take effect immediately. +Select **Restart Services** for the new time zone settings to take effect immediately. - ![Update OS TZ from D42 console](/assets/images/setting-time-zone-and-ntp/console-restart-services.png) +![Restart services in D42 console](/assets/images/setting-time-zone-and-ntp/console-restart-services.png) diff --git a/docs/administration/tags.mdx b/docs/administration/tags.mdx index 810cf7e3c..fbf70ee31 100644 --- a/docs/administration/tags.mdx +++ b/docs/administration/tags.mdx @@ -6,7 +6,7 @@ sidebar_position: 15 import ThemedImage from '@theme/ThemedImage' import useBaseUrl from '@docusaurus/useBaseUrl' -Tags are useful for filtering and grouping objects. For example, you could define a "Project X" tag and associate that tag with all the devices, IP addresses, and other items associated with Project X. +Tags let you filter and group objects in Device42 — for example, you can define a "Project X" tag and associate it with all the devices, IP addresses, and other items related to that project. This page covers how to create, edit, merge, and remove tags. Main objects in Device42 can be tagged, such as Software Components, Assets, and Devices, but not lower-order related objects like Vendor or User. @@ -22,11 +22,9 @@ Navigate to the Tags list page under **Infrastructure > Organization > Tags** to ## Create Tags -Click the **Create** button on the Tags list page. You can also create tags using the **Tags** field on discovery job configuration pages. +Click the **Create** button on the Tags list page. You can also create tags directly from an object or a discovery job configuration page using the **Tags** field. -Tag names can contain spaces. The **Slug** is a unique resource identifier for each tag and is automatically filled in. - -You can also create new tags directly from an object or an autodiscovery job configuration page, under the **Tags** field. +Tag names can contain spaces. The **Slug** is a unique resource identifier for each tag and is filled in automatically. -- You can also use the basic **Tagged Object Count #** filter to find tags that are **Equal to** `0`. - +- **Basic filter:** Use the **Tagged Object Count #** filter and set it to **Equal to** `0`. + -- Another option is to use the **Advanced** query filter to find tags with a `tagged_object_count` of `0`. - +- **Advanced filter:** Use the **Advanced** query filter to find tags with a `tagged_object_count` of `0`. + -Then, select the tags with a count of `0` and choose **Delete with Detailed Confirmation** or **Fast Background Delete** from the **Action** dropdown. +Select the tags with a count of `0` and choose **Delete with Detailed Confirmation** or **Fast Background Delete** from the **Action** dropdown. Templates & Bulk Operations > Transfer Between Locations**. +Navigate to the Transfers list page under **Tools > Templates & Bulk Operations > Transfer Between Locations**. Templates & Bulk Operations }} /> -The list view shows all pending and completed transfers. For each transfer, you can see the user who initiated the transfer, as well as the devices, assets, PDUs, and parts that are being transferred. +The list view shows all pending and completed transfers, including the user who initiated each transfer and the devices, assets, PDUs, and parts being transferred. -To initiate a transfer, fill in the form: +Fill in the transfer form with the following details: -- Select the **Initiation Date** and **Time** that the transfer will start. -- Upon saving, the **User** field will be populated automatically with the currently logged-in Device42 user. +- Select the **Initiation Date** and **Time** for the transfer. +- The **User** field is populated automatically with the currently logged-in Device42 user on saving. - Optionally, select or add the **Shipper** performing the transfer. -- Optionally, pick a room for the object while it is in transit. For example, you might want to define a dummy room named "In Transit". +- Optionally, select a room for the object while it is in transit — for example, a placeholder room named "In Transit". - Choose or add the **Devices**, **Assets**, **PDUs**, and **Parts** to be transferred. -- Add any useful **Notes** about the transfer for reference. +- Add any **Notes** about the transfer for reference. -Then, click **Save and add another** or click **Save** to view a summary of the transfer details. +Click **Save and add another** or **Save** to view a summary of the transfer details. -The **Transfer Devices Status** section will be populated with the object(s) you just selected. The **Transfer Assets Status**, **Transfer PDUs Status**, and **Transfer Parts Status** sections will also be populated. +The **Transfer Devices Status** section will be populated with the objects you selected. The **Transfer Assets Status**, **Transfer PDUs Status**, and **Transfer Parts Status** sections will also be populated. ## Receive the Transfer -In each section of the transfer, there is a **Received Date** entry and a **Receipt Room** entry that the receiving party will use to record full or partial completion of the transfer. +Each section of the transfer includes a **Received Date** and **Receipt Room** field for the receiving party to record full or partial completion. -Click **Edit** and add or update the **Received Date** and **Receipt Room**. On saving the changes, the devices, assets, PDUs, and parts will be placed in the **Receipt Room** in Device42. +Click **Edit** and update the **Received Date** and **Receipt Room**. On saving, the devices, assets, PDUs, and parts will be placed in the **Receipt Room** in Device42. Backup Now** and select the **Main Appliance** checkbox. If you want to include users and settings, select the **Backup Meta Data** option. **Run** the backup. -For an explanation of the backup options, see the [Backup via the Appliance Manager](appliance-manager/setting-up-backup-device42-appliance-manager.mdx) page. +For an explanation of the backup options, see the [Backup via the Appliance Manager](/administration/appliance-manager/setting-up-backup-device42-appliance-manager) page. ![Backup settings on the Appliance Manager](/assets/images/updating-device42/backup-appliance-19.06.png) ### 3. Upload the Update File -From the Main Appliance, navigate to **Application > Update Software** and **either** browse and upload the [`.zip.enc` file](#obtain-the-update-file-or-url) **or** enter the update URL. +From the Main Appliance, navigate to **Application > Update Software** and **either** browse and upload the `.zip.enc` file **or** enter the update URL. ![Upload file or enter URL in the Appliance Manager](/assets/images/updating-device42/upload-file-19.06.png) @@ -109,12 +109,12 @@ sources={{ }} /> -## Updating the Remote Collectors +## Update the Remote Collectors Device42 RCs are updated automatically as long as they are connected to a Device42 MA. Updates to the MA instance include updates to your RC(s), which are pushed out automatically as part of the regular Device42 update process. By keeping your main Device42 instance up to date, you ensure that your RCs are also up to date. -## Migrating Existing Power Appliance Jobs to a Remote Collector +## Migrate Existing Power Appliance Jobs to a Remote Collector -It is possible to use existing tools to migrate jobs that were created for the original, standalone power appliance to RCs. +You can use existing tools to migrate jobs that were created for the original, standalone power appliance to RCs. -Follow the [Power Job Migration Guide](/infrastructure-management/power-and-environmental-monitoring/power-rc-setup-job-migration.mdx) to migrate jobs to your choice of RC(s). +Follow the [Power Job Migration Guide](/infrastructure-management/power-and-environmental-monitoring/power-rc-setup-job-migration) to migrate jobs to your choice of RCs.