Skip to content

Commit 9c67acf

Browse files
authored
Merge pull request #223489 from yoninalmsft/HA-steps-fix
HA procedure update
2 parents 0a647f5 + 7136a6a commit 9c67acf

File tree

2 files changed

+57
-65
lines changed

2 files changed

+57
-65
lines changed

articles/defender-for-iot/organizations/how-to-set-up-high-availability.md

Lines changed: 57 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -37,113 +37,105 @@ During failover, sensors continue attempts to communicate with the primary appli
3737

3838
Sign back in to the primary appliance after redirection.
3939

40-
## High availability setup overview
40+
## Prerequisites
4141

42-
The installation and configuration procedures are performed in four main stages:
42+
Before you perform the procedures in this article, verify that you've met the following prerequisites:
4343

44-
1. Install an on-premises management console primary appliance.
44+
- Make sure that you have an [on-premises management console installed](/ot-deploy/install-software-on-premises-management-console.md) on both a primary appliance and a secondary appliance.
4545

46-
1. Configure the on-premises management console primary appliance. For example, scheduled backup settings, VLAN settings. For more information, see [Manage the on-premises management console](how-to-manage-the-on-premises-management-console.md). All settings are applied to the secondary appliance automatically after pairing.
46+
- Both your primary and secondary on-premises management console appliances must be running identical hardware models and software versions.
47+
- You must be able to access to both the primary and secondary on-premises management consoles as a [privileged user](references-work-with-defender-for-iot-cli-commands.md), for running CLI commands. For more information, see [On-premises users and roles for OT monitoring](roles-on-premises.md).
4748

