Delete targets by role
Last updated
This script demonstrates how to programmatically delete deployment targets with the specified role from the Octopus Server.
Usage
Provide values for the following:
- Octopus URL
- Octopus API Key
- Name of the space you want to use
- Name of the role to use
This script will delete deployment targets matching the specified role. This operation is destructive and cannot be undone.
Script
$ErrorActionPreference = "Stop";
# Define working variables
$octopusURL = "https://youroctourl/api"
$octopusAPIKey = "API-YOURAPIKEY"
$header = @{ "X-Octopus-ApiKey" = $octopusAPIKey }
$spaceName = "default"
$role = "MyRole"
# Get space
$space = (Invoke-RestMethod -Method Get -Uri "$octopusURL/api/spaces/all" -Headers $header) | Where-Object {$_.Name -eq $spaceName}
# Get machine list
$machines = (Invoke-RestMethod -Method Get -Uri "$octopusURL/api/$($space.Id)/machines/all" -Headers $header) | Where-Object {$role -in $_.Roles}
# Loop through list
foreach ($machine in $machines)
{
# Remove machine
Invoke-RestMethod -Method Delete -Uri "$octopusURL/api/$($space.Id)/machines/$($machine.Id)" -Headers $header
}
# Load octopus.client assembly
Add-Type -Path "path\to\Octopus.Client.dll"
# Octopus variables
$octopusURL = "https://youroctourl/api"
$octopusAPIKey = "API-YOURAPIKEY"
$spaceName = "default"
$role = "MyRole"
$endpoint = New-Object Octopus.Client.OctopusServerEndpoint $octopusURL, $octopusAPIKey
$repository = New-Object Octopus.Client.OctopusRepository $endpoint
$client = New-Object Octopus.Client.OctopusClient $endpoint
try
{
# Get space
$space = $repository.Spaces.FindByName($spaceName)
$repositoryForSpace = $client.ForSpace($space)
# Get machine list
$machines = $repositoryForSpace.Machines.GetAll() | Where-Object {$role -in $_.Roles}
# Loop through list
foreach ($machine in $machines)
{
# Delete machine
$repositoryForSpace.Machines.Delete($machine)
}
}
catch
{
Write-Host $_.Exception.Message
}
// If using .net Core, be sure to add the NuGet package of System.Security.Permissions
#r "path\to\Octopus.Client.dll"
using Octopus.Client;
using Octopus.Client.Model;
// Declare working varibles
var octopusURL = "https://youroctourl";
var octopusAPIKey = "API-YOURAPIKEY";
string spaceName = "default";
string role = "MyRole";
// Create repository object
var endpoint = new OctopusServerEndpoint(octopusURL, octopusAPIKey);
var repository = new OctopusRepository(endpoint);
var client = new OctopusClient(endpoint);
try
{
// Get space
var space = repository.Spaces.FindByName(spaceName);
var repositoryForSpace = client.ForSpace(space);
// Get machine list
var machines = repositoryForSpace.Machines.FindAll().Where(r => r.Roles.Contains(role));
// Loop through list
foreach (var machine in machines)
{
// Delete machine
repositoryForSpace.Machines.Delete(machine);
}
}
catch (Exception ex)
{
Console.WriteLine(ex.Message);
return;
}
import json
import requests
octopus_server_uri = 'https://your.octopus.app/api'
octopus_api_key = 'API-YOURAPIKEY'
headers = {'X-Octopus-ApiKey': octopus_api_key}
def get_octopus_resource(uri):
response = requests.get(uri, headers=headers)
response.raise_for_status()
return json.loads(response.content.decode('utf-8'))
def get_by_name(uri, name):
resources = get_octopus_resource(uri)
return next((x for x in resources if x['Name'] == name), None)
def get_by_role(uri, role):
resources = get_octopus_resource(uri)
return (r for r in resources if role in r['Roles'])
space_name = 'Default'
target_role = 'your-target-role'
space = get_by_name('{0}/spaces/all'.format(octopus_server_uri), space_name)
targets = get_by_role('{0}/{1}/machines/all'.format(octopus_server_uri, space['Id']), target_role)
for target in targets:
print('Deleting {0} ({1})'.format(target['Name'], target['Id']))
uri = '{0}/{1}/machines/{2}'.format(octopus_server_uri, space['Id'], target['Id'])
response = requests.delete(uri, headers=headers)
response.raise_for_status()
Need support? We're here to help.