Skip to content

Commit

Permalink
Merge pull request #213 from zerotier/aaronjohnson-patch-1-expanding-…
Browse files Browse the repository at this point in the history
…powershell-examples

Update examples.md to include Powershell for each example
  • Loading branch information
aaronjohnson authored Oct 23, 2024
2 parents 0f37424 + d5db8b1 commit 7261b22
Showing 1 changed file with 87 additions and 11 deletions.
98 changes: 87 additions & 11 deletions docs/api/central/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ In the examples below use the following placeholder variables to match commonly-
- `$ZT_TOKEN`: an API token associated with an active account on [Central](https://my.zerotier.com)
- `$NWID`: an active network ID

Please note, if you encounter an error, System.String and System.Collections.IDictionary when using curl within Powershell, be advised this is because of an _alias_ which can leads to a less than obvious error message. `curl` in PowerShell is a wrapper for `Invoke-WebRequest` which has different parameter syntax than `curl` on non-windows operating systems. As an alternative solution to using `Invoke-WebRequest`, `curl.exe` could be used. This however may not be available on your system without first installing. The _native_ approach is to use `Invoke-WebRequest`. Caveat emptor.

:::info
See the [Central API Tokens](/api/tokens) guide for an explanation of how to create and manage API tokens.
:::
Expand All @@ -34,7 +36,7 @@ Each of them will fetch network information and produce CSV as output. You can t

<TabItem value="list-networks">

### List current networks
### List current networks ( shell curl )

```sh
curl -s -H "Authorization: token $ZT_TOKEN" \
Expand All @@ -51,11 +53,39 @@ curl -s -H "Authorization: token $ZT_TOKEN" \
| jq -rs '.[] | @csv'
```

### List current networks ( Powershell Invoke-WebRequest )

```code
$ZT_TOKEN = "your_zerotier_token_here"
$headers = @{
"Authorization" = "token $ZT_TOKEN"
}
$response = Invoke-WebRequest -Uri "https://api.zerotier.com/api/v1/network" -Headers $headers
$networks = $response.Content | ConvertFrom-Json
$result = $networks | ForEach-Object {
[PSCustomObject]@{
id = $_.id
name = $_.config.name
description = $_.config.description
totalMemberCount = $_.totalMemberCount
creationTime = $_.config.creationTime
ipRangeStart = $_.config.ipAssignmentPools[0].ipRangeStart
ipRangeEnd = $_.config.ipAssignmentPools[0].ipRangeEnd
}
} | ConvertTo-Csv -NoTypeInformation
$result | ForEach-Object { $_ -replace '"', '' }
```

</TabItem>

<TabItem value="list-members">

### List network members
### List network members ( shell curl )

```sh
curl -H "Authorization: token $ZT_TOKEN" \
Expand All @@ -70,6 +100,35 @@ curl -H "Authorization: token $ZT_TOKEN" \
| jq -rs '.[] | @csv
```
### List network members ( Powershell Invoke-WebRequest )
```code
$ZT_TOKEN = "your_zerotier_token_here"
$NWID = "your_network_id_here"
$headers = @{
"Authorization" = "token $ZT_TOKEN"
}
$response = Invoke-WebRequest -Uri "https://api.zerotier.com/api/v1/network/$NWID/member" -Headers $headers
$members = $response.Content | ConvertFrom-Json
$result = $members | ForEach-Object {
[PSCustomObject]@{
id = $_.id
lastSeen = $_.lastSeen
physicalAddress = $_.physicalAddress
ipAssignment = $_.ipAssignments[0]
name = $_.name
}
} | ConvertTo-Csv -NoTypeInformation
$result | ForEach-Object { $_ -replace '"', '' }
```
If you want to save the output to a file, you can add `| Out-File -FilePath "output.csv"` at the end of the script.
</TabItem>
</Tabs>
Expand All @@ -86,21 +145,40 @@ curl -H "Authorization: token $ZT_TOKEN" \
<TabItem value="authorize-member">
### Authorize a network member
### Authorize a network member ( shell curl )
```sh
curl -H "Authorization: token $ZT_TOKEN" -X POST \
"https://api.zerotier.com/api/v1/network/$NWID/member/$MEMBER_ID" \
--data '{"config": {"authorized": true}}'
```
### Authorize a network member ( Powershell Invoke-WebRequest )
```code
$ZT_TOKEN = "your_zerotier_token_here"
$NWID = "your_network_id_here"
$MEMBER_ID = "your_member_id_here"
$headers = @{
"Authorization" = "token $ZT_TOKEN"
}
$body = @{
config = @{
authorized = $true
}
} | ConvertTo-Json
Invoke-WebRequest -Uri "https://api.zerotier.com/api/v1/network/$NWID/member/$MEMBER_ID" `
-Method Post -Headers $headers -Body $body -ContentType "application/json"
```
</TabItem>
<TabItem value="deauthorize-member">
### Deauthorize a network member ( shell )
curl on Unix
### Deauthorize a network member ( shell curl )
```sh
curl -H "Authorization: token $ZT_TOKEN" -X POST \
Expand All @@ -111,9 +189,9 @@ curl -H "Authorization: token $ZT_TOKEN" -X POST \
### Deauthorize a network member ( Powershell Invoke-WebRequest )
```code
$ZT_TOKEN = ""
$NWID = ""
$MEMBER_ID = ""
$ZT_TOKEN = "your_zerotier_token_here"
$NWID = "your_network_id_here"
$MEMBER_ID = "your_member_id_here"
$headers = @{
"Authorization" = "token $ZT_TOKEN"
Expand All @@ -129,8 +207,6 @@ Invoke-WebRequest -Uri "https://api.zerotier.com/api/v1/network/$NWID/member/$ME
-Method Post -Headers $headers -Body $body -ContentType "application/json"
```
Please note, if you encounter an error, System.String and System.Collections.IDictionary when using curl within Powershell, be advised this is an _alias_ which can lead to confusion because it is a wrapper for Invoke-WebRequest which has different parameter syntax than curl on non-windows operating systems. As an alternative solution, curl.exe can be used, however may not be available on your system. Caveat emptor.
</TabItem>
</Tabs>

0 comments on commit 7261b22

Please sign in to comment.