48-
1. Install an on-premises management console secondary appliance. For more information, see [About the Defender for IoT Installation](how-to-install-software.md).
49+
- Make sure that the primary on-premises management console is fully [configured](how-to-manage-the-on-premises-management-console.md), including at least two [OT network sensors connected](how-to-manage-individual-sensors.md#connect-a-sensor-to-the-management-console) and visible in the console UI, and scheduled backups or VLAN settings. All settings are applied to the secondary appliance automatically after pairing.
4950

50-
1. Pair the primary and secondary on-premises management console appliances. The primary on-premises management console must manage at least two sensors in order to carry out the setup.
51+
- Make sure that your SSL/TLS certificates meet required criteria. For more information, see [Deploy OT appliance certificates](how-to-deploy-certificates.md).
5152

52-
For more information, see [Create the primary and secondary pair](#create-the-primary-and-secondary-pair).
53+
- Make sure that your organizational security policy grants you access to the following services, on the primary and secondary on-premises management console. These services also allow the connection between the sensors and secondary on-premises management console:
5354

54-
## High availability requirements
55-
56-
Verify that you've met the following high availability requirements:
57-
58-
- [Certificate requirements](how-to-manage-the-on-premises-management-console.md#manage-certificates)
59-
60-
- Software and hardware requirements
61-
62-
- Network access requirements
63-
64-
### Software and hardware requirements
65-
66-
- Both the primary and secondary on-premises management console appliances must be running identical hardware models and software versions.
67-
68-
- The high availability system can be set up by Defender for IoT users only, using CLI tools.
69-
70-
### Network access requirements
71-
72-
Verify if your organizational security policy allows you to have access to the following services, on the primary and secondary on-premises management console. These services also allow the connection between the sensors and secondary on-premises management console:
73-
74-
|Port|Service|Description|
75-
|----|-------|-----------|
76-
|**443 or TCP**|HTTPS|Grants access to the on-premises management console web console.|
77-
|**22 or TCP**|SSH|Syncs the data between the primary and secondary on-premises management console appliances|
78-
|**123 or UDP**|NTP| The on-premises management console's NTP time sync. Verify that the active and passive appliances are defined with the same timezone.|
55+
|Port|Service|Description|
56+
|----|-------|-----------|
57+
|**443 or TCP**|HTTPS|Grants access to the on-premises management console web console.|
58+
|**22 or TCP**|SSH|Syncs the data between the primary and secondary on-premises management console appliances|
59+
|**123 or UDP**|NTP| The on-premises management console's NTP time sync. Verify that the active and passive appliances are defined with the same timezone.|
7960

8061
## Create the primary and secondary pair
8162

82-
Verify that both the primary and secondary on-premises management console appliances are powered on before starting the procedure.
63+
> [!IMPORTANT]
64+
> Run commands with sudo only where indicated. If not indicated, do not run with sudo.
8365
84-
### On the primary
66+
1. Power on both the primary and secondary on-premises management console appliances.
8567

86-
1. Sign in to the management console.
68+
1. **On the secondary appliance**, use the following steps to copy the connection string to your clipboard:
8769

88-
1. Select **System Settings** from the side menu.
70+
1. Sign in to the secondary on-premises management console, and select **System Settings** on the left.
8971

90-
1. Copy the Connection String.
72+
1. In the **Sensor Setup - Connection String** area, under **Copy Connection String**, select the :::image type="icon" source="media/how-to-troubleshoot-the-sensor-and-on-premises-management-console/eye-icon.png" border="false"::: button to view the full connection string.
9173

92-
:::image type="content" source="../media/how-to-set-up-high-availability/connection-string.png" alt-text="Copy the connection string to use in the following command.":::
74+
1. The connection string is composed of the IP address and the token. The IP address is before the colon, and the token is after the colon. Copy the IP address and token separately. For example, if your connection string is ```172.10.246.232:a2c4gv9de23f56n078a44e12gf2ce77f```, copy the IP address ```172.10.246.232``` and the token ```a2c4gv9de23f56n078a44e12gf2ce77f``` separately.
9375

94-
1. Run the following command on the primary:
76+
:::image type="content" source="media/how-to-set-up-high-availability/copy-connection-string-second-part.png" alt-text="Screenshot showing to copy each part of the connection string to use in the following command." lightbox="media/how-to-set-up-high-availability/copy-connection-string-second-part.png":::
9577

96-
```bash
97-
sudo cyberx-management-trusted-hosts-add -ip <Secondary IP> -token <connection string>
98-
```
78+
1. **On the primary appliance**, use the following steps to connect the secondary appliance to the primary via CLI:
9979

80+
1. Sign in to the primary on-premises management console via SSH to access the CLI, and then run:
10081

101-
1. Enter the IP address of the secondary appliance in the ```<Secondary ip>``` field and select Enter. The IP address is then validated, and the SSL certificate is downloaded to the primary. Entering the IP address also associates the sensors to the secondary appliance.
82+
```bash
83+
sudo cyberx-management-trusted-hosts-add -ip <Secondary IP> -token <Secondary token>
84+
```
10285

103-
1. Run the following command on the primary to verify that the certificate is installed properly:
86+
where `<Secondary IP>` is the IP address of the secondary appliance and `<Secondary token>` is the second part of the connection string after the colon, which you'd copied to the clipboard earlier.
87+
88+
For example:
10489
105-
```bash
106-
sudo cyberx-management-trusted-hosts-apply
107-
```
90+
```sudo cyberx-management-trusted-hosts-add -ip 172.10.246.232 -token a2c4gv9de23f56n078a44e12gf2ce77f```
10891
109-
1. Run the following command on the primary. **Do not run with sudo.**
92+
The IP address is validated, the SSL/TLS certificate is downloaded to the primary appliance, and all sensors that are connected to the primary appliance are connected to the secondary appliance.
11093
111-
```bash
112-
cyberx-management-deploy-ssh-key <Secondary IP>
113-
```
94+
1. Apply your changes on the primary appliance. Run:
11495
115-
This allows the connection between the primary and secondary appliances for backup and restoration purposes between them.
96+
```bash
97+
sudo cyberx-management-trusted-hosts-apply
98+
```
99+
1. Verify that the certificate is installed correctly on the primary appliance. Run:
116100
117-
1. Enter the IP address of the secondary and select Enter.
101+
```bash
102+
cyberx-management-trusted-hosts-list
103+
```
118104
119-
### On the secondary
105+
1. Allow the connection between the primary and secondary appliances' backup and restore process:
120106

121-
1. Sign in to the CLI as a Defender for IoT user.
107+
- **On the primary appliance**, run:
108+
109+
```bash
110+
cyberx-management-deploy-ssh-key <secondary appliance IP address>
111+
```
112+
113+
- **On the secondary appliance**, sign in via SSH to access the CLI, and run:
122114

123-
1. Run the following command on the secondary. **Do not run with sudo**:
115+
```bash
116+
cyberx-management-deploy-ssh-key <primary appliance IP address>
117+
```
124118

119+
1. Verify that the changes have been applied on the secondary appliance. **On the secondary appliance**, run:
120+
125121
```bash
126-
cyberx-management-deploy-ssh-key <Primary ip>
122+
cyberx-management-trusted-hosts-list
127123
```
128124

129-
This allows the connection between the Primary and Secondary appliances for backup and restore purposes between them.
130-
131-
1. Enter the IP address of the primary and press Enter.
132-
133125
### Track high availability activity
134126

135127
The core application logs can be exported to the Defender for IoT support team to handle any high availability issues.
136128

137129
**To access the core logs**:
138130

139-
1. Select **Export** from the **System Settings** window.
131+
1. Sign into the on-premises management console and select **System Settings** > **Export**. For more information on exporting logs to send to the support team, see [Export logs from the on-premises management console for troubleshooting](how-to-troubleshoot-the-sensor-and-on-premises-management-console.md#export-logs-from-the-on-premises-management-console-for-troubleshooting).
140132

141133
## Update the on-premises management console with high availability
142134

143135
To update an on-premises management console that has high availability configured, you'll need to:
144136
145-
1. Disconnect the high availability from both the primary and secondary appliances.
146-
1. Update the appliances to the new version.
137+
1. Disconnect the high availability from both the primary and secondary appliances.
138+
1. Update the appliances to the new version.
147139
1. Reconfigure the high availability back onto both appliances.
148140
149141
Perform the update in the following order. Make sure each step is complete before you begin a new step.
@@ -162,7 +154,7 @@ Perform the update in the following order. Make sure each step is complete befor
162154
163155
1. Find the domain associated with the secondary appliance and copy it to your clipboard. For example:
164156
165-
:::image type="content" source="media/how-to-set-up-high-availability/update-high-availability-domain.jpg" alt-text="Screenshot showing the domain associated with the secondary appliance.":::
157+
:::image type="content" source="media/how-to-set-up-high-availability/update-high-availability-domain.jpg" alt-text="Screenshot showing the domain associated with the secondary appliance." lightbox="media/how-to-set-up-high-availability/update-high-availability-domain.jpg":::
166158
167159
1. Remove the secondary domain from the list of trusted hosts. Run:
168160
Loading

0 commit comments

Comments
 (0)