Skip to content

Commit 005efc0

Browse files
Court72Court72
authored
Merge pull request #235412 from kellydevens/patch-42
Update prepare-network.md
2 parents 284b316 + daccd0c commit 005efc0

File tree

1 file changed

+31
-26
lines changed

1 file changed

+31
-26
lines changed

‎articles/orbital/prepare-network.md

Lines changed: 31 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,9 @@ Ensure the objects comply with the recommendations in this article. Note that th
1818
## Prepare subnet for VNET injection
1919

2020
Prerequisites:
21-
- An entire subnet with no existing IPs allocated or in use that can be dedicated to the Azure Orbital Ground Station service in your virtual network in your resource group.
21+
- An entire subnet with no existing IPs allocated or in use that can be dedicated to the Azure Orbital Ground Station service in your virtual network within your resource group.
2222

23-
Steps:
24-
1. Delegate a subnet to service named: Microsoft.Orbital/orbitalGateways. Follow instructions here: [Add or remove a subnet delegation in an Azure virtual network](../virtual-network/manage-subnet-delegation.md).
23+
Delegate a subnet to service named: Microsoft.Orbital/orbitalGateways. Follow instructions here: [Add or remove a subnet delegation in an Azure virtual network](../virtual-network/manage-subnet-delegation.md).
2524

2625
> [!NOTE]
2726
> Address range needs to be at least /24 (e.g., 10.0.0.0/23)
@@ -34,29 +33,31 @@ The following is an example of a typical VNET setup with a subnet delegated to A
3433

3534
Set the MTU of all desired endpoints to at least 3650.
3635

37-
## Setting up the contact profile
36+
## Set up the contact profile
3837

3938
Prerequisites:
4039
- The subnet/vnet is in the same region as the contact profile.
4140

4241
Ensure the contact profile properties are set as follows:
4342

44-
| Property | Setting |
43+
| **Property** | **Setting** |
4544
|----------|---------|
46-
| subnetId | Enter the full ID to the delegated subnet, which can be found inside the VNET's JSON view. subnetID is found under networkConfiguration. |
47-
| ipAddress | For each link, enter an IP for TCP/UDP server mode. Leave blank for TCP/UDP client mode. See section below for a detailed explanation on configuring this property. |
48-
| port | For each link, post must be within 49152 and 65535 range and must be unique across all links in the contact profile.|
45+
| subnetId | Enter the **full ID to the delegated subnet**, which can be found inside the VNET's JSON view. subnetID is found under networkConfiguration. |
46+
| ipAddress | For each link, enter an **IP for TCP/UDP server mode**. Leave blank for TCP/UDP client mode. See section below for a detailed explanation on configuring this property. |
47+
| port | For each link, port must be within 49152 and 65535 range and must be unique across all links in the contact profile. |
4948

