eryph
by

References

References: Powershell commands

Installation

If you install eryph-zero the powershell modules will be installed automatically.

The eryph powershell modules can also be installed from the powershell gallery:

Both Compute Client and Identity Client depends on Client Configuration and will be installed with them.

Catlet Commands

Commands for managing catlets (virtual machines).

Get-Catlet - Gets one or more catlets

Get-Catlet [[-Id] <string[]>] [-Config] [<CommonParameters>]
Get-Catlet [-ProjectName <string>] [<CommonParameters>]

New-Catlet - Creates a new catlet from configuration

New-Catlet [-InputObject] <string[]> [-NoWait] [-ProjectName <string>] [-Name <string>] [-Variables <hashtable>] [-SkipVariablesPrompt] [<CommonParameters>]
New-Catlet -Config <string> [-NoWait] [-ProjectName <string>] [-Name <string>] [-Variables <hashtable>] [-SkipVariablesPrompt] [<CommonParameters>]
New-Catlet -Parent <string> [-NoWait] [-ProjectName <string>] [-Name <string>] [-Variables <hashtable>] [-SkipVariablesPrompt] [<CommonParameters>]

Start-Catlet - Starts one or more catlets

Start-Catlet [-Id] <string[]> [-Force] [-NoWait] [<CommonParameters>]

Stop-Catlet - Stops one or more catlets

Stop-Catlet [-Id] <string[]> [-Force] [-NoWait] [-Mode <CatletStopMode>] [<CommonParameters>]

Remove-Catlet - Removes one or more catlets

Remove-Catlet [-Id] <string[]> [-Force] [-NoWait] [<CommonParameters>]

Update-Catlet - Updates catlet configuration

Update-Catlet [-Id] <string[]> [-InputObject] <string[]> [-NoWait] [-Variables <hashtable>] [-SkipVariablesPrompt] [<CommonParameters>]
Update-Catlet [-Id] <string[]> -Config <string> [-NoWait] [-Variables <hashtable>] [-SkipVariablesPrompt] [<CommonParameters>]

Test-Catlet - Tests catlet configuration without creating

Test-Catlet [-InputObject] <string[]> [-NoWait] [-ProjectName <string>] [-Name <string>] [-Variables <hashtable>] [-SkipVariablesPrompt] [-ShowSecrets] [<CommonParameters>]
Test-Catlet -Config <string> [-NoWait] [-ProjectName <string>] [-Name <string>] [-Variables <hashtable>] [-SkipVariablesPrompt] [-ShowSecrets] [<CommonParameters>]
Test-Catlet -Parent <string> [-NoWait] [-ProjectName <string>] [-Name <string>] [-Variables <hashtable>] [-SkipVariablesPrompt] [-ShowSecrets] [<CommonParameters>]
Test-Catlet [-InputObject] <string[]> -Id <string> [-NoWait] [-ShowSecrets] [<CommonParameters>]
Test-Catlet [-InputObject] <string[]> -Quick [<CommonParameters>]

Get-CatletGene - Gets catlet gene information

Get-CatletGene [[-Id] <string[]>] [<CommonParameters>]

Remove-CatletGene - Removes catlet genes

Remove-CatletGene [-Id] <string[]> [-Force] [-PassThru] [-NoWait] [<CommonParameters>]
Remove-CatletGene -Unused [-Force] [-PassThru] [-NoWait] [<CommonParameters>]

Get-CatletIp - Gets IP addresses assigned to catlets

Get-CatletIp [-Id] <string[]> [<CommonParameters>]

Disk Commands

Commands for managing standalone catlet disks.

Get-CatletDisk - Gets catlet disk information

Get-CatletDisk [[-Id] <string[]>] [<CommonParameters>]
Get-CatletDisk [-ProjectName <string>] [<CommonParameters>]

New-CatletDisk - Creates a new catlet disk

New-CatletDisk [-InputObject] <string[]> [-NoWait] [-ProjectName <string>] [<CommonParameters>]
New-CatletDisk -Config <string> [-NoWait] [-ProjectName <string>] [<CommonParameters>]

Remove-CatletDisk - Removes catlet disks

Remove-CatletDisk [-Id] <string[]> [-Force] [-NoWait] [<CommonParameters>]

Project Commands

Commands for managing projects and project members.

Get-EryphProject - Gets eryph projects

Get-EryphProject [[-Id] <string[]>] [<CommonParameters>]
Get-EryphProject [[-Name] <string[]>] [<CommonParameters>]

New-EryphProject - Creates a new project

New-EryphProject [-Name] <string> [-NoWait] [<CommonParameters>]

Remove-EryphProject - Removes projects

Remove-EryphProject [-Id] <string[]> [-Force] [-NoWait] [<CommonParameters>]
Remove-EryphProject [-Name] <string[]> [-Force] [-NoWait] [<CommonParameters>]

Get-EryphProjectMemberRole - Gets project member roles

Get-EryphProjectMemberRole [-ProjectName] <string> [<CommonParameters>]

