Skip to content

Commit 953efeb

Browse files
nlowreydufournlowreydufour
committed
Add new N-Central REST API setup docs
1 parent ac674d8 commit 953efeb

7 files changed

+126
-30
lines changed

‎.vitepress/images/ncentraldocs/add_automation_policy_1.png

273 KB
Loading

‎.vitepress/images/ncentraldocs/add_automation_policy_2.png

22.2 KB
Loading

‎.vitepress/images/ncentraldocs/add_automation_policy_3.png

70 KB
Loading

‎.vitepress/images/ncentraldocs/add_integration_guide_new_1.png

112 KB
Loading

‎.vitepress/images/ncentraldocs/new_add_user_guide_1.png

150 KB
Loading

‎ncentral-integration-setup.md

Lines changed: 42 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
1-
# N-Central Integration
1+
::: info
2+
This page is now dedicated to the new N-Central integration, utilizing the new N-Central REST API & ImmyBot Dynamic Integrations.
23

3-
Setting up this integration allows you to
4+
This new integration should provide improved stability over our classic (and soon to be deprecated) integration.
5+
6+
Looking for the classic N-Central integration guide?
7+
We recommend against it, but here is [the classic setup guide](/old-ncentral-integration-setup.html).
8+
:::
9+
# N-Central REST API Dynamic Integration
10+
11+
Setting up this integration allows you to:
412
1. Import customers from N-Central
513
2. Import computers from N-Central
614
3. Manage all computers in N-Central without deploying the ImmyBot Agent
@@ -12,49 +20,53 @@ ImmyBot currently requires the following role permissions to operate correctly:
1220
### Devices
1321
- Devices View
1422
- All Devices -> Read Only
15-
- Direct Support
16-
- Command Prompt -> Manage
17-
- File System -> Manage
18-
- Remote Control
19-
- Custom -> Manage
20-
- Take Control -> Manage
21-
- Network Devices
22-
- Add/Import Devices -> Manage
23-
- Edit Device Settings -> Manage
23+
- Scheduled Tasks
24+
- Scheduled Tasks -> Manage
2425

2526
Create an "ImmyBot" role in your N-Central instance using above roles.
2627
![](./.vitepress/images/ncentraldocs/add_userrole_guide_1.png)
2728

