Nutanix.Tenancy

Author(s)

• Nutanix

Tags

Nutanix API REST Cloud Nutanix.Tenancy

Dependencies

This module has no dependencies.

Release Notes

# Nutanix Nutanix.Tenancy PowerShell Module v1.0.0

PowerShell module for managing Nutanix Nutanix.Tenancy resources using the Nutanix.Tenancy API.

### Features
- **Resource Operations**: Create, read, update, delete, and list operations
- **Device Management**: Manage various device types and configurations
- **Lifecycle Operations**: Power management, migration, cloning, and more
- **Dual Parameter Sets**: All cmdlets support both individual parameters and Request object patterns

### Quick Start

1. **Import the module**:
  ```powershell
  Import-Module Nutanix.Tenancy
  ```

2. **Configure connection** (via Set-PrismCentralConfig or alias Set-PcConfig):
  ```powershell
  # Password is a mandatory SecureString parameter
  # If not provided, PowerShell will prompt for it securely
  
  # Option 1: Let PowerShell prompt (recommended for interactive use)
  Set-PcConfig -Host "10.46.8.20" -Username "admin" -SkipCertificateCheck
  # PowerShell prompts: Password: *******
  
  # Option 2: Explicitly provide SecureString password
  $password = Read-Host -AsSecureString -Prompt "Enter Password"
  Set-PcConfig -Host "10.46.8.20" -Username "admin" -Password $password -SkipCertificateCheck
  
  # Option 3: From PSCredential
  $credential = Get-Credential -UserName "admin"
  Set-PcConfig -Host "10.46.8.20" -Username $credential.UserName -Password $credential.Password -SkipCertificateCheck
  ```
  
  **Important:** Password is required. Without a valid password, API calls will fail with HTTP 401 Unauthorized.

3. **Use Nutanix.Tenancy cmdlets**:
  ```powershell
  # Example: List resources
  Get-* -Limit_ 10
  
  # Example: Get resource by ID (Individual parameters)
  Get-*ById -ExtId "resource-uuid"
  
  # Example: Update resource (Individual parameters)
  Set-*ById -ExtId "resource-uuid" -Body $bodyObject -ETag "etag-value"
  
  # Example: Update resource (Request object)
  $request = New-Object Nutanix.Nutanix.TenancySDK.Model.Request.*.*Request
  $request.extId = "resource-uuid"
  $request.body = $bodyObject
  Set-*ById -Request $request -ETag "etag-value"
  ```

4. **Clear configuration when done**:
  ```powershell
  Clear-NutanixConfig
  ```

### Requirements
- PowerShell 7.0 or higher
- .NET 8.0 Runtime
- Access to a Nutanix cluster with Nutanix.Tenancy API enabled

### Parameter Sets

All cmdlets support two parameter sets:
- **Individual**: Accepts individual parameters (e.g., `-ExtId`, `-Body`)
- **Request**: Accepts a single Request object (e.g., `-Request`)

This provides flexibility for different use cases and enables better integration with other PowerShell workflows.

### Connection Management

- **Set-PrismCentralConfig** (or alias **Set-PcConfig**): Configure connection to Nutanix cluster
- **Clear-NutanixConfig**: Clear stored connection configuration