Add-EryphProjectMemberRole - Adds a member role to a project

Add-EryphProjectMemberRole [-ProjectName] <string> [-MemberId] <string> [-RoleId] <string> [-NoWait] [<CommonParameters>]

Remove-EryphProjectMemberRole - Removes a member role from a project

Remove-EryphProjectMemberRole [-ProjectName] <string> [-MemberId] <string> [-RoleId] <string> [-Force] [-NoWait] [<CommonParameters>]

Network Commands

Commands for managing virtual networks.

Get-VNetwork - Gets virtual network configuration

Get-VNetwork [-ProjectName] <string> [<CommonParameters>]

Set-VNetwork - Sets virtual network configuration

Set-VNetwork [-ProjectName] <string> [-InputObject] <string[]> [-NoWait] [<CommonParameters>]
Set-VNetwork [-ProjectName] <string> -Config <string> [-NoWait] [<CommonParameters>]

Identity Commands

Commands for managing identity clients.

Get-EryphClient - Gets identity clients

Get-EryphClient [[-Id] <string[]>] [<CommonParameters>]
Get-EryphClient [[-Name] <string[]>] [<CommonParameters>]

New-EryphClient - Creates a new identity client

New-EryphClient [-Name] <string> [-AllowedScopes <string[]>] [<CommonParameters>]

Remove-EryphClient - Removes identity clients

Remove-EryphClient [-Id] <string[]> [-Force] [<CommonParameters>]

Set-EryphClient - Updates identity client configuration

Set-EryphClient [-Id] <string> [-Name <string>] [-AllowedScopes <string[]>] [<CommonParameters>]

New-EryphClientKey - Creates a new key for identity client

New-EryphClientKey [[-Id] <string[]>] [-Name <string>] [-SharedKey] [<CommonParameters>]

Configuration Commands

Commands for managing client configuration.

Add-EryphClientConfiguration - Adds a new client configuration

Add-EryphClientConfiguration [-Name] <string> [-IdentityEndpoint] <string> [-ComputeEndpoint] <string> [-Default] [<CommonParameters>]

Get-EryphAccessToken - Gets access token for authentication

Get-EryphAccessToken [-Configuration <string>] [<CommonParameters>]

Get-EryphClientConfiguration - Gets client configurations

Get-EryphClientConfiguration [[-Id] <string[]>] [-Configuration <string>] [<CommonParameters>]
Get-EryphClientConfiguration -Default [-Configuration <string>] [<CommonParameters>]

Get-EryphClientCredentials - Gets stored client credentials

Get-EryphClientCredentials [-Configuration <string>] [<CommonParameters>]

New-EryphClientCredentials - Creates new client credentials

New-EryphClientCredentials [-ClientId] <string> [-ClientSecret] <string> [-Configuration <string>] [<CommonParameters>]

Remove-EryphClientConfiguration - Removes client configurations

Remove-EryphClientConfiguration [-Name] <string[]> [-Force] [<CommonParameters>]

Set-EryphClientConfiguration - Updates client configuration

Set-EryphClientConfiguration [-Name] <string> [-IdentityEndpoint <string>] [-ComputeEndpoint <string>] [-Default] [<CommonParameters>]

Set-EryphConfigurationStore - Sets configuration store location

Set-EryphConfigurationStore [-Path] <string> [<CommonParameters>]

Operation Commands

Commands for accessing operation status and logs.

Get-EryphOperation - Gets operation status and details

Get-EryphOperation [-Id] <string[]> [-Watch] [<CommonParameters>]

Common Parameters

All commands support PowerShell common parameters:

  • -Credentials: Override default credentials
  • -Verbose: Detailed output
  • -Debug: Debug information
  • -ErrorAction: Error handling behavior
  • -WarningAction: Warning handling behavior
  • -OutVariable: Store output in variable

Parameter Reference

Key Parameters

-Id - Identifier for resources (catlets, disks, projects, etc.). Accepts pipeline input.

-Name - Resource name. Used for creation and some queries.

-ProjectName - Specifies the project context for operations.

-Config - Configuration in YAML/JSON format. Can be string or file path.

-InputObject - Accepts configuration from pipeline input.

-Parent - Specifies parent gene for inheritance.

-Variables - Hashtable of variables for configuration templates.

-NoWait - Returns immediately without waiting for operation completion.

-Force - Bypasses confirmation prompts for destructive operations.

-Mode - Operation mode (e.g., Shutdown, PowerOff for Stop-Catlet).

-Watch - Continuously monitors operation status.

-ShowSecrets - Includes sensitive information in output.

-Quick - Performs quick validation without full processing.

-Unused - Targets unused resources for cleanup.

-Default - Sets or gets default configuration.

-AllowedScopes - Defines permitted scopes for identity clients.

Notes

  • Catlet commands use pipeline input or -Id parameter, not -Name for operations like Start/Stop/Remove
  • Use -Force with removal commands to avoid interactive prompts
  • Most modification commands support -NoWait for asynchronous operations
  • Pipeline support enables command chaining for efficient workflows