28-
![](https://github.com/immense/immybot-documentation/assets/31077619/0e76619f-31af-4869-a9ac-78a221614aa9)
29+
![](./.vitepress/images/ncentraldocs/new_add_user_guide_1.png)
30+
31+
32+
## Create an API-Only ImmyBot user in N-Central
2933

34+
N-Able themselves have an [offical short guide for doing this we recommend following](https://documentation.n-able.com/N-central/userguide/Content/User_Management/Role%20Based%20Permissions/role_based_permissions_create_APIuser.htm) for this part, but here is a recap:
3035

31-
## Create ImmyBot user in N-Central
36+
1. Create a new "ImmyBot" user in the instance with the "ImmyBot" role applied.
37+
2. Under "API Access", ensure "Api-Only User" is checked. <u>2FA MUST be disabled for the API User!</u>
38+
3. Save the new ImmyBot user, and press the "Generate JSON Web Token" button. Copy this value somewhere for later.
3239

33-
Create a new "ImmyBot" user in the instance with the "ImmyBot" role applied.
34-
![](./.vitepress/images/ncentraldocs/add_user_guide_1.png)
35-
![](./.vitepress/images/ncentraldocs/add_userrole_guide_2.png)
3640

37-
## Login to the new ImmyBot user to get MFA code and accept EULA
41+
## Add the necessary 'RunScript' Automation Policy
3842

39-
Once you have created the new ImmyBot user account, you must attempt to login
40-
so that you may retrieve the MFA key, and complete any initial setup.
41-
After entering the accounts email and password, there will be a MFA QR code displayed.
42-
You MUST press the "CAN'T SCAN IT?" button to get the Base32-encoded MFA key.
43-
After saving the key, use [a site such as this](https://totp.danhersam.com/?period=30&digits=6) to get the current token from the key, or temporarily scan the QR code on a device to complete sign-in.
44-
![](./.vitepress/images/ncentraldocs/login_mfa_guide_1.png)
45-
::: tip
46-
Make sure you accept the EULA when you login, otherwise the computers will not import!
43+
After completing the new API-Only user setup, it's time time add an Automation Policy to N-Central so Immybot can
44+
run scripts on the machines.
45+
46+
First, navigate to the "Script/Software Repository" under "Schedules Tasks" beneath the "Configuration" tab in N-Central.
47+
Once at the Script Repository page, select "Add" -> "Automation Policy".
48+
![](./.vitepress/images/ncentraldocs/add_automation_policy_1.png)
49+
50+
Second, [download the ImmyBot RunScript Automation Policy](https://immybot.blob.core.windows.net/public-media/new-ncentral-rest-integration-files/ImmyBotRunScript.amp) and upload it to your instance. Fill out the Name and Description how you see fit if required.
51+
![](./.vitepress/images/ncentraldocs/add_automation_policy_2.png)
52+
53+
Last step is to ensure this new automation policy we have uploaded is able to be invoked by the Immybot API User.
54+
Find the automation by searching for "Immybot", then flipping the `Enable API` switch. Accept the confirmation modal, then copy the `Repository ID` for later use.
55+
::: warning Make sure you copy YOUR `Repository ID`, as this identifier for the automation policy will be unique across every N-Central instance!
4756
:::
57+
![](./.vitepress/images/ncentraldocs/add_automation_policy_3.png)
4858

4959
## Add integration for N-Central
5060

5161
After completing setup in N-Central, it's time to add the integration to ImmyBot.
52-
Navigate to the "Integrations" page in ImmyBot, and create a new "N-Central" integration.
53-
Input all the N-Central user account data to the fields on the right.
54-
![](./.vitepress/images/ncentraldocs/add_integration_guide_1.png)
55-
![](./.vitepress/images/ncentraldocs/add_integration_guide_2.png)
62+
Navigate to the "Integrations" page in ImmyBot, and create a new `N-Central v2` integration.
63+
Input a name you'd like for the integration, followed by your N-Central server URL, and the `JWT` you copied in the steps to make an "ImmyBot" API user.
64+
Then, input the `RepositoryId` gathered from the step before.
65+
Lastly, flip the `Enable Integration` switch.
5666

57-
Press the "Verify Credentials" button, then, if completed successfully, press the button again to save the integration.
67+
::: warning If the `Health Check` reports an error after enabling the integration, ensure you have completed the above steps correctly. If you continue to have issues, reachout to the community or support for assistance.
68+
:::
69+
![](./.vitepress/images/ncentraldocs/add_integration_guide_new_1.png)
5870

5971
## Import your customers
6072

‎old-ncentral-integration-setup.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
::: warning
2+
This classic N-Central integration is soon to be deprecated and not recommended for further use.
3+
It is unlikely to receive further updates.
4+
5+
Please migrate to the [New N-Central REST API Integration](/ncentral-integration-setup.html)
6+
:::
7+
# N-Central Integration
8+
9+
Setting up this integration allows you to
10+
1. Import customers from N-Central
11+
2. Import computers from N-Central
12+
3. Manage all computers in N-Central without deploying the ImmyBot Agent
13+
14+
## Create ImmyBot Role in N-Central
15+
16+
ImmyBot currently requires the following role permissions to operate correctly:
17+
18+
### Devices
19+
- Devices View
20+
- All Devices -> Read Only
21+
- Direct Support
22+
- Command Prompt -> Manage
23+
- File System -> Manage
24+
- Remote Control
25+
- Custom -> Manage
26+
- Take Control -> Manage
27+
- Network Devices
28+
- Add/Import Devices -> Manage
29+
- Edit Device Settings -> Manage
30+
31+
Create an "ImmyBot" role in your N-Central instance using above roles.
32+
![](./.vitepress/images/ncentraldocs/add_userrole_guide_1.png)
33+
34+
![](https://github.com/immense/immybot-documentation/assets/31077619/0e76619f-31af-4869-a9ac-78a221614aa9)
35+
36+
37+
## Create ImmyBot user in N-Central
38+
39+
Create a new "ImmyBot" user in the instance with the "ImmyBot" role applied.
40+
![](./.vitepress/images/ncentraldocs/add_user_guide_1.png)
41+
![](./.vitepress/images/ncentraldocs/add_userrole_guide_2.png)
42+
43+
## Login to the new ImmyBot user to get MFA code and accept EULA
44+
45+
Once you have created the new ImmyBot user account, you must attempt to login
46+
so that you may retrieve the MFA key, and complete any initial setup.
47+
After entering the accounts email and password, there will be a MFA QR code displayed.
48+
You MUST press the "CAN'T SCAN IT?" button to get the Base32-encoded MFA key.
49+
After saving the key, use [a site such as this](https://totp.danhersam.com/?period=30&digits=6) to get the current token from the key, or temporarily scan the QR code on a device to complete sign-in.
50+
![](./.vitepress/images/ncentraldocs/login_mfa_guide_1.png)
51+
::: tip
52+
Make sure you accept the EULA when you login, otherwise the computers will not import!
53+
:::
54+
55+
## Add integration for N-Central
56+
57+
After completing setup in N-Central, it's time to add the integration to ImmyBot.
58+
Navigate to the "Integrations" page in ImmyBot, and create a new "N-Central" integration.
59+
Input all the N-Central user account data to the fields on the right.
60+
![](./.vitepress/images/ncentraldocs/add_integration_guide_1.png)
61+
![](./.vitepress/images/ncentraldocs/add_integration_guide_2.png)
62+
63+
Press the "Verify Credentials" button, then, if completed successfully, press the button again to save the integration.
64+
65+
## Import your customers
66+
67+
![](./.vitepress/images/2021-03-23-18-57-19.png)
68+
69+
![](./.vitepress/images/2021-03-23-19-01-36.png)
70+
71+
Alternatively, you can create/map only certain customers.
72+
73+
When you map a customer from an RMM, the computers will undergo Identification
74+
75+
![](./.vitepress/images/2021-03-23-19-03-33.png)
76+
77+
![](./.vitepress/images/2021-03-23-19-06-55.png)
78+
79+
![](./.vitepress/images/2021-03-23-19-08-30.png)
80+
81+
## Troubleshooting
82+
83+
### My customers are showing up but no computers
84+
Login to N-Central as the ImmyBot User and accept the EULA

0 commit comments

Comments
 (0)