5049
> [!NOTE]
5150
> You can have multiple links/channels in a contact profile, and you can have multiple IPs. But the combination of port/protocol must be unique. You cannot have two identical ports, even if you have two different destination IPs.
5251
53-
## Scheduling the contact
52+
For more information, learn about [contact profiles](https://learn.microsoft.com/azure/orbital/concepts-contact-profile) and [how to configure a contact profile](https://learn.microsoft.com/azure/orbital/contact-profile).
5453

55-
The platform pre-reserves IPs in the subnet when the contact is scheduled. These IPs represent the platform side endpoints for each link. IPs will be unique between contacts, and if multiple concurrent contacts are using the same subnet, Microsoft guarantees those IPs to be distinct. The service will fail to schedule the contact and an error will be returned if the service runs out of IPs or cannot allocate an IP.
54+
## Schedule the contact
55+
56+
The Azure Orbital Ground Station platform pre-reserves IPs in the subnet when a contact is scheduled. These IPs represent the platform side endpoints for each link. IPs will be unique between contacts, and if multiple concurrent contacts are using the same subnet, Microsoft guarantees those IPs to be distinct. The service will fail to schedule the contact and an error will be returned if the service runs out of IPs or cannot allocate an IP.
5657

5758
When you create a contact, you can find these IPs by viewing the contact properties. Select JSON view in the portal or use the GET contact API call to view the contact properties. Make sure to use the current API version of 2022-03-01. The parameters of interest are below:
5859

59-
| Parameter | Usage |
60+
| **Parameter** | **Usage** |
6061
|------------------------------------|----------------------------------------------------------------------------|
6162
| antennaConfiguration.destinationIP | Connect to this IP when you configure the link as tcp/udp client. |
6263
| antennaConfiguration.sourceIps | Data will come from this IP when you configure the link as tcp/udp server. |
@@ -70,32 +71,36 @@ You can use this information to set up network policies or to distinguish betwee
7071
> - Only one destination IP is present. Any link in client mode should connect to this IP and the links are differentiated based on port.
7172
> - Many source IPs can be present. Links in server mode will connect to your specified IP address in the contact profile. The flows will originate from the source IPs present in this field and target the port as per the link details in the contact profile. There is no fixed assignment of link to source IP so please make sure to allow all IPs in any networking setup or firewalls.
7273
74+
For more information, learn about [contacts](https://learn.microsoft.com/azure/orbital/concepts-contact) and [how to schedule a contact](https://learn.microsoft.com/azure/orbital/schedule-contact).
7375

7476
## Client/Server, TCP/UDP, and link direction
7577

76-
The following sections describe how to set up the link flows based on direction on tcp or udp preference.
78+
The following sections describe how to set up the link flows based on direction on TCP or UDP preference.
79+
80+
> [!NOTE]
81+
> These settings are for managed modems only.
7782
7883
### Uplink
7984

80-
| Setting | TCP Client | TCP Server | UDP Client | UDP Server |
81-
|--------------------------------|----------------------------|--------------------------------------|----------------------------|--------------------------------------|
82-
| Contact Profile Link ipAddress | Blank | Routable IP from delegated subnet | Blank | Not applicable |
83-
| Contact Profile Link port | Unique port in 49152-65535 | Unique port in 49152-65535 | Unique port in 49152-65535 | Not applicable |
84-
| **Output** | | | | |
85-
| Contact Object destinationIP | Connect to this IP | Not applicable | Connect to this IP | Not applicable |
86-
| Contact Object sourceIP | Not applicable | Link will come from one of these IPs | Not applicable | Not applicable |
85+
| Setting | TCP Client | TCP Server | UDP Client | UDP Server |
86+
|:-------------------------------|:---------------------------|:-------------------------------------|:---------------------------|:---------------------------------|
87+
| _Contact Profile Link ipAddress_ | Blank | Routable IP from delegated subnet | Blank | Not applicable |
88+
| _Contact Profile Link port_ | Unique port in 49152-65535 | Unique port in 49152-65535 | Unique port in 49152-65535 | Not applicable |
89+
| **Output** | | | | |
90+
| _Contact Object destinationIP_ | Connect to this IP | Not applicable | Connect to this IP | Not applicable |
91+
| _Contact Object sourceIP_ | Not applicable | Link will come from one of these IPs | Not applicable | Not applicable |
8792

8893

8994

9095
### Downlink
9196

92-
| Setting | TCP Client | TCP Server | UDP Client | UDP Server |
93-
|--------------------------------|----------------------------|--------------------------------------|----------------------------|--------------------------------------|
94-
| Contact Profile Link ipAddress | Blank | Routable IP from delegated subnet | Not applicable | Routable IP from delegated subnet |
95-
| Contact Profile Link port | Unique port in 49152-65535 | Unique port in 49152-65535 | Not applicable | Unique port in 49152-65535 |
96-
| **Output** | | | | |
97-
| Contact Object destinationIP | Connect to this IP | Not applicable | Not applicable | Not applicable |
98-
| Contact Object sourceIP | Not applicable | Link will come from one of these IPs | Not applicable | Link will come from one of these IPs |
97+
| Setting | TCP Client | TCP Server | UDP Client | UDP Server |
98+
|:-------------------------------|:---------------------------|:-------------------------------------|:---------------------------|:---------------------------------|
99+
| _Contact Profile Link ipAddress_ | Blank | Routable IP from delegated subnet | Not applicable | Routable IP from delegated subnet
100+
| _Contact Profile Link port_ | Unique port in 49152-65535 | Unique port in 49152-65535 | Not applicable | Unique port in 49152-65535 |
101+
| **Output** | | | | |
102+
| _Contact Object destinationIP_ | Connect to this IP | Not applicable | Not applicable | Not applicable |
103+
| _Contact Object sourceIP_ | Not applicable | Link will come from one of these IPs | Not applicable | Link will come from one of these IPs |
99104

100105
## Next steps
101106

0 commit comments

Comments
 (0)