🌅 This is the 19.18 Version 🌅
the module should be installed from PSgallery
Install-Module -Name PPDM-pwsh -MinimumVersion 19.18.22
connect to the API Endpoint:
ipmo .\PPDM-pwsh -Force
Connect-PPDMSystem -PPDM_API_URI https://<your ppdm server> -trustCert
this will do an interactive password/authentication to retrieve the token. The login can alos be done via a PSCredential object.
The token is saved as a Global Variable.
All functions can use -verbose to show the API Calls amde against the PPDM
This section gives Some Examples for Workloads. Most of the Examples are also available from the Inline Help, e.g.
get-help New-PPDMProtectionEngineProxy -Examples
Example for vMware Based Protections, Policies
VM Restore from CLI
VM Instant Access Restore LINUX VM
Example Script Custom Restore Comments
Example script to exclude Disks from VM Asset
Create AppAware MSSQL Protection using Transparent Snapshots
Examples for Kubernetes Onboarding, Protection and restores
Kubernetes Protection
Example script to exclude PVC with Storage certain Classes
Examples for Managing Agent Based Protection and Policies
FSAgent Agent
MSSQL Agent
Create Centralized MSSQL Protection Policy
Create Self Service MSSQL Policy
Manage Agent Updates
Examples for managing Assets
Asset Management
Manage AppHosts Preferred IP/Comms Assignment
There are Common Appliance Settings that can be retreive and modified View and Modify Common Settings
Example Script getting Assets protected in restore Plan
Example Script adding a DataDomain
The Storage_Systems API has some festures for Capacity Reports // NFS Shares described here
Examles for Managing Storage and Capacity
Add a Kubernetes Proxy
Add a vSphereProxy with NBD
Example Script to wait for Appliance Fresh Install State
Example Script to start PPDM Initial Configuration
Example Script to wait for Appliance Configured
We implemented an Request Wrapper for PPDM API requeststhat utilizes all header ane endpoint variables
NAME
Invoke-PPDMapirequest
SYNTAX
Invoke-PPDMapirequest -OutFile <Object> [-uri <Object>] [-Method {Get | Delete | Put | Post | Patch}] [-Query <Object>] [-ContentType <Object>]
[-ResponseHeadersVariable <Object>] [-apiver <Object>] [-retries <int>] [-timeout <int>] [-apiport <Object>] [-PPDM_API_BaseUri <Object>] [-RequestMethod {Rest | Web}]
[<CommonParameters>]
Invoke-PPDMapirequest -uri <Object> -Method {Get | Delete | Put | Post | Patch} -Query <Object> -InFile <Object> [-ContentType <Object>] [-ResponseHeadersVariable
<Object>] [-apiver <Object>] [-retries <int>] [-timeout <int>] [-apiport <Object>] [-PPDM_API_BaseUri <Object>] [-RequestMethod {Rest | Web}] [<CommonParameters>]
Invoke-PPDMapirequest -uri <Object> [-Method {Get | Delete | Put | Post | Patch}] [-Query <Object>] [-ContentType <Object>] [-ResponseHeadersVariable <Object>] [-apiver
<Object>] [-retries <int>] [-timeout <int>] [-apiport <Object>] [-PPDM_API_BaseUri <Object>] [-RequestMethod {Rest | Web}] [-Body <Object>] [-Filter <Object>]
[<CommonParameters>]
Thus, you only need to specify the relative
Invoke-PPDMapirequest -Method Get -uri /copy-metrics
Note, this will utilize a WebRequest per default and thus return a Json Document, including Response Headers, to be converted
One can utilize the RestMethod via
Invoke-PPDMapirequest -Method Get -RequestMethod Rest -uri /copy-metrics
This will return only content and page as PSobjects, for Headers a Hedervariable must be requested (only need for some POST request )
CommandType Name Version Source
----------- ---- ------- ------
Alias Add-PPDMAssetSource 19.18.22 PPDM-pwsh
Alias Add-PPDMHyperVisor 19.18.22 PPDM-pwsh
Alias Connect-PPDMsystem 19.18.22 PPDM-pwsh
Alias Disable-PPDMProxy 19.18.22 PPDM-pwsh
Alias Get-PPDMagents 19.18.22 PPDM-pwsh
Alias Get-PPDMAssetNetworkAssignments 19.18.22 PPDM-pwsh
Alias Get-PPDMAssetNodes 19.18.22 PPDM-pwsh
Alias Get-PPDMAssetSource 19.18.22 PPDM-pwsh
Alias Get-PPDMFLRfiles 19.18.22 PPDM-pwsh
Alias Get-PPDMidp 19.18.22 PPDM-pwsh
Alias Get-PPDMk8sclusters 19.18.22 PPDM-pwsh
Alias Get-PPDMk8spvcmappings 19.18.22 PPDM-pwsh
Alias Get-PPDMProxy 19.18.22 PPDM-pwsh
Alias Get-PPDMServiceStatus 19.18.22 PPDM-pwsh
Alias Get-PPDMSLAs 19.18.22 PPDM-pwsh
Alias Get-PPDMStorageMetrics 19.18.22 PPDM-pwsh
Alias Get-PPDMVPE 19.18.22 PPDM-pwsh
Alias New-PPDMBackupSLA 19.18.22 PPDM-pwsh
Alias New-PPDMProxy 19.18.22 PPDM-pwsh
Alias Remove-PPDMAssetSource 19.18.22 PPDM-pwsh
Alias Remove-PPDMProxy 19.18.22 PPDM-pwsh
Alias Remove-PPDMSLAs 19.18.22 PPDM-pwsh
Alias Request-PPDMJobLog 19.18.22 PPDM-pwsh
Alias Restore-PPDMDDB_MSSQL 19.18.22 PPDM-pwsh
Alias Restore-PPDMFLR 19.18.22 PPDM-pwsh
Alias Restore-PPDMNASFLR 19.18.22 PPDM-pwsh
Alias Restore-PPDMVMAsset 19.18.22 PPDM-pwsh
Alias Save-PPDMJobLog 19.18.22 PPDM-pwsh
Alias Set-PPDMAsset 19.18.22 PPDM-pwsh
Alias Set-PPDMAssetNetwork 19.18.22 PPDM-pwsh
Alias Set-PPDMAssetSource 19.18.22 PPDM-pwsh
Alias Set-PPDMFLRbrowsescope 19.18.22 PPDM-pwsh
Alias Set-PPDMOIMProtocol 19.18.22 PPDM-pwsh
Alias Start-PPDMPLC 19.18.22 PPDM-pwsh
Alias Start-PPDMPLCStage 19.18.22 PPDM-pwsh
Alias Start-PPDMProtectionStage 19.18.22 PPDM-pwsh
Alias Unregister-PPDMAssetFromPoliy 19.18.22 PPDM-pwsh
Function Add-PPDMcertificates 19.18.22 PPDM-pwsh
Function Add-PPDMinfrastructure_objects 19.18.22 PPDM-pwsh
Function Add-PPDMinventory_sources 19.18.22 PPDM-pwsh
Function Add-PPDMProtection_policy_assignment 19.18.22 PPDM-pwsh
Function Approve-PPDMcertificates 19.18.22 PPDM-pwsh
Function Approve-PPDMEula 19.18.22 PPDM-pwsh
Function Connect-PPDMapiEndpoint 19.18.22 PPDM-pwsh
Function Disable-PPDMprotectionEngineProxy 19.18.22 PPDM-pwsh
Function Disconnect-PPDMsession 19.18.22 PPDM-pwsh
Function Get-PPDMactivities 19.18.22 PPDM-pwsh
Function Get-PPDMactivity_categories 19.18.22 PPDM-pwsh
Function Get-PPDMactivity_metrics 19.18.22 PPDM-pwsh
Function Get-PPDMagents_update_sessions 19.18.22 PPDM-pwsh
Function Get-PPDMagent_registration_status 19.18.22 PPDM-pwsh
Function Get-PPDMalerts 19.18.22 PPDM-pwsh
Function Get-PPDMassetcopies 19.18.22 PPDM-pwsh
Function Get-PPDMassets 19.18.22 PPDM-pwsh
Function Get-PPDMasset_protection_metrics 19.18.22 PPDM-pwsh
Function Get-PPDMaudit_logs 19.18.22 PPDM-pwsh
Function Get-PPDMcertificates 19.18.22 PPDM-pwsh
Function Get-PPDMcloud_dr_accounts 19.18.22 PPDM-pwsh
Function Get-PPDMcloud_dr_data_targets 19.18.22 PPDM-pwsh
Function Get-PPDMcloud_dr_server_configuration 19.18.22 PPDM-pwsh
Function Get-PPDMcloud_dr_server_deployment 19.18.22 PPDM-pwsh
Function Get-PPDMcloud_dr_server_version 19.18.22 PPDM-pwsh
Function Get-PPDMcloud_dr_sessions 19.18.22 PPDM-pwsh
Function Get-PPDMcloud_dr_storage_containers 19.18.22 PPDM-pwsh
Function Get-PPDMcloud_dr_vcenters 19.18.22 PPDM-pwsh
Function Get-PPDMcommon_settings 19.18.22 PPDM-pwsh
Function Get-PPDMcomponents 19.18.22 PPDM-pwsh
Function Get-PPDMconfigstatus 19.18.22 PPDM-pwsh
Function Get-PPDMconfigurations 19.18.22 PPDM-pwsh
Function Get-PPDMcopies 19.18.22 PPDM-pwsh
Function Get-PPDMcopies_query 19.18.22 PPDM-pwsh
Function Get-PPDMcopy_map 19.18.22 PPDM-pwsh
Function Get-PPDMcredentials 19.18.22 PPDM-pwsh
Function Get-PPDMdatacomponents 19.18.22 PPDM-pwsh
Function Get-PPDMdatadomain_cloud_units 19.18.22 PPDM-pwsh
Function Get-PPDMdatadomain_ddboost_encryption_settings 19.18.22 PPDM-pwsh
Function Get-PPDMdatadomain_mtrees 19.18.22 PPDM-pwsh
Function Get-PPDMdatadomain_network_address 19.18.22 PPDM-pwsh
Function Get-PPDMdatadomain_storage_units 19.18.22 PPDM-pwsh
Function Get-PPDMdata_targets 19.18.22 PPDM-pwsh
Function Get-PPDMdiscoveries 19.18.22 PPDM-pwsh
Function Get-PPDMdisks 19.18.22 PPDM-pwsh
Function Get-PPDMesxDatastores 19.18.22 PPDM-pwsh
Function Get-PPDMEula 19.18.22 PPDM-pwsh
Function Get-PPDMexported_copies 19.18.22 PPDM-pwsh
Function Get-PPDMfile_instances 19.18.22 PPDM-pwsh
Function Get-PPDMflr_filelisting 19.18.22 PPDM-pwsh
Function Get-PPDMflr_sessions 19.18.22 PPDM-pwsh
Function Get-PPDMFSAgentFLRBrowselist 19.18.22 PPDM-pwsh
Function Get-PPDMhosts 19.18.22 PPDM-pwsh
Function Get-PPDMhypervisor_root_object 19.18.22 PPDM-pwsh
Function Get-PPDMidentity_providers 19.18.22 PPDM-pwsh
Function Get-PPDMinfrastructure_nodes 19.18.22 PPDM-pwsh
Function Get-PPDMinfrastructure_objects 19.18.22 PPDM-pwsh
Function Get-PPDMinventory_sources 19.18.22 PPDM-pwsh
Function Get-PPDMkubernetes_clusters 19.18.22 PPDM-pwsh
Function Get-PPDMlatest_copies 19.18.22 PPDM-pwsh
Function Get-PPDMlicenses 19.18.22 PPDM-pwsh
Function Get-PPDMlocations 19.18.22 PPDM-pwsh
Function Get-PPDMmfa_bypass_accounts 19.18.22 PPDM-pwsh
Function Get-PPDMmfa_securids 19.18.22 PPDM-pwsh
Function Get-PPDMnetworks 19.18.22 PPDM-pwsh
Function Get-PPDMnodes 19.18.22 PPDM-pwsh
Function Get-PPDMOIMspfile 19.18.22 PPDM-pwsh
Function Get-PPDMpasswordpolicies 19.18.22 PPDM-pwsh
Function Get-PPDMprotectionEngineProxies 19.18.22 PPDM-pwsh
Function Get-PPDMprotection_details 19.18.22 PPDM-pwsh
Function Get-PPDMprotection_engines 19.18.22 PPDM-pwsh
Function Get-PPDMprotection_groups 19.18.22 PPDM-pwsh
Function Get-PPDMprotection_policies 19.18.22 PPDM-pwsh
Function Get-PPDMprotection_policy_summaries 19.18.22 PPDM-pwsh
Function Get-PPDMprotection_rules 19.18.22 PPDM-pwsh
Function Get-PPDMprotection_storage_metrics 19.18.22 PPDM-pwsh
Function Get-PPDMpvc_storage_class_mappings 19.18.22 PPDM-pwsh
Function Get-PPDMreport_nodes 19.18.22 PPDM-pwsh
Function Get-PPDMreport_schedules 19.18.22 PPDM-pwsh
Function Get-PPDMRestored_copies 19.18.22 PPDM-pwsh
Function Get-PPDMrestore_plans 19.18.22 PPDM-pwsh
Function Get-PPDMroles 19.18.22 PPDM-pwsh
Function Get-PPDMrules 19.18.22 PPDM-pwsh
Function Get-PPDMscripts 19.18.22 PPDM-pwsh
Function Get-PPDMscript_contexts 19.18.22 PPDM-pwsh
Function Get-PPDMscript_summaries 19.18.22 PPDM-pwsh
Function Get-PPDMsearch_clusters 19.18.22 PPDM-pwsh
Function Get-PPDMsearch_nodes 19.18.22 PPDM-pwsh
Function Get-PPDMserver_disaster_recovery_backups 19.18.22 PPDM-pwsh
Function Get-PPDMserver_disaster_recovery_configurations 19.18.22 PPDM-pwsh
Function Get-PPDMserver_disaster_recovery_hosts 19.18.22 PPDM-pwsh
Function Get-PPDMserver_disaster_recovery_status 19.18.22 PPDM-pwsh
Function Get-PPDMService_Level_Agreements 19.18.22 PPDM-pwsh
Function Get-PPDMsmtp 19.18.22 PPDM-pwsh
Function Get-PPDMStorageInterfacesDD 19.18.22 PPDM-pwsh
Function Get-PPDMstorage_systems 19.18.22 PPDM-pwsh
Function Get-PPDMstorage_system_metrics 19.18.22 PPDM-pwsh
Function Get-PPDMsystem_health_issues 19.18.22 PPDM-pwsh
Function Get-PPDMsystem_health_score_categories 19.18.22 PPDM-pwsh
Function Get-PPDMTELEMETRY_SETTING 19.18.22 PPDM-pwsh
Function Get-PPDMTimezones 19.18.22 PPDM-pwsh
Function Get-PPDMupgrade_packages 19.18.22 PPDM-pwsh
Function Get-PPDMusers 19.18.22 PPDM-pwsh
Function Get-PPDMuser_groups 19.18.22 PPDM-pwsh
Function Get-PPDMvcenterDatacenters 19.18.22 PPDM-pwsh
Function Get-PPDMvcenterDatastores 19.18.22 PPDM-pwsh
Function Get-PPDMvcenterMorefs 19.18.22 PPDM-pwsh
Function Get-PPDMvm_backup_setting 19.18.22 PPDM-pwsh
Function Get-PPDMWebException 19.18.22 PPDM-pwsh
Function Get-PPDMWhitelist 19.18.22 PPDM-pwsh
Function Invoke-PPDMapirequest 19.18.22 PPDM-pwsh
Function New-PPDMBackupSchedule 19.18.22 PPDM-pwsh
Function New-PPDMBackupService_Level_Agreements 19.18.22 PPDM-pwsh
Function New-PPDMcredentials 19.18.22 PPDM-pwsh
Function New-PPDMDatabaseBackupSchedule 19.18.22 PPDM-pwsh
Function New-PPDMdatadomain_mtrees 19.18.22 PPDM-pwsh
Function New-PPDMdatadomain_storage_units 19.18.22 PPDM-pwsh
Function New-PPDMExchangeBackupPolicy 19.18.22 PPDM-pwsh
Function New-PPDMFSBackupPolicy 19.18.22 PPDM-pwsh
Function New-PPDMJobStatusSummaryReport 19.18.22 PPDM-pwsh
Function New-PPDMK8SBackupPolicy 19.18.22 PPDM-pwsh
Function New-PPDMlocations 19.18.22 PPDM-pwsh
Function New-PPDMmfa_securids 19.18.22 PPDM-pwsh
Function New-PPDMNASBackupPolicy 19.18.22 PPDM-pwsh
Function New-PPDMOracleBackupPolicy 19.18.22 PPDM-pwsh
Function New-PPDMProtectionEngineProxy 19.18.22 PPDM-pwsh
Function New-PPDMprotection_groups 19.18.22 PPDM-pwsh
Function New-PPDMreport_nodes 19.18.22 PPDM-pwsh
Function New-PPDMRestored_copies 19.18.22 PPDM-pwsh
Function New-PPDMsearch_nodes 19.18.22 PPDM-pwsh
Function New-PPDMserver_disaster_recovery_backups 19.18.22 PPDM-pwsh
Function New-PPDMsmtp 19.18.22 PPDM-pwsh
Function New-PPDMSQLBackupPolicy 19.18.22 PPDM-pwsh
Function New-PPDMusers 19.18.22 PPDM-pwsh
Function New-PPDMVMBackupPolicy 19.18.22 PPDM-pwsh
Function Remove-PPDMagents_update_sessions 19.18.22 PPDM-pwsh
Function Remove-PPDMcdrs 19.18.22 PPDM-pwsh
Function Remove-PPDMcertificates 19.18.22 PPDM-pwsh
Function Remove-PPDMcloud_dr_server_deployment 19.18.22 PPDM-pwsh
Function Remove-PPDMcomponents 19.18.22 PPDM-pwsh
Function Remove-PPDMcopies 19.18.22 PPDM-pwsh
Function Remove-PPDMcredentials 19.18.22 PPDM-pwsh
Function Remove-PPDMdatadomain_storage_units 19.18.22 PPDM-pwsh
Function Remove-PPDMexported_copies 19.18.22 PPDM-pwsh
Function Remove-PPDMflr_sessions 19.18.22 PPDM-pwsh
Function Remove-PPDMinventory_sources 19.18.22 PPDM-pwsh
Function Remove-PPDMlocations 19.18.22 PPDM-pwsh
Function Remove-PPDMmfa_bypass_accounts 19.18.22 PPDM-pwsh
Function Remove-PPDMmfa_securids 19.18.22 PPDM-pwsh
Function Remove-PPDMProtectionEngineProxy 19.18.22 PPDM-pwsh
Function Remove-PPDMprotection_policies 19.18.22 PPDM-pwsh
Function Remove-PPDMProtection_policy_assignment 19.18.22 PPDM-pwsh
Function Remove-PPDMprotection_rules 19.18.22 PPDM-pwsh
Function Remove-PPDMrestored_copies 19.18.22 PPDM-pwsh
Function Remove-PPDMscripts 19.18.22 PPDM-pwsh
Function Remove-PPDMserver_disaster_recovery_backups 19.18.22 PPDM-pwsh
Function Remove-PPDMService_Level_Agreements 19.18.22 PPDM-pwsh
Function Remove-PPDMsmtp 19.18.22 PPDM-pwsh
Function Remove-PPDMstorage_systems 19.18.22 PPDM-pwsh
Function Remove-PPDMupgrade 19.18.22 PPDM-pwsh
Function Remove-PPDMWhitelist 19.18.22 PPDM-pwsh
Function Request-PPDMActivityLog 19.18.22 PPDM-pwsh
Function Request-PPDMfile_backups 19.18.22 PPDM-pwsh
Function Request-PPDMreport 19.18.22 PPDM-pwsh
Function Restart-PPDMactivities 19.18.22 PPDM-pwsh
Function Restore-PPDMFileFLR_copies 19.18.22 PPDM-pwsh
Function Restore-PPDMflr_sessions 19.18.22 PPDM-pwsh
Function Restore-PPDMK8Scopies 19.18.22 PPDM-pwsh
Function Restore-PPDMMSSQL_copies 19.18.22 PPDM-pwsh
Function Restore-PPDMNasFiles 19.18.22 PPDM-pwsh
Function Restore-PPDMOracle_copies 19.18.22 PPDM-pwsh
Function Restore-PPDMOracle_OIM_copies 19.18.22 PPDM-pwsh
Function Restore-PPDMVMcopies 19.18.22 PPDM-pwsh
Function Save-PPDMActivityLog 19.18.22 PPDM-pwsh
Function Set-PPDMagents_update_sessions 19.18.22 PPDM-pwsh
Function Set-PPDMalerts_acknowledgement 19.18.22 PPDM-pwsh
Function Set-PPDMapp_hosts 19.18.22 PPDM-pwsh
Function Set-PPDMassets 19.18.22 PPDM-pwsh
Function Set-PPDMasset_networks_batch 19.18.22 PPDM-pwsh
Function Set-PPDMcertificates 19.18.22 PPDM-pwsh
Function Set-PPDMcloud_dr_accounts 19.18.22 PPDM-pwsh
Function Set-PPDMcommon_settings 19.18.22 PPDM-pwsh
Function Set-PPDMcomponents 19.18.22 PPDM-pwsh
Function Set-PPDMconfigurations 19.18.22 PPDM-pwsh
Function Set-PPDMdiscoveries 19.18.22 PPDM-pwsh
Function Set-PPDMexported_copies 19.18.22 PPDM-pwsh
Function Set-PPDMflr_sessions 19.18.22 PPDM-pwsh
Function Set-PPDMghvdm_host_configuration_batch 19.18.22 PPDM-pwsh
Function Set-PPDMinventory_sources 19.18.22 PPDM-pwsh
Function Set-PPDMLicenses 19.18.22 PPDM-pwsh
Function Set-PPDMmfa_bypass_accounts 19.18.22 PPDM-pwsh
Function Set-PPDMmfa_securids 19.18.22 PPDM-pwsh
Function Set-PPDMMSSQLassetStreamcount 19.18.22 PPDM-pwsh
Function Set-PPDMnodes 19.18.22 PPDM-pwsh
Function Set-PPDMOracleOIMProtectionProtocol 19.18.22 PPDM-pwsh
Function Set-PPDMpasswordpolicies 19.18.22 PPDM-pwsh
Function Set-PPDMProtection_Policies 19.18.22 PPDM-pwsh
Function Set-PPDMprotection_rules 19.18.22 PPDM-pwsh
Function Set-PPDMscripts 19.18.22 PPDM-pwsh
Function Set-PPDMserver_disaster_recovery_configurations 19.18.22 PPDM-pwsh
Function Set-PPDMsmtp 19.18.22 PPDM-pwsh
Function Set-PPDMstorage_systems 19.18.22 PPDM-pwsh
Function Set-PPDMuserpassword 19.18.22 PPDM-pwsh
Function Set-PPDMvm_backup_setting 19.18.22 PPDM-pwsh
Function Set-PPDMWhitelist 19.18.22 PPDM-pwsh
Function Start-PPDMdiscoveries 19.18.22 PPDM-pwsh
Function Start-PPDMflr_sessions 19.18.22 PPDM-pwsh
Function Start-PPDMprotection 19.18.22 PPDM-pwsh
Function Start-PPDMprotection_policies 19.18.22 PPDM-pwsh
Function Start-PPDMupgrade 19.18.22 PPDM-pwsh
Function Start-PPDMupgradePrecheck 19.18.22 PPDM-pwsh
Function Stop-PPDMactivities 19.18.22 PPDM-pwsh
Function Stop-PPDMupgrade 19.18.22 PPDM-pwsh
Function Stop-PPDMupgradePrecheck 19.18.22 PPDM-pwsh
Function Unblock-PPDMSSLCerts 19.18.22 PPDM-pwsh
Function Update-PPDMaudit_logs 19.18.22 PPDM-pwsh
Function Update-PPDMcertificates 19.18.22 PPDM-pwsh
Function Update-PPDMcredentials 19.18.22 PPDM-pwsh
Function Update-PPDMscripts 19.18.22 PPDM-pwsh
Function Update-PPDMserver_disaster_recovery_backups 19.18.22 PPDM-pwsh
Function Update-PPDMToken 19.18.22 PPDM-pwsh
Function Update-PPDMWhitelist 19.18.22 PPDM-pwsh
Function Wait-PPDMApplianceFresh 19.18.22 PPDM-pwsh