Skip to main content
Ctrl+K
VMM-SDK

VMM-SDK

Site Navigation

  • Getting Started
  • Configuration
  • SDK Reference
  • Examples
Ctrl+K

Site Navigation

  • Getting Started
  • Configuration
  • SDK Reference
  • Examples
Ctrl+K

Section Navigation

  • ntnx_vmm_py_client package
    • api package
      • esxi_stats_api
      • esxi_vm_api
      • image_placement_policies_api
      • image_rate_limit_policies_api
      • images_api
      • ovas_api
      • stats_api
      • template_placement_policies_api
      • templates_api
      • vm_anti_affinity_policies_api
      • vm_api
      • vm_guest_customization_profiles_api
      • vm_host_affinity_policies_api
      • vm_recovery_points_api
      • vm_startup_policies_api
    • models package
      • catalogCommon package
        • v1 package
          • config package
            • CategoriesFilter
            • CategoriesMatchType
            • CommonPlacementPolicy
            • ContentPlacementType
      • common package
        • v1 package
          • config package
            • FQDN
            • Flag
            • IPv4Address
            • IPv6Address
            • KVPair
            • MapOfStringWrapper
            • Message
            • MessageSeverity
            • TenantAwareModel
          • response package
            • ApiLink
            • ApiResponseMetadata
            • ExternalizableAbstractModel
          • stats package
            • DownSamplingOperator
      • dataprotection package
        • v4 package
          • common package
            • BackupType
            • BaseRecoveryPoint
            • BaseVmRecoveryPoint
            • DiskRecoveryPoint
            • RecoveryPointStatus
            • RecoveryPointType
            • VssProperties
      • iam package
        • v4 package
          • authn package
            • BucketsAccessKey
            • BucketsAccessKeyStatusType
            • CreationType
            • User
            • UserStatusType
            • UserType
      • prism package
        • v4 package
          • config package
            • TaskReference
      • vmm package
        • v4 package
          • ahv package
            • config package
              • ADSFDiskMigrationPlan
              • ADSFVmStorageConfig
              • ADSFVolumeGroupReference
              • AddVmCustomAttributesApiResponse
              • AddVmDiskCustomAttributesApiResponse
              • AllDisksMigrationPlan
              • ApcConfig
              • AssignIpApiResponse
              • AssignIpParams
              • AssignVmOwnerApiResponse
              • AssociateCategoriesApiResponse
              • AssociateVmCategoriesParams
              • AvailabilityZoneReference
              • BackingFirmwareDiskStorageInfo
              • BootDeviceDisk
              • BootDeviceNic
              • BootDeviceType
              • CategoryReference
              • CdRom
              • CdRomAddress
              • CdRomBusType
              • CdRomInsertParams
              • CloneOverrideParams
              • CloneVmApiResponse
              • CloudInit
              • CloudInitDataSourceType
              • ClusterReference
              • CpuFeature
              • CpuModelReference
              • CreateCdRomApiResponse
              • CreateDiskApiResponse
              • CreateGpuApiResponse
              • CreateNicApiResponse
              • CreatePcieDeviceApiResponse
              • CreateSerialPortApiResponse
              • CreateVMRecoveryPointApiResponse
              • CreateVmApiResponse
              • CreateVmGuestCustomizationProfileApiResponse
              • Credential
              • CrossClusterMigrateVmApiResponse
              • CustomKeyValues
              • CustomizeGuestVmApiResponse
              • DataSource
              • DeleteCdRomApiResponse
              • DeleteDiskApiResponse
              • DeleteGpuApiResponse
              • DeleteNicApiResponse
              • DeletePcieDeviceApiResponse
              • DeleteSerialPortApiResponse
              • DeleteVmApiResponse
              • DeleteVmGuestCustomizationProfileApiResponse
              • DeleteVmRecoveryPointApiResponse
              • DisableVmCdRomHydrationApiResponse
              • DisableVmDiskHydrationApiResponse
              • DisassociateCategoriesApiResponse
              • DisassociateVmCategoriesParams
              • Disk
              • DiskAddress
              • DiskBusType
              • DiskHydrationInfo
              • DiskMigrationParams
              • DpOffloadNic
              • DpOffloadNicNetworkInfo
              • EjectCdRomApiResponse
              • EmulatedNic
              • EmulatedNicModel
              • EnableVmCdRomHydrationApiResponse
              • EnableVmDiskHydrationApiResponse
              • ExternalDataSourceDiskReference
              • GenerateConsoleTokenApiResponse
              • GetCdRomApiResponse
              • GetDiskApiResponse
              • GetGpuApiResponse
              • GetGuestToolsApiResponse
              • GetNicApiResponse
              • GetPcieDeviceApiResponse
              • GetSerialPortApiResponse
              • GetVmApiResponse
              • GetVmGuestCustomizationProfileApiResponse
              • GetVmRecoveryPointApiResponse
              • Gpu
              • GpuMode
              • GpuVendor
              • GuestCustomizationParams
              • GuestInfo
              • GuestPowerOptions
              • GuestPowerStateTransitionConfig
              • GuestStaticIpSpec
              • GuestTools
              • GuestToolsInsertConfig
              • GuestToolsInstallConfig
              • GuestToolsUpgradeConfig
              • HostPcieDeviceReference
              • HostReference
              • HydrationInfo
              • HydrationStatus
              • ImageReference
              • InsertCdRomApiResponse
              • InsertVmGuestToolsApiResponse
              • InstallType
              • InstallVmGuestToolsApiResponse
              • Ipv4Config
              • Ipv4Info
              • Ipv6Info
              • IsoType
              • LegacyBoot
              • ListCdRomsApiResponse
              • ListDisksApiResponse
              • ListGpusApiResponse
              • ListNicsApiResponse
              • ListPcieDevicesApiResponse
              • ListSerialPortsApiResponse
              • ListVmGuestCustomizationProfilesApiResponse
              • ListVmRecoveryPointsApiResponse
              • ListVmsApiResponse
              • MachineType
              • MigrateDiskReference
              • MigrateNicApiResponse
              • MigrateNicConfig
              • MigrateNicType
              • MigrateVmDisksApiResponse
              • MigrateVmToHostApiResponse
              • MigrationPlans
              • NetworkFunctionChainReference
              • NetworkFunctionNicType
              • NgtCapability
              • Nic
              • NicNetworkInfo
              • NicProfileReference
              • NicType
              • NvramDevice
              • OvaVmConfigOverrideSpec
              • OwnerReference
              • OwnershipInfo
              • PcieDevice
              • PcieDeviceInfo
              • PcieDeviceReference
              • PolicyReference
              • PowerCycleVmApiResponse
              • PowerOffVmApiResponse
              • PowerOnVmApiResponse
              • PowerState
              • ProjectReference
              • ProtectionPolicyState
              • ProtectionType
              • QosConfig
              • RebootPreference
              • RebootPreferenceSchedule
              • RebootVmApiResponse
              • ReleaseIpApiResponse
              • RemoveVmCustomAttributesApiResponse
              • RemoveVmDiskCustomAttributesApiResponse
              • ResetVmApiResponse
              • RestoreVmRecoveryPointApiResponse
              • RestoreVmRecoveryPointParams
              • RevertParams
              • RevertVmApiResponse
              • SBDF
              • ScheduleType
              • SerialPort
              • ShutdownVmApiResponse
              • SriovNic
              • SriovNicNetworkInfo
              • StorageContainerMapping
              • StorageLocationInfo
              • SubnetReference
              • Sysprep
              • UefiBoot
              • Unattendxml
              • UninstallVmGuestToolsApiResponse
              • UpdateCustomAttributesParams
              • UpdateDiskApiResponse
              • UpdateGuestToolsApiResponse
              • UpdateNicApiResponse
              • UpdateSerialPortApiResponse
              • UpdateVmApiResponse
              • UpdateVmGuestCustomizationProfileApiResponse
              • UpgradeVmGuestToolsApiResponse
              • UserReference
              • Userdata
              • VirtualEthernetNic
              • VirtualEthernetNicModel
              • VirtualEthernetNicNetworkInfo
              • VlanMode
              • Vm
              • VmConfigOverrideSpecification
              • VmCrossClusterMigrateOverrides
              • VmCrossClusterMigrateParams
              • VmDisk
              • VmDiskContainerReference
              • VmDiskRecoveryPointReference
              • VmDiskReference
              • VmDiskStorageConfig
              • VmGcProfileAdministratorPassword
              • VmGcProfileAnswerFile
              • VmGcProfileAnswerFileOverrideSpec
              • VmGcProfileAutoLogonSettings
              • VmGcProfileAutoLogonSettingsOverrideSpec
              • VmGcProfileComputerName
              • VmGcProfileConfig
              • VmGcProfileDiscardSettings
              • VmGcProfileDnsConfig
              • VmGcProfileDnsConfigOverrideSpec
              • VmGcProfileDomainCredentials
              • VmGcProfileDomainCredentialsOverrideSpec
              • VmGcProfileDomainSettings
              • VmGcProfileDomainSettingsOverrideSpec
              • VmGcProfileGeneralSettings
              • VmGcProfileGeneralSettingsOverrideSpec
              • VmGcProfileLocaleSettingOverride
              • VmGcProfileLocaleSettings
              • VmGcProfileLocaleSettingsOverrideSpec
              • VmGcProfileMustProvideDuringDeployment
              • VmGcProfileNetworkSettings
              • VmGcProfileNetworkSettingsOverrideSpec
              • VmGcProfileNicConfig
              • VmGcProfileNicConfigOverrideSpec
              • VmGcProfileNicIpv4ConfigOverrideSpec
              • VmGcProfileReference
              • VmGcProfileRegisteredOrganization
              • VmGcProfileRegisteredOwner
              • VmGcProfileSysprepConfig
              • VmGcProfileSysprepConfigOverrideSpec
              • VmGcProfileSysprepParams
              • VmGcProfileSysprepParamsOverrideSpec
              • VmGcProfileTimezone
              • VmGcProfileUseDhcp
              • VmGcProfileUseDhcpOverrideSpec
              • VmGcProfileUseVmName
              • VmGcProfileUseVmNameOverrideSpec
              • VmGcProfileWindowsProductKey
              • VmGcProfileWorkgroup
              • VmGcProfileWorkgroupOverrideSpec
              • VmGuestCustomizationProfile
              • VmGuestCustomizationStatus
              • VmMigrateToHostParams
              • VmRecoveryPoint
              • VmReference
              • VmRestoreGuestNicInfoOverrideSpec
              • VmRestoreGuestToolsSpecification
              • VmRestoreIpv4ConfigOverrideSpec
              • VmRestoreNicConfigOverrideParams
              • VmRestoreNicConfigSpecification
              • VmRestoreVirtualEthernetNicNetworkInfoOverrideSpec
              • VmRestoreVirtualEthernetNicOverrideSpec
              • VmRevertOverrideSpec
              • VmSourceReference
              • VmSourceReferenceEntityType
              • VolumeDiskRecoveryPointReference
              • VolumeDiskReference
              • VtpmConfig
              • VtpmDevice
            • policies package
              • CategoryDependency
              • CategoryReference
              • ClusterNotSupportedForVmAntiAffinity
              • ClusterReference
              • CompliantVmAntiAffinityPolicy
              • CompliantVmHostAffinityPolicy
              • ConflictingLegacyVmAntiAffinityPolicy
              • ConflictingLegacyVmHostAffinityPolicy
              • ConflictingVmAntiAffinityPolicy
              • ConflictingVmHostAffinityPolicy
              • CreateVmAntiAffinityPolicyApiResponse
              • CreateVmHostAffinityPolicyApiResponse
              • CreateVmStartupPolicyApiResponse
              • DeleteLegacyVmAntiAffinityPolicyApiResponse
              • DeleteVmAntiAffinityPolicyApiResponse
              • DeleteVmHostAffinityPolicyApiResponse
              • DeleteVmStartupPolicyApiResponse
              • DependencyConflict
              • DependencyGroup
              • GetVmAntiAffinityPolicyApiResponse
              • GetVmHostAffinityPolicyApiResponse
              • GetVmStartupPolicyApiResponse
              • GetVmStartupPolicyDependencyConflictApiResponse
              • GetVmStartupPolicyStartConditionConflictApiResponse
              • HostReference
              • LegacyVmAntiAffinityPolicy
              • ListLegacyVmAntiAffinityPoliciesApiResponse
              • ListVmAntiAffinityPoliciesApiResponse
              • ListVmAntiAffinityPolicyVmComplianceStatesApiResponse
              • ListVmHostAffinityPoliciesApiResponse
              • ListVmHostAffinityPolicyVmComplianceStatesApiResponse
              • ListVmStartupPoliciesApiResponse
              • ListVmStartupPolicyDependencyConflictDependeeVmsApiResponse
              • ListVmStartupPolicyDependencyConflictDependentVmsApiResponse
              • ListVmStartupPolicyDependencyConflictsApiResponse
              • ListVmStartupPolicyStartConditionConflictDependeeVmsApiResponse
              • ListVmStartupPolicyStartConditionConflictDependentVmsApiResponse
              • ListVmStartupPolicyStartConditionConflictsApiResponse
              • ListVmStartupPolicyVmComplianceStatesApiResponse
              • NoHostsForVmHostAffinityPolicy
              • NonCompliantVmAntiAffinityPolicy
              • NonCompliantVmHostAffinityPolicy
              • NotEnoughHostsForVmAntiAffinity
              • NotEnoughResourcesForVmAntiAffinity
              • NotEnoughResourcesForVmHostAffinityPolicy
              • OtherVmAntiAffinityPolicyNonComplianceReason
              • OtherVmHostAffinityPolicyVmNonComplianceReason
              • PeNotCapableForVmHostAffinityPolicy
              • PendingVmAntiAffinityPolicy
              • PendingVmHostAffinityPolicy
              • PowerStateCriteriaGuestBootup
              • PowerStateCriteriaPowerOn
              • ReEnforceVmHostAffinityPolicyApiResponse
              • StartCondition
              • StartConditionConflict
              • UpdateVmAntiAffinityPolicyApiResponse
              • UpdateVmHostAffinityPolicyApiResponse
              • UpdateVmStartupPolicyApiResponse
              • UserReference
              • VmAntiAffinityPolicy
              • VmAntiAffinityPolicyVmComplianceState
              • VmHostAffinityPolicy
              • VmHostAffinityPolicyVmComplianceState
              • VmReference
              • VmStartupPolicy
              • VmStartupPolicyClusterNotSupported
              • VmStartupPolicyCompliantVm
              • VmStartupPolicyHaNotSupported
              • VmStartupPolicyHaNotSupportedReason
              • VmStartupPolicyNgtNotEnabled
              • VmStartupPolicyNonCompliantVm
              • VmStartupPolicyPendingVm
              • VmStartupPolicyReference
              • VmStartupPolicyVmComplianceState
            • stats package
              • GetDiskStatsApiResponse
              • GetNicStatsApiResponse
              • GetVmStatsApiResponse
              • ListVmStatsApiResponse
              • VmDiskStats
              • VmDiskStatsTuple
              • VmDiskStatsTupleProjection
              • VmNicStats
              • VmNicStatsTuple
              • VmNicStatsTupleProjection
              • VmStats
              • VmStatsTuple
              • VmStatsTupleProjection
          • config package
            • CreateTemplatePlacementPolicyApiResponse
            • DeleteTemplatePlacementPolicyApiResponse
            • GetTemplatePlacementPolicyApiResponse
            • ListTemplatePlacementPoliciesApiResponse
            • TemplatePlacementPolicy
            • UpdateTemplatePlacementPolicyApiResponse
          • content package
            • CancelGuestUpdateApiResponse
            • CompleteGuestUpdateApiResponse
            • CompleteGuestUpdateSpec
            • ComplianceStatus
            • CreateImageApiResponse
            • CreateOvaApiResponse
            • CreateTemplateApiResponse
            • DeleteImageApiResponse
            • DeleteOvaApiResponse
            • DeleteTemplateApiResponse
            • DeleteTemplateVersionApiResponse
            • DeployOvaApiResponse
            • DeployTemplateApiResponse
            • EnforcementMode
            • GetImageApiResponse
            • GetImageFileApiResponse
            • GetOvaApiResponse
            • GetOvaFileApiResponse
            • GetTemplateApiResponse
            • GetTemplateVersionApiResponse
            • GuestUpdateStatus
            • Image
            • ImageImportConfig
            • ImagePlacementStatus
            • ImageSha1Checksum
            • ImageSha256Checksum
            • ImageType
            • ImportImageApiResponse
            • InitiateGuestUpdateApiResponse
            • InitiateGuestUpdateSpec
            • ListImagesApiResponse
            • ListOvasApiResponse
            • ListTemplateVersionsApiResponse
            • ListTemplatesApiResponse
            • ObjectsLiteSource
            • Ova
            • OvaDeploymentSpec
            • OvaDiskFormat
            • OvaSha1Checksum
            • OvaSha256Checksum
            • OvaUrlSource
            • OvaVmSource
            • PublishTemplateApiResponse
            • Template
            • TemplateDeployment
            • TemplatePublishSpec
            • TemplateUser
            • TemplateVersionReference
            • TemplateVersionSpec
            • TemplateVmReference
            • UpdateImageApiResponse
            • UpdateOvaApiResponse
            • UpdateTemplateApiResponse
            • UrlBasicAuth
            • UrlSource
            • VmConfigOverride
            • VmDiskSource
          • error package
            • AppMessage
            • ErrorResponse
            • SchemaValidationError
            • SchemaValidationErrorMessage
          • esxi package
            • config package
              • AdapterType
              • AssignVmOwnerApiResponse
              • AssociateCategoriesApiResponse
              • AssociateVmCategoriesParams
              • CategoryReference
              • CdRom
              • CdRomAddress
              • CdRomBackingInfo
              • CdRomBusType
              • ClusterReference
              • DisassociateCategoriesApiResponse
              • DisassociateVmCategoriesParams
              • Disk
              • DiskAddress
              • DiskBusType
              • GetNutanixGuestToolsApiResponse
              • GetVmApiResponse
              • GuestInfo
              • HostReference
              • InsertNutanixGuestToolsApiResponse
              • InstallNutanixGuestToolsApiResponse
              • IpAddressInfo
              • ListVmsApiResponse
              • Nic
              • NicBackingInfo
              • NicNetworkInfo
              • NutanixCredential
              • NutanixGuestTools
              • NutanixGuestToolsCapability
              • NutanixGuestToolsInsertConfig
              • NutanixGuestToolsInstallConfig
              • NutanixGuestToolsUpgradeConfig
              • NutanixRebootPreference
              • NutanixRebootPreferenceSchedule
              • NutanixScheduleType
              • OwnerReference
              • OwnerReferenceEntityType
              • OwnershipInfo
              • PortGroupInfo
              • PowerOffVmApiResponse
              • PowerOnVmApiResponse
              • PowerState
              • RebootGuestOSApiResponse
              • ResetVmApiResponse
              • RevertParams
              • RevertVmApiResponse
              • ShutdownVmApiResponse
              • SuspendVmApiResponse
              • UninstallNutanixGuestToolsApiResponse
              • UpdateNutanixGuestToolsApiResponse
              • UpgradeNutanixGuestToolsApiResponse
              • Vm
              • VmDisk
              • VmDiskContainerReference
              • VmDiskStorageConfig
            • stats package
              • GetDiskStatsApiResponse
              • GetNicStatsApiResponse
              • GetVmStatsApiResponse
              • ListVmStatsApiResponse
              • VmDiskStats
              • VmDiskStatsTuple
              • VmDiskStatsTupleProjection
              • VmNicStats
              • VmNicStatsTuple
              • VmNicStatsTupleProjection
              • VmStats
              • VmStatsTuple
              • VmStatsTupleProjection
          • images package
            • config package
              • CreatePlacementPolicyApiResponse
              • CreateRateLimitPolicyApiResponse
              • DeletePlacementPolicyApiResponse
              • DeleteRateLimitPolicyApiResponse
              • EffectiveRateLimitPolicy
              • EnforcementState
              • Filter
              • FilterMatchType
              • GetPlacementPolicyApiResponse
              • GetRateLimitPolicyApiResponse
              • ListEffectiveRateLimitPoliciesApiResponse
              • ListPlacementPoliciesApiResponse
              • ListRateLimitPoliciesApiResponse
              • PlacementPolicy
              • PlacementType
              • RateLimitPolicy
              • ResumePlacementPolicyApiResponse
              • SuspendPlacementPolicyApiResponse
              • SuspendPlacementPolicyConfig
              • UpdatePlacementPolicyApiResponse
              • UpdateRateLimitPolicyApiResponse
    • api_client
    • api_response
    • configuration
    • custom_retry
    • rest
  • ntnx_vmm_py_client
  • dataprotection package
  • v4 package

v4 package#

Subpackages:

  • common package
    • BackupType
      • BackupType
    • BaseRecoveryPoint
      • BaseRecoveryPoint
    • BaseVmRecoveryPoint
      • BaseVmRecoveryPoint
    • DiskRecoveryPoint
      • DiskRecoveryPoint
    • RecoveryPointStatus
      • RecoveryPointStatus
    • RecoveryPointType
      • RecoveryPointType
    • VssProperties
      • VssProperties

previous

dataprotection package

next

common package

© Copyright 2025, Nutanix.

Created using Sphinx 5.3.0.

Built with the PyData Sphinx Theme 0.13.0.