49254 lines
2.3 MiB
Plaintext
Executable File
49254 lines
2.3 MiB
Plaintext
Executable File
<!--
|
|
SPDX-FileCopyrightText: Copyright Corsinvest Srl
|
|
SPDX-License-Identifier: GPL-3.0-only
|
|
-->
|
|
<html>
|
|
<head>
|
|
<meta charset='utf-8'>
|
|
<meta name='viewport' content='width=device-width, initial-scale=1, shrink-to-fit=no'>
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/css/bootstrap.min.css"
|
|
integrity="sha384-rbsA2VBKQhggwzxH7pPCaAqO46MgnOM80zW1RWuH61DGLwZJEdK2Kadq2F9CUG65"
|
|
crossorigin="anonymous">
|
|
|
|
<link rel="stylesheet"
|
|
href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/default.min.css" />
|
|
|
|
<title>Documentation cv4pve-api-powershell PowerShell for Proxmox VE</title>
|
|
<meta name='generator' content='cv4pve-api-powershell - Build-PveDocumentation'>
|
|
<style>
|
|
body { font-size: .875rem; }
|
|
|
|
.feather {
|
|
width: 16px;
|
|
height: 16px;
|
|
vertical-align: text-bottom;
|
|
}
|
|
|
|
/* Sidebar */
|
|
|
|
.sidebar {
|
|
position: fixed;
|
|
top: 0;
|
|
bottom: 0;
|
|
left: 0;
|
|
z-index: 100;
|
|
/* Behind the navbar */
|
|
padding: 48px 0 0;
|
|
/* Height of navbar */
|
|
box-shadow: inset -1px 0 0 rgba(0, 0, 0, .1);
|
|
}
|
|
|
|
@media (max-width: 767.98px) {
|
|
.sidebar { top: 5rem; }
|
|
}
|
|
|
|
.sidebar-sticky {
|
|
position: relative;
|
|
top: 0;
|
|
height: calc(100vh - 48px - 50px);
|
|
padding-top: .5rem;
|
|
overflow-x: hidden;
|
|
overflow-y: auto;
|
|
/* Scrollable contents if viewport is shorter than content. */
|
|
}
|
|
|
|
.sidebar .nav-link {
|
|
font-weight: 500;
|
|
color: #333;
|
|
}
|
|
|
|
.sidebar .nav-link .feather {
|
|
margin-right: 4px;
|
|
color: #999;
|
|
}
|
|
|
|
.sidebar .nav-link.active { color: var(--bs-primary); }
|
|
|
|
.sidebar .nav-link:hover .feather,
|
|
.sidebar .nav-link.active .feather { color: inherit; }
|
|
|
|
.sidebar-heading {
|
|
font-size: .75rem;
|
|
text-transform: uppercase;
|
|
}
|
|
|
|
/* Navbar */
|
|
|
|
.navbar-brand {
|
|
padding-top: .75rem;
|
|
padding-bottom: .75rem;
|
|
font-size: 1rem;
|
|
background-color: rgba(0, 0, 0, .25);
|
|
box-shadow: inset -1px 0 0 rgba(0, 0, 0, .25);
|
|
}
|
|
|
|
.container-fluid { padding-bottom: 50px; }
|
|
|
|
.main-data-hidden { visibility: hidden; }
|
|
</style>
|
|
</head>
|
|
|
|
<body>
|
|
<nav class='navbar navbar-dark sticky-top bg-primary flex-md-nowrap p-0 shadow'>
|
|
<a class='navbar-brand col-md-3 col-lg-2 bg-primary mr-0 px-3' href='#'>Documentation cv4pve-api-powershell</a>
|
|
<ul class='navbar-nav px-1'> </ul>
|
|
|
|
<div class='input-group'>
|
|
<div class='input-group-text'>
|
|
<input id='searchAll' class='form-check-input mt-0' type='checkbox' aria-label='Checkbox for following text input'> Full text
|
|
</div>
|
|
|
|
<input class='form-control form-control-dark w-1001' type='text' id='navSearch' placeholder='Search'
|
|
aria-label='Search'>
|
|
</div>
|
|
<ul class='navbar-nav px-1'> </ul>
|
|
</nav>
|
|
|
|
<div class='container-fluid'>
|
|
<div class='row'>
|
|
<nav id='sidebarMenu' class='col-md-3 col-lg-2 d-md-block bg-light sidebar border border-right'>
|
|
<div class='sidebar-sticky pt-3'>
|
|
<ul class='nav flex-column' id='lstNav'>
|
|
<li class='nav-item'><a class='nav-link' href='#GettingStarted'>Getting Started</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Build-PveDocumentation'>Build-PveDocumentation</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Connect-PveCluster'>Connect-PveCluster</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#ConvertFrom-PveUnixTime'>ConvertFrom-PveUnixTime</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#ConvertTo-PveUnixTime'>ConvertTo-PveUnixTime</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Enter-PveSpice'>Enter-PveSpice</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveAccess'>Get-PveAccess</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveAccessAcl'>Get-PveAccessAcl</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveAccessDomains'>Get-PveAccessDomains</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveAccessDomainsIdx'>Get-PveAccessDomainsIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveAccessGroups'>Get-PveAccessGroups</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveAccessGroupsIdx'>Get-PveAccessGroupsIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveAccessOpenid'>Get-PveAccessOpenid</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveAccessPermissions'>Get-PveAccessPermissions</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveAccessRoles'>Get-PveAccessRoles</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveAccessRolesIdx'>Get-PveAccessRolesIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveAccessTfa'>Get-PveAccessTfa</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveAccessTfaIdx'>Get-PveAccessTfaIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveAccessTicket'>Get-PveAccessTicket</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveAccessUsers'>Get-PveAccessUsers</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveAccessUsersIdx'>Get-PveAccessUsersIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveAccessUsersTfa'>Get-PveAccessUsersTfa</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveAccessUsersToken'>Get-PveAccessUsersToken</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveAccessUsersTokenIdx'>Get-PveAccessUsersTokenIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveCluster'>Get-PveCluster</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterAcme'>Get-PveClusterAcme</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterAcmeAccount'>Get-PveClusterAcmeAccount</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterAcmeAccountIdx'>Get-PveClusterAcmeAccountIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterAcmeChallengeSchema'>Get-PveClusterAcmeChallengeSchema</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterAcmeDirectories'>Get-PveClusterAcmeDirectories</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterAcmeMeta'>Get-PveClusterAcmeMeta</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterAcmePlugins'>Get-PveClusterAcmePlugins</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterAcmePluginsIdx'>Get-PveClusterAcmePluginsIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterAcmeTos'>Get-PveClusterAcmeTos</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterBackup'>Get-PveClusterBackup</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterBackupIdx'>Get-PveClusterBackupIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterBackupIncludedVolumes'>Get-PveClusterBackupIncludedVolumes</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterBackupInfo'>Get-PveClusterBackupInfo</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterBackupInfoNotBackedUp'>Get-PveClusterBackupInfoNotBackedUp</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterCeph'>Get-PveClusterCeph</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterCephFlags'>Get-PveClusterCephFlags</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterCephFlagsIdx'>Get-PveClusterCephFlagsIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterCephMetadata'>Get-PveClusterCephMetadata</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterCephStatus'>Get-PveClusterCephStatus</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterConfig'>Get-PveClusterConfig</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterConfigApiversion'>Get-PveClusterConfigApiversion</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterConfigJoin'>Get-PveClusterConfigJoin</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterConfigNodes'>Get-PveClusterConfigNodes</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterConfigQdevice'>Get-PveClusterConfigQdevice</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterConfigTotem'>Get-PveClusterConfigTotem</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterFirewall'>Get-PveClusterFirewall</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterFirewallAliases'>Get-PveClusterFirewallAliases</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterFirewallAliasesIdx'>Get-PveClusterFirewallAliasesIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterFirewallGroups'>Get-PveClusterFirewallGroups</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterFirewallGroupsIdx'>Get-PveClusterFirewallGroupsIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterFirewallIpset'>Get-PveClusterFirewallIpset</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterFirewallIpsetIdx'>Get-PveClusterFirewallIpsetIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterFirewallMacros'>Get-PveClusterFirewallMacros</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterFirewallOptions'>Get-PveClusterFirewallOptions</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterFirewallRefs'>Get-PveClusterFirewallRefs</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterFirewallRules'>Get-PveClusterFirewallRules</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterFirewallRulesIdx'>Get-PveClusterFirewallRulesIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterHa'>Get-PveClusterHa</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterHaGroups'>Get-PveClusterHaGroups</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterHaGroupsIdx'>Get-PveClusterHaGroupsIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterHaResources'>Get-PveClusterHaResources</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterHaResourcesIdx'>Get-PveClusterHaResourcesIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterHaStatus'>Get-PveClusterHaStatus</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterHaStatusCurrent'>Get-PveClusterHaStatusCurrent</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterHaStatusManagerStatus'>Get-PveClusterHaStatusManagerStatus</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterJobs'>Get-PveClusterJobs</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterJobsRealmSync'>Get-PveClusterJobsRealmSync</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterJobsRealmSyncIdx'>Get-PveClusterJobsRealmSyncIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterJobsScheduleAnalyze'>Get-PveClusterJobsScheduleAnalyze</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterLog'>Get-PveClusterLog</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterMapping'>Get-PveClusterMapping</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterMappingPci'>Get-PveClusterMappingPci</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterMappingPciIdx'>Get-PveClusterMappingPciIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterMappingUsb'>Get-PveClusterMappingUsb</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterMappingUsbIdx'>Get-PveClusterMappingUsbIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterMetrics'>Get-PveClusterMetrics</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterMetricsServer'>Get-PveClusterMetricsServer</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterMetricsServerIdx'>Get-PveClusterMetricsServerIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterNextid'>Get-PveClusterNextid</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterNotifications'>Get-PveClusterNotifications</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterNotificationsEndpoints'>Get-PveClusterNotificationsEndpoints</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterNotificationsEndpointsGotify'>Get-PveClusterNotificationsEndpointsGotify</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterNotificationsEndpointsGotifyIdx'>Get-PveClusterNotificationsEndpointsGotifyIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterNotificationsEndpointsSendmail'>Get-PveClusterNotificationsEndpointsSendmail</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterNotificationsEndpointsSendmailIdx'>Get-PveClusterNotificationsEndpointsSendmailIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterNotificationsEndpointsSmtp'>Get-PveClusterNotificationsEndpointsSmtp</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterNotificationsEndpointsSmtpIdx'>Get-PveClusterNotificationsEndpointsSmtpIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterNotificationsMatchers'>Get-PveClusterNotificationsMatchers</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterNotificationsMatchersIdx'>Get-PveClusterNotificationsMatchersIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterNotificationsTargets'>Get-PveClusterNotificationsTargets</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterOptions'>Get-PveClusterOptions</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterReplication'>Get-PveClusterReplication</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterReplicationIdx'>Get-PveClusterReplicationIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterResources'>Get-PveClusterResources</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterSdn'>Get-PveClusterSdn</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterSdnControllers'>Get-PveClusterSdnControllers</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterSdnControllersIdx'>Get-PveClusterSdnControllersIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterSdnDns'>Get-PveClusterSdnDns</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterSdnDnsIdx'>Get-PveClusterSdnDnsIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterSdnIpams'>Get-PveClusterSdnIpams</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterSdnIpamsIdx'>Get-PveClusterSdnIpamsIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterSdnIpamsStatus'>Get-PveClusterSdnIpamsStatus</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterSdnVnets'>Get-PveClusterSdnVnets</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterSdnVnetsIdx'>Get-PveClusterSdnVnetsIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterSdnVnetsSubnets'>Get-PveClusterSdnVnetsSubnets</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterSdnVnetsSubnetsIdx'>Get-PveClusterSdnVnetsSubnetsIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterSdnZones'>Get-PveClusterSdnZones</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterSdnZonesIdx'>Get-PveClusterSdnZonesIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterStatus'>Get-PveClusterStatus</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveClusterTasks'>Get-PveClusterTasks</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNode'>Get-PveNode</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodes'>Get-PveNodes</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesAplinfo'>Get-PveNodesAplinfo</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesApt'>Get-PveNodesApt</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesAptChangelog'>Get-PveNodesAptChangelog</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesAptRepositories'>Get-PveNodesAptRepositories</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesAptUpdate'>Get-PveNodesAptUpdate</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesAptVersions'>Get-PveNodesAptVersions</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesCapabilities'>Get-PveNodesCapabilities</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesCapabilitiesQemu'>Get-PveNodesCapabilitiesQemu</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesCapabilitiesQemuCpu'>Get-PveNodesCapabilitiesQemuCpu</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesCapabilitiesQemuMachines'>Get-PveNodesCapabilitiesQemuMachines</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesCeph'>Get-PveNodesCeph</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesCephCfg'>Get-PveNodesCephCfg</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesCephCfgDb'>Get-PveNodesCephCfgDb</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesCephCfgRaw'>Get-PveNodesCephCfgRaw</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesCephCfgValue'>Get-PveNodesCephCfgValue</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesCephCmdSafety'>Get-PveNodesCephCmdSafety</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesCephCrush'>Get-PveNodesCephCrush</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesCephFs'>Get-PveNodesCephFs</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesCephLog'>Get-PveNodesCephLog</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesCephMds'>Get-PveNodesCephMds</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesCephMgr'>Get-PveNodesCephMgr</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesCephMon'>Get-PveNodesCephMon</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesCephOsd'>Get-PveNodesCephOsd</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesCephOsdIdx'>Get-PveNodesCephOsdIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesCephOsdLvInfo'>Get-PveNodesCephOsdLvInfo</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesCephOsdMetadata'>Get-PveNodesCephOsdMetadata</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesCephPool'>Get-PveNodesCephPool</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesCephPoolIdx'>Get-PveNodesCephPoolIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesCephPoolStatus'>Get-PveNodesCephPoolStatus</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesCephRules'>Get-PveNodesCephRules</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesCephStatus'>Get-PveNodesCephStatus</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesCertificates'>Get-PveNodesCertificates</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesCertificatesAcme'>Get-PveNodesCertificatesAcme</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesCertificatesInfo'>Get-PveNodesCertificatesInfo</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesConfig'>Get-PveNodesConfig</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesDisks'>Get-PveNodesDisks</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesDisksDirectory'>Get-PveNodesDisksDirectory</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesDisksList'>Get-PveNodesDisksList</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesDisksLvm'>Get-PveNodesDisksLvm</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesDisksLvmthin'>Get-PveNodesDisksLvmthin</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesDisksSmart'>Get-PveNodesDisksSmart</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesDisksZfs'>Get-PveNodesDisksZfs</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesDisksZfsIdx'>Get-PveNodesDisksZfsIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesDns'>Get-PveNodesDns</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesFirewall'>Get-PveNodesFirewall</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesFirewallLog'>Get-PveNodesFirewallLog</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesFirewallOptions'>Get-PveNodesFirewallOptions</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesFirewallRules'>Get-PveNodesFirewallRules</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesFirewallRulesIdx'>Get-PveNodesFirewallRulesIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesHardware'>Get-PveNodesHardware</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesHardwarePci'>Get-PveNodesHardwarePci</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesHardwarePciIdx'>Get-PveNodesHardwarePciIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesHardwarePciMdev'>Get-PveNodesHardwarePciMdev</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesHardwareUsb'>Get-PveNodesHardwareUsb</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesHosts'>Get-PveNodesHosts</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesIdx'>Get-PveNodesIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesJournal'>Get-PveNodesJournal</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesLxc'>Get-PveNodesLxc</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesLxcConfig'>Get-PveNodesLxcConfig</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesLxcFeature'>Get-PveNodesLxcFeature</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesLxcFirewall'>Get-PveNodesLxcFirewall</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesLxcFirewallAliases'>Get-PveNodesLxcFirewallAliases</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesLxcFirewallAliasesIdx'>Get-PveNodesLxcFirewallAliasesIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesLxcFirewallIpset'>Get-PveNodesLxcFirewallIpset</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesLxcFirewallIpsetIdx'>Get-PveNodesLxcFirewallIpsetIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesLxcFirewallLog'>Get-PveNodesLxcFirewallLog</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesLxcFirewallOptions'>Get-PveNodesLxcFirewallOptions</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesLxcFirewallRefs'>Get-PveNodesLxcFirewallRefs</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesLxcFirewallRules'>Get-PveNodesLxcFirewallRules</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesLxcFirewallRulesIdx'>Get-PveNodesLxcFirewallRulesIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesLxcIdx'>Get-PveNodesLxcIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesLxcInterfaces'>Get-PveNodesLxcInterfaces</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesLxcMtunnelwebsocket'>Get-PveNodesLxcMtunnelwebsocket</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesLxcPending'>Get-PveNodesLxcPending</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesLxcRrd'>Get-PveNodesLxcRrd</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesLxcRrddata'>Get-PveNodesLxcRrddata</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesLxcSnapshot'>Get-PveNodesLxcSnapshot</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesLxcSnapshotConfig'>Get-PveNodesLxcSnapshotConfig</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesLxcSnapshotIdx'>Get-PveNodesLxcSnapshotIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesLxcStatus'>Get-PveNodesLxcStatus</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesLxcStatusCurrent'>Get-PveNodesLxcStatusCurrent</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesLxcVncwebsocket'>Get-PveNodesLxcVncwebsocket</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesNetstat'>Get-PveNodesNetstat</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesNetwork'>Get-PveNodesNetwork</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesNetworkIdx'>Get-PveNodesNetworkIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemu'>Get-PveNodesQemu</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuAgent'>Get-PveNodesQemuAgent</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuAgentExecStatus'>Get-PveNodesQemuAgentExecStatus</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuAgentFileRead'>Get-PveNodesQemuAgentFileRead</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuAgentGetFsinfo'>Get-PveNodesQemuAgentGetFsinfo</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuAgentGetHostName'>Get-PveNodesQemuAgentGetHostName</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuAgentGetMemoryBlockInfo'>Get-PveNodesQemuAgentGetMemoryBlockInfo</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuAgentGetMemoryBlocks'>Get-PveNodesQemuAgentGetMemoryBlocks</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuAgentGetOsinfo'>Get-PveNodesQemuAgentGetOsinfo</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuAgentGetTime'>Get-PveNodesQemuAgentGetTime</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuAgentGetTimezone'>Get-PveNodesQemuAgentGetTimezone</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuAgentGetUsers'>Get-PveNodesQemuAgentGetUsers</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuAgentGetVcpus'>Get-PveNodesQemuAgentGetVcpus</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuAgentInfo'>Get-PveNodesQemuAgentInfo</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuAgentNetworkGetInterfaces'>Get-PveNodesQemuAgentNetworkGetInterfaces</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuCloudinit'>Get-PveNodesQemuCloudinit</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuCloudinitDump'>Get-PveNodesQemuCloudinitDump</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuConfig'>Get-PveNodesQemuConfig</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuFeature'>Get-PveNodesQemuFeature</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuFirewall'>Get-PveNodesQemuFirewall</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuFirewallAliases'>Get-PveNodesQemuFirewallAliases</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuFirewallAliasesIdx'>Get-PveNodesQemuFirewallAliasesIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuFirewallIpset'>Get-PveNodesQemuFirewallIpset</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuFirewallIpsetIdx'>Get-PveNodesQemuFirewallIpsetIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuFirewallLog'>Get-PveNodesQemuFirewallLog</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuFirewallOptions'>Get-PveNodesQemuFirewallOptions</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuFirewallRefs'>Get-PveNodesQemuFirewallRefs</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuFirewallRules'>Get-PveNodesQemuFirewallRules</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuFirewallRulesIdx'>Get-PveNodesQemuFirewallRulesIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuIdx'>Get-PveNodesQemuIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuMigrate'>Get-PveNodesQemuMigrate</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuMtunnelwebsocket'>Get-PveNodesQemuMtunnelwebsocket</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuPending'>Get-PveNodesQemuPending</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuRrd'>Get-PveNodesQemuRrd</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuRrddata'>Get-PveNodesQemuRrddata</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuSnapshot'>Get-PveNodesQemuSnapshot</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuSnapshotConfig'>Get-PveNodesQemuSnapshotConfig</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuSnapshotIdx'>Get-PveNodesQemuSnapshotIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuStatus'>Get-PveNodesQemuStatus</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuStatusCurrent'>Get-PveNodesQemuStatusCurrent</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQemuVncwebsocket'>Get-PveNodesQemuVncwebsocket</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesQueryUrlMetadata'>Get-PveNodesQueryUrlMetadata</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesReplication'>Get-PveNodesReplication</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesReplicationIdx'>Get-PveNodesReplicationIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesReplicationLog'>Get-PveNodesReplicationLog</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesReplicationStatus'>Get-PveNodesReplicationStatus</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesReport'>Get-PveNodesReport</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesRrd'>Get-PveNodesRrd</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesRrddata'>Get-PveNodesRrddata</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesScan'>Get-PveNodesScan</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesScanCifs'>Get-PveNodesScanCifs</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesScanGlusterfs'>Get-PveNodesScanGlusterfs</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesScanIscsi'>Get-PveNodesScanIscsi</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesScanLvm'>Get-PveNodesScanLvm</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesScanLvmthin'>Get-PveNodesScanLvmthin</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesScanNfs'>Get-PveNodesScanNfs</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesScanPbs'>Get-PveNodesScanPbs</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesScanZfs'>Get-PveNodesScanZfs</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesSdn'>Get-PveNodesSdn</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesSdnZones'>Get-PveNodesSdnZones</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesSdnZonesContent'>Get-PveNodesSdnZonesContent</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesSdnZonesIdx'>Get-PveNodesSdnZonesIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesServices'>Get-PveNodesServices</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesServicesIdx'>Get-PveNodesServicesIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesServicesState'>Get-PveNodesServicesState</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesStatus'>Get-PveNodesStatus</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesStorage'>Get-PveNodesStorage</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesStorageContent'>Get-PveNodesStorageContent</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesStorageContentIdx'>Get-PveNodesStorageContentIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesStorageIdx'>Get-PveNodesStorageIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesStoragePrunebackups'>Get-PveNodesStoragePrunebackups</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesStorageRrd'>Get-PveNodesStorageRrd</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesStorageRrddata'>Get-PveNodesStorageRrddata</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesStorageStatus'>Get-PveNodesStorageStatus</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesSubscription'>Get-PveNodesSubscription</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesSyslog'>Get-PveNodesSyslog</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesTasks'>Get-PveNodesTasks</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesTasksIdx'>Get-PveNodesTasksIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesTasksLog'>Get-PveNodesTasksLog</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesTasksStatus'>Get-PveNodesTasksStatus</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesTime'>Get-PveNodesTime</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesVersion'>Get-PveNodesVersion</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesVncwebsocket'>Get-PveNodesVncwebsocket</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesVzdumpDefaults'>Get-PveNodesVzdumpDefaults</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveNodesVzdumpExtractconfig'>Get-PveNodesVzdumpExtractconfig</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PvePools'>Get-PvePools</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PvePoolsIdx'>Get-PvePoolsIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveStorage'>Get-PveStorage</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveStorageIdx'>Get-PveStorageIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveTaskIsRunning'>Get-PveTaskIsRunning</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveVersion'>Get-PveVersion</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveVm'>Get-PveVm</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Get-PveVmSnapshot'>Get-PveVmSnapshot</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Invoke-PveRestApi'>Invoke-PveRestApi</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#IsNumeric'>IsNumeric</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveAccessDomains'>New-PveAccessDomains</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveAccessDomainsSync'>New-PveAccessDomainsSync</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveAccessGroups'>New-PveAccessGroups</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveAccessOpenidAuthUrl'>New-PveAccessOpenidAuthUrl</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveAccessOpenidLogin'>New-PveAccessOpenidLogin</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveAccessRoles'>New-PveAccessRoles</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveAccessTfa'>New-PveAccessTfa</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveAccessTicket'>New-PveAccessTicket</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveAccessUsers'>New-PveAccessUsers</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveAccessUsersToken'>New-PveAccessUsersToken</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterAcmeAccount'>New-PveClusterAcmeAccount</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterAcmePlugins'>New-PveClusterAcmePlugins</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterBackup'>New-PveClusterBackup</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterConfig'>New-PveClusterConfig</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterConfigJoin'>New-PveClusterConfigJoin</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterConfigNodes'>New-PveClusterConfigNodes</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterFirewallAliases'>New-PveClusterFirewallAliases</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterFirewallGroups'>New-PveClusterFirewallGroups</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterFirewallGroupsIdx'>New-PveClusterFirewallGroupsIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterFirewallIpset'>New-PveClusterFirewallIpset</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterFirewallIpsetIdx'>New-PveClusterFirewallIpsetIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterFirewallRules'>New-PveClusterFirewallRules</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterHaGroups'>New-PveClusterHaGroups</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterHaResources'>New-PveClusterHaResources</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterHaResourcesMigrate'>New-PveClusterHaResourcesMigrate</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterHaResourcesRelocate'>New-PveClusterHaResourcesRelocate</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterJobsRealmSync'>New-PveClusterJobsRealmSync</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterMappingPci'>New-PveClusterMappingPci</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterMappingUsb'>New-PveClusterMappingUsb</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterMetricsServer'>New-PveClusterMetricsServer</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterNotificationsEndpointsGotify'>New-PveClusterNotificationsEndpointsGotify</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterNotificationsEndpointsSendmail'>New-PveClusterNotificationsEndpointsSendmail</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterNotificationsEndpointsSmtp'>New-PveClusterNotificationsEndpointsSmtp</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterNotificationsMatchers'>New-PveClusterNotificationsMatchers</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterReplication'>New-PveClusterReplication</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterSdnControllers'>New-PveClusterSdnControllers</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterSdnDns'>New-PveClusterSdnDns</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterSdnIpams'>New-PveClusterSdnIpams</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterSdnVnets'>New-PveClusterSdnVnets</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterSdnVnetsIps'>New-PveClusterSdnVnetsIps</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterSdnVnetsSubnets'>New-PveClusterSdnVnetsSubnets</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveClusterSdnZones'>New-PveClusterSdnZones</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesAplinfo'>New-PveNodesAplinfo</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesAptRepositories'>New-PveNodesAptRepositories</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesAptUpdate'>New-PveNodesAptUpdate</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesCephFs'>New-PveNodesCephFs</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesCephInit'>New-PveNodesCephInit</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesCephMds'>New-PveNodesCephMds</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesCephMgr'>New-PveNodesCephMgr</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesCephMon'>New-PveNodesCephMon</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesCephOsd'>New-PveNodesCephOsd</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesCephOsdIn'>New-PveNodesCephOsdIn</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesCephOsdOut'>New-PveNodesCephOsdOut</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesCephOsdScrub'>New-PveNodesCephOsdScrub</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesCephPool'>New-PveNodesCephPool</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesCephRestart'>New-PveNodesCephRestart</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesCephStart'>New-PveNodesCephStart</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesCephStop'>New-PveNodesCephStop</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesCertificatesAcmeCertificate'>New-PveNodesCertificatesAcmeCertificate</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesCertificatesCustom'>New-PveNodesCertificatesCustom</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesDisksDirectory'>New-PveNodesDisksDirectory</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesDisksInitgpt'>New-PveNodesDisksInitgpt</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesDisksLvm'>New-PveNodesDisksLvm</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesDisksLvmthin'>New-PveNodesDisksLvmthin</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesDisksZfs'>New-PveNodesDisksZfs</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesExecute'>New-PveNodesExecute</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesFirewallRules'>New-PveNodesFirewallRules</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesHosts'>New-PveNodesHosts</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesLxc'>New-PveNodesLxc</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesLxcClone'>New-PveNodesLxcClone</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesLxcFirewallAliases'>New-PveNodesLxcFirewallAliases</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesLxcFirewallIpset'>New-PveNodesLxcFirewallIpset</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesLxcFirewallIpsetIdx'>New-PveNodesLxcFirewallIpsetIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesLxcFirewallRules'>New-PveNodesLxcFirewallRules</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesLxcMigrate'>New-PveNodesLxcMigrate</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesLxcMoveVolume'>New-PveNodesLxcMoveVolume</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesLxcMtunnel'>New-PveNodesLxcMtunnel</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesLxcRemoteMigrate'>New-PveNodesLxcRemoteMigrate</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesLxcSnapshot'>New-PveNodesLxcSnapshot</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesLxcSnapshotRollback'>New-PveNodesLxcSnapshotRollback</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesLxcSpiceproxy'>New-PveNodesLxcSpiceproxy</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesLxcStatusReboot'>New-PveNodesLxcStatusReboot</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesLxcStatusResume'>New-PveNodesLxcStatusResume</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesLxcStatusShutdown'>New-PveNodesLxcStatusShutdown</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesLxcStatusStart'>New-PveNodesLxcStatusStart</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesLxcStatusStop'>New-PveNodesLxcStatusStop</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesLxcStatusSuspend'>New-PveNodesLxcStatusSuspend</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesLxcTemplate'>New-PveNodesLxcTemplate</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesLxcTermproxy'>New-PveNodesLxcTermproxy</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesLxcVncproxy'>New-PveNodesLxcVncproxy</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesMigrateall'>New-PveNodesMigrateall</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesNetwork'>New-PveNodesNetwork</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemu'>New-PveNodesQemu</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuAgent'>New-PveNodesQemuAgent</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuAgentExec'>New-PveNodesQemuAgentExec</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuAgentFileWrite'>New-PveNodesQemuAgentFileWrite</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuAgentFsfreezeFreeze'>New-PveNodesQemuAgentFsfreezeFreeze</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuAgentFsfreezeStatus'>New-PveNodesQemuAgentFsfreezeStatus</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuAgentFsfreezeThaw'>New-PveNodesQemuAgentFsfreezeThaw</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuAgentFstrim'>New-PveNodesQemuAgentFstrim</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuAgentPing'>New-PveNodesQemuAgentPing</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuAgentSetUserPassword'>New-PveNodesQemuAgentSetUserPassword</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuAgentShutdown'>New-PveNodesQemuAgentShutdown</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuAgentSuspendDisk'>New-PveNodesQemuAgentSuspendDisk</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuAgentSuspendHybrid'>New-PveNodesQemuAgentSuspendHybrid</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuAgentSuspendRam'>New-PveNodesQemuAgentSuspendRam</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuClone'>New-PveNodesQemuClone</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuConfig'>New-PveNodesQemuConfig</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuFirewallAliases'>New-PveNodesQemuFirewallAliases</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuFirewallIpset'>New-PveNodesQemuFirewallIpset</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuFirewallIpsetIdx'>New-PveNodesQemuFirewallIpsetIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuFirewallRules'>New-PveNodesQemuFirewallRules</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuMigrate'>New-PveNodesQemuMigrate</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuMonitor'>New-PveNodesQemuMonitor</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuMoveDisk'>New-PveNodesQemuMoveDisk</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuMtunnel'>New-PveNodesQemuMtunnel</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuRemoteMigrate'>New-PveNodesQemuRemoteMigrate</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuSnapshot'>New-PveNodesQemuSnapshot</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuSnapshotRollback'>New-PveNodesQemuSnapshotRollback</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuSpiceproxy'>New-PveNodesQemuSpiceproxy</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuStatusReboot'>New-PveNodesQemuStatusReboot</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuStatusReset'>New-PveNodesQemuStatusReset</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuStatusResume'>New-PveNodesQemuStatusResume</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuStatusShutdown'>New-PveNodesQemuStatusShutdown</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuStatusStart'>New-PveNodesQemuStatusStart</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuStatusStop'>New-PveNodesQemuStatusStop</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuStatusSuspend'>New-PveNodesQemuStatusSuspend</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuTemplate'>New-PveNodesQemuTemplate</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuTermproxy'>New-PveNodesQemuTermproxy</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesQemuVncproxy'>New-PveNodesQemuVncproxy</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesReplicationScheduleNow'>New-PveNodesReplicationScheduleNow</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesServicesReload'>New-PveNodesServicesReload</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesServicesRestart'>New-PveNodesServicesRestart</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesServicesStart'>New-PveNodesServicesStart</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesServicesStop'>New-PveNodesServicesStop</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesSpiceshell'>New-PveNodesSpiceshell</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesStartall'>New-PveNodesStartall</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesStatus'>New-PveNodesStatus</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesStopall'>New-PveNodesStopall</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesStorageContent'>New-PveNodesStorageContent</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesStorageContentIdx'>New-PveNodesStorageContentIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesStorageDownloadUrl'>New-PveNodesStorageDownloadUrl</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesStorageUpload'>New-PveNodesStorageUpload</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesSubscription'>New-PveNodesSubscription</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesSuspendall'>New-PveNodesSuspendall</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesTermproxy'>New-PveNodesTermproxy</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesVncshell'>New-PveNodesVncshell</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesVzdump'>New-PveNodesVzdump</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveNodesWakeonlan'>New-PveNodesWakeonlan</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PvePools'>New-PvePools</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveStorage'>New-PveStorage</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#New-PveVmSnapshot'>New-PveVmSnapshot</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveAccessDomains'>Remove-PveAccessDomains</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveAccessGroups'>Remove-PveAccessGroups</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveAccessRoles'>Remove-PveAccessRoles</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveAccessTfa'>Remove-PveAccessTfa</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveAccessUsers'>Remove-PveAccessUsers</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveAccessUsersToken'>Remove-PveAccessUsersToken</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveClusterAcmeAccount'>Remove-PveClusterAcmeAccount</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveClusterAcmePlugins'>Remove-PveClusterAcmePlugins</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveClusterBackup'>Remove-PveClusterBackup</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveClusterConfigNodes'>Remove-PveClusterConfigNodes</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveClusterFirewallAliases'>Remove-PveClusterFirewallAliases</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveClusterFirewallGroups'>Remove-PveClusterFirewallGroups</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveClusterFirewallGroupsIdx'>Remove-PveClusterFirewallGroupsIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveClusterFirewallIpset'>Remove-PveClusterFirewallIpset</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveClusterFirewallIpsetIdx'>Remove-PveClusterFirewallIpsetIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveClusterFirewallRules'>Remove-PveClusterFirewallRules</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveClusterHaGroups'>Remove-PveClusterHaGroups</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveClusterHaResources'>Remove-PveClusterHaResources</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveClusterJobsRealmSync'>Remove-PveClusterJobsRealmSync</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveClusterMappingPci'>Remove-PveClusterMappingPci</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveClusterMappingUsb'>Remove-PveClusterMappingUsb</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveClusterMetricsServer'>Remove-PveClusterMetricsServer</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveClusterNotificationsEndpointsGotify'>Remove-PveClusterNotificationsEndpointsGotify</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveClusterNotificationsEndpointsSendmail'>Remove-PveClusterNotificationsEndpointsSendmail</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveClusterNotificationsEndpointsSmtp'>Remove-PveClusterNotificationsEndpointsSmtp</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveClusterNotificationsMatchers'>Remove-PveClusterNotificationsMatchers</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveClusterReplication'>Remove-PveClusterReplication</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveClusterSdnControllers'>Remove-PveClusterSdnControllers</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveClusterSdnDns'>Remove-PveClusterSdnDns</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveClusterSdnIpams'>Remove-PveClusterSdnIpams</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveClusterSdnVnets'>Remove-PveClusterSdnVnets</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveClusterSdnVnetsIps'>Remove-PveClusterSdnVnetsIps</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveClusterSdnVnetsSubnets'>Remove-PveClusterSdnVnetsSubnets</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveClusterSdnZones'>Remove-PveClusterSdnZones</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesCephMds'>Remove-PveNodesCephMds</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesCephMgr'>Remove-PveNodesCephMgr</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesCephMon'>Remove-PveNodesCephMon</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesCephOsd'>Remove-PveNodesCephOsd</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesCephPool'>Remove-PveNodesCephPool</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesCertificatesAcmeCertificate'>Remove-PveNodesCertificatesAcmeCertificate</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesCertificatesCustom'>Remove-PveNodesCertificatesCustom</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesDisksDirectory'>Remove-PveNodesDisksDirectory</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesDisksLvm'>Remove-PveNodesDisksLvm</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesDisksLvmthin'>Remove-PveNodesDisksLvmthin</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesDisksZfs'>Remove-PveNodesDisksZfs</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesFirewallRules'>Remove-PveNodesFirewallRules</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesLxc'>Remove-PveNodesLxc</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesLxcFirewallAliases'>Remove-PveNodesLxcFirewallAliases</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesLxcFirewallIpset'>Remove-PveNodesLxcFirewallIpset</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesLxcFirewallIpsetIdx'>Remove-PveNodesLxcFirewallIpsetIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesLxcFirewallRules'>Remove-PveNodesLxcFirewallRules</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesLxcSnapshot'>Remove-PveNodesLxcSnapshot</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesNetwork'>Remove-PveNodesNetwork</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesNetworkIdx'>Remove-PveNodesNetworkIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesQemu'>Remove-PveNodesQemu</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesQemuFirewallAliases'>Remove-PveNodesQemuFirewallAliases</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesQemuFirewallIpset'>Remove-PveNodesQemuFirewallIpset</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesQemuFirewallIpsetIdx'>Remove-PveNodesQemuFirewallIpsetIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesQemuFirewallRules'>Remove-PveNodesQemuFirewallRules</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesQemuSnapshot'>Remove-PveNodesQemuSnapshot</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesStorageContent'>Remove-PveNodesStorageContent</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesStoragePrunebackups'>Remove-PveNodesStoragePrunebackups</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesSubscription'>Remove-PveNodesSubscription</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveNodesTasks'>Remove-PveNodesTasks</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PvePools'>Remove-PvePools</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PvePoolsIdx'>Remove-PvePoolsIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveStorage'>Remove-PveStorage</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Remove-PveVmSnapshot'>Remove-PveVmSnapshot</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Reset-PveVm'>Reset-PveVm</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Resume-PveVm'>Resume-PveVm</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveAccessAcl'>Set-PveAccessAcl</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveAccessDomains'>Set-PveAccessDomains</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveAccessGroups'>Set-PveAccessGroups</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveAccessPassword'>Set-PveAccessPassword</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveAccessRoles'>Set-PveAccessRoles</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveAccessTfa'>Set-PveAccessTfa</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveAccessUsers'>Set-PveAccessUsers</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveAccessUsersToken'>Set-PveAccessUsersToken</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveAccessUsersUnlockTfa'>Set-PveAccessUsersUnlockTfa</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterAcmeAccount'>Set-PveClusterAcmeAccount</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterAcmePlugins'>Set-PveClusterAcmePlugins</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterBackup'>Set-PveClusterBackup</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterCephFlags'>Set-PveClusterCephFlags</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterCephFlagsIdx'>Set-PveClusterCephFlagsIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterFirewallAliases'>Set-PveClusterFirewallAliases</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterFirewallGroups'>Set-PveClusterFirewallGroups</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterFirewallIpset'>Set-PveClusterFirewallIpset</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterFirewallOptions'>Set-PveClusterFirewallOptions</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterFirewallRules'>Set-PveClusterFirewallRules</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterHaGroups'>Set-PveClusterHaGroups</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterHaResources'>Set-PveClusterHaResources</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterJobsRealmSync'>Set-PveClusterJobsRealmSync</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterMappingPci'>Set-PveClusterMappingPci</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterMappingUsb'>Set-PveClusterMappingUsb</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterMetricsServer'>Set-PveClusterMetricsServer</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterNotificationsEndpointsGotify'>Set-PveClusterNotificationsEndpointsGotify</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterNotificationsEndpointsSendmail'>Set-PveClusterNotificationsEndpointsSendmail</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterNotificationsEndpointsSmtp'>Set-PveClusterNotificationsEndpointsSmtp</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterNotificationsMatchers'>Set-PveClusterNotificationsMatchers</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterOptions'>Set-PveClusterOptions</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterReplication'>Set-PveClusterReplication</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterSdn'>Set-PveClusterSdn</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterSdnControllers'>Set-PveClusterSdnControllers</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterSdnDns'>Set-PveClusterSdnDns</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterSdnIpams'>Set-PveClusterSdnIpams</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterSdnVnets'>Set-PveClusterSdnVnets</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterSdnVnetsIps'>Set-PveClusterSdnVnetsIps</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterSdnVnetsSubnets'>Set-PveClusterSdnVnetsSubnets</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveClusterSdnZones'>Set-PveClusterSdnZones</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesAptRepositories'>Set-PveNodesAptRepositories</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesCephPool'>Set-PveNodesCephPool</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesCertificatesAcmeCertificate'>Set-PveNodesCertificatesAcmeCertificate</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesConfig'>Set-PveNodesConfig</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesDisksWipedisk'>Set-PveNodesDisksWipedisk</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesDns'>Set-PveNodesDns</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesFirewallOptions'>Set-PveNodesFirewallOptions</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesFirewallRules'>Set-PveNodesFirewallRules</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesLxcConfig'>Set-PveNodesLxcConfig</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesLxcFirewallAliases'>Set-PveNodesLxcFirewallAliases</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesLxcFirewallIpset'>Set-PveNodesLxcFirewallIpset</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesLxcFirewallOptions'>Set-PveNodesLxcFirewallOptions</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesLxcFirewallRules'>Set-PveNodesLxcFirewallRules</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesLxcResize'>Set-PveNodesLxcResize</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesLxcSnapshotConfig'>Set-PveNodesLxcSnapshotConfig</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesNetwork'>Set-PveNodesNetwork</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesNetworkIdx'>Set-PveNodesNetworkIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesQemuCloudinit'>Set-PveNodesQemuCloudinit</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesQemuConfig'>Set-PveNodesQemuConfig</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesQemuFirewallAliases'>Set-PveNodesQemuFirewallAliases</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesQemuFirewallIpset'>Set-PveNodesQemuFirewallIpset</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesQemuFirewallOptions'>Set-PveNodesQemuFirewallOptions</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesQemuFirewallRules'>Set-PveNodesQemuFirewallRules</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesQemuResize'>Set-PveNodesQemuResize</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesQemuSendkey'>Set-PveNodesQemuSendkey</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesQemuSnapshotConfig'>Set-PveNodesQemuSnapshotConfig</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesQemuUnlink'>Set-PveNodesQemuUnlink</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesStorageContent'>Set-PveNodesStorageContent</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesSubscription'>Set-PveNodesSubscription</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveNodesTime'>Set-PveNodesTime</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PvePools'>Set-PvePools</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PvePoolsIdx'>Set-PvePoolsIdx</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Set-PveStorage'>Set-PveStorage</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Start-PveVm'>Start-PveVm</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Stop-PveVm'>Stop-PveVm</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Suspend-PveVm'>Suspend-PveVm</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Undo-PveVmSnapshot'>Undo-PveVmSnapshot</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Unlock-PveVm'>Unlock-PveVm</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#VmCheckIdOrName'>VmCheckIdOrName</a></li>
|
|
<li class='nav-item'><a class='nav-link' href='#Wait-PveTaskIsFinish'>Wait-PveTaskIsFinish</a></li>
|
|
</ul>
|
|
</div>
|
|
</nav>
|
|
|
|
<main role='main' id='main-data' class='col-md-9 ms-sm-auto col-lg-10 px-md-4 main-data-hidden'>
|
|
<div id='GettingStarted' class="toggle_container">
|
|
<div class="page-header">
|
|
</div>
|
|
<h1 id="cv4pve-api-powershell">cv4pve-api-powershell</h1>
|
|
<p><a href="https://www.powershellgallery.com/packages/Corsinvest.ProxmoxVE.Api/"><img src="https://img.shields.io/powershellgallery/v/Corsinvest.ProxmoxVE.Api" alt="PowerShell Gallery Version" /></a>
|
|
<img src="https://img.shields.io/powershellgallery/dt/Corsinvest.ProxmoxVE.Api" alt="download" /></p>
|
|
<p><a href="https://pve.proxmox.com/pve-docs/api-viewer/">ProxmoxVE Api</a></p>
|
|
<p><a href="https://www.powershellgallery.com/packages/Corsinvest.ProxmoxVE.Api/">PowerShell Gallery</a></p>
|
|
<pre><code class="language-text"> ______ _ __
|
|
/ ____/___ __________(_)___ _ _____ _____/ /_
|
|
/ / / __ \/ ___/ ___/ / __ \ | / / _ \/ ___/ __/
|
|
/ /___/ /_/ / / (__ ) / / / / |/ / __(__ ) /_
|
|
\____/\____/_/ /____/_/_/ /_/|___/\___/____/\__/
|
|
|
|
powerShell for Proxmox VE (Made in Italy)
|
|
|
|
cv4pve-api-powershell is a part of suite cv4pve.
|
|
For more information visit https://www.corsinvest.it/cv4pve
|
|
</code></pre>
|
|
<h2 id="copyright">📰 Copyright</h2>
|
|
<p>Copyright: Corsinvest Srl
|
|
For licensing details please visit <a href="LICENSE">LICENSE</a></p>
|
|
<h2 id="commercial-support">🦺 Commercial Support</h2>
|
|
<p>This software is part of a suite of tools called cv4pve. If you want commercial support, visit the <a href="https://www.corsinvest.it/cv4pve">site</a></p>
|
|
<h2 id="introduction">Introduction</h2>
|
|
<p>PowerShell for Proxmox VE.</p>
|
|
<p><img src="https://raw.githubusercontent.com/Corsinvest/cv4pve-api-powershell/master/images/powershell.png" alt="PowerShell for Proxmox VE" /></p>
|
|
<p>this is a CmdLet for PowerShell to manage Proxmox VE.</p>
|
|
<h2 id="main-features">🚀 Main features</h2>
|
|
<ul>
|
|
<li>Easy to learn</li>
|
|
<li>Set ResponseType json, png, extjs, html, text</li>
|
|
<li>Full class and method generated from documentation (about client)</li>
|
|
<li>Comment any method and parameters</li>
|
|
<li>Parameters indexed eg [n] is structured in array index and value</li>
|
|
<li>Return data Proxmox VE</li>
|
|
<li>Return result class more information PveResponse
|
|
<ul>
|
|
<li>Request</li>
|
|
<li>Response</li>
|
|
<li>Status</li>
|
|
</ul>
|
|
</li>
|
|
<li>Utility
|
|
<ul>
|
|
<li>ConvertFrom-PveUnixTime</li>
|
|
<li>Wait-PveTaskIsFinish</li>
|
|
<li>Get-PveTaskIsRunning</li>
|
|
<li>Build-PveDocumentation</li>
|
|
<li>Get-PveVm (from id or name)</li>
|
|
<li>Unlock-PveVm (from id or name)</li>
|
|
<li>Start-PveVm (from id or name)</li>
|
|
<li>Stop-PveVm (from id or name)</li>
|
|
<li>Suspend-PveVm (from id or name)</li>
|
|
<li>Resume-PveVm (from id or name)</li>
|
|
<li>Reset-PveVm (from id or name)</li>
|
|
<li>And More</li>
|
|
</ul>
|
|
</li>
|
|
<li>Method direct access using Invoke-PveRestApi return PveResponse</li>
|
|
<li>Connect-PveCluster accept multiple hosts for HA</li>
|
|
<li>Completely written in PowerShell</li>
|
|
<li>Use native api REST Proxmox VE</li>
|
|
<li>Independent os (Windows, Linux, Macosx)</li>
|
|
<li>Installation from PowerShellGallery or download file</li>
|
|
<li>Not require installation in Proxmox VE</li>
|
|
<li>Execute out side Proxmox VE</li>
|
|
<li>Open Source</li>
|
|
<li>Form Proxmox VE 6.2 support Api Token for user</li>
|
|
<li>Enter-PveSpice enter Spice VM</li>
|
|
<li>Login with One-time password for Two-factor authentication</li>
|
|
</ul>
|
|
<h2 id="documentation">📙 Documentation</h2>
|
|
<p><a href="https://raw.githack.com/Corsinvest/cv4pve-api-powershell/master/doc/index.html">Documentation</a></p>
|
|
<h2 id="tutorial">Tutorial</h2>
|
|
<p><a href="https://tinyurl.com/cv4pve-api-pwsh-learn">Tutorial interactive in VSCode notebook</a></p>
|
|
<h2 id="requirement">Requirement</h2>
|
|
<p>Minimum version requirement for Powershell is 6.0</p>
|
|
<h2 id="installation">Installation</h2>
|
|
<p>Install <a href="https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell">PowerShell</a> in your system.</p>
|
|
<h3 id="from-powershell-gallery">From PowerShell Gallery</h3>
|
|
<p>Open PowerShell and install module form <a href="https://www.powershellgallery.com/">gallery</a></p>
|
|
<pre><code class="language-ps">PS /home/frank> Install-Module -Name Corsinvest.ProxmoxVE.Api
|
|
</code></pre>
|
|
<h3 id="manual">Manual</h3>
|
|
<p>Download folder Corsinvest.ProxmoxVE.Api and copy in path module</p>
|
|
<pre><code class="language-ps"># show path module
|
|
PS /home/frank> [Environment]::GetEnvironmentVariable("PSModulePath")
|
|
</code></pre>
|
|
<h2 id="api-token">Api token</h2>
|
|
<p>From version 6.2 of Proxmox VE is possible to use <a href="https://pve.proxmox.com/pve-docs/pveum-plain.html">Api token</a>.
|
|
This feature permit execute Api without using user and password.
|
|
If using <strong>Privilege Separation</strong> when create api token remember specify in permission.
|
|
Format USER@REALM!TOKENID=UUID</p>
|
|
<h2 id="connect-to-cluster">Connect to cluster</h2>
|
|
<p>For connection use the function Connect-PveCluster. This function generate a Ticket object that refer a PveTicket class.
|
|
The first connection saved ticket data in the variable $Global:PveTicketLast. In the various functions, the -PveTicket parameter is the connection reference ticket. If not specified will be used $Global:PveTicketLast.</p>
|
|
<h2 id="pveticket-class">PveTicket Class</h2>
|
|
<p>This class contain data after connection and login Connect-PveCluster</p>
|
|
<pre><code class="language-ps">class PveTicket {
|
|
[string] $HostName = ''
|
|
[int] $Port = 8006
|
|
[bool] $SkipCertificateCheck = $true
|
|
[string] $Ticket = ''
|
|
[string] $CSRFPreventionToken = ''
|
|
[string] $ApiToken = ''
|
|
}
|
|
</code></pre>
|
|
<h2 id="pveresponse-class">PveResponse Class</h2>
|
|
<p>This class contain data after execution any command</p>
|
|
<pre><code class="language-ps">class PveResponse {
|
|
#Contain real response of Proxmox VE
|
|
#Is converted in object Json response
|
|
[PSCustomObject] $Response
|
|
[int] $StatusCode = 200
|
|
[string] $ReasonPhrase
|
|
[bool] $IsSuccessStatusCode = $true
|
|
[string] $RequestResource
|
|
[hashtable] $Parameters
|
|
[string] $Method
|
|
[string] $ResponseType
|
|
|
|
[bool] ResponseInError() { return $null -ne $this.Response.error }
|
|
[PSCustomObject] ToTable() { return $this.Response.data | Format-Table -Property * }
|
|
[PSCustomObject] ToData() { return $this.Response.data }
|
|
[void] ToCsv([string] $filename) { $this.Response.data | Export-Csv $filename }
|
|
[void] ToGridView() { $this.Response.data | Out-GridView -Title "View Result Data" }
|
|
}
|
|
</code></pre>
|
|
<h2 id="usage">Usage</h2>
|
|
<p>Example Connect and get version</p>
|
|
<pre><code class="language-ps">#Connection to cluster user and password
|
|
PS /home/frank> Connect-PveCluster -HostsAndPorts 192.168.190.191:8006,192.168.190.192 -SkipCertificateCheck
|
|
PowerShell credential request
|
|
Proxmox VE Username and password, username formatted as user@pam, user@pve, user@yourdomain or user (default domain pam).
|
|
User: test
|
|
Password for user test: ****
|
|
|
|
#return Ticket, default set $Global:PveTicketLast
|
|
#this is useful when connections to multiple clusters are needed use parameter -SkipRefreshPveTicketLast
|
|
HostName : 192.168.190.191
|
|
Port : 8006
|
|
SkipCertificateCheck : True
|
|
Ticket : PVE:test@pam:5EFF3CCA::iXhSNb5NTgNUYznf93mBOhj8pqYvAXoecKBHCXa3coYwBWjsWO/x8TO1gIDX0yz9nfHuvY3alJ0+Ew5AouOTZlZl3NODO9Cp4Hl87qnzhsz4wvoYEzvS1NUOTBekt+yAa68jdbhP
|
|
OzhOd8ozEEQIK7Fw2lOSa0qBFUTZRoMtnCnlsjk/Nn3kNEnZrkHXRGm46fA+asprvr0nslLxJgPGh94Xxd6jpNDj+xJnp9u6W3PxiAojM9g7IRurbp7ZCJvAgHbA9FqxibpgjaVm4NCd8LdkLDgCROxgYCjI3eR
|
|
gjkDvu1P7lLjK9JxSzqnCWWD739DT3P3bW+Ac3SyVqTf8sw==
|
|
CSRFPreventionToken : 5EFF3CCA:Cu0NuFiL6CkhFdha2V+HHigMQPk
|
|
|
|
#Connection to cluster using Api Token
|
|
PS /home/frank> Connect-PveCluster -HostsAndPorts 192.168.190.191:8006,192.168.190.192 -SkipCertificateCheck -ApiToken root@pam!qqqqqq=8a8c1cd4-d373-43f1-b366-05ce4cb8061f
|
|
HostName : 192.168.190.191
|
|
Port : 8006
|
|
SkipCertificateCheck : True
|
|
Ticket :
|
|
CSRFPreventionToken :
|
|
ApiToken : root@pam!qqqqqq=8a8c1cd4-d373-43f1-b366-05ce4cb8061f
|
|
|
|
#For disable output call Connect-PveCluster > $null
|
|
|
|
#Get version
|
|
PS /home/frank> $ret = Get-PveVersion
|
|
|
|
#$ret return a class PveResponse
|
|
|
|
#Show data
|
|
PS /home/frank> $ret.Response.data
|
|
repoid release keyboard version
|
|
------ ------- -------- -------
|
|
d0ec33c6 15 it 5.4
|
|
|
|
#Show data 2
|
|
PS /home/frank> $ret.ToTable()
|
|
repoid release keyboard version
|
|
------ ------- -------- -------
|
|
d0ec33c6 15 it 5.4
|
|
</code></pre>
|
|
<p>Get snapshots of vm</p>
|
|
<pre><code class="language-ps">PS /home/frank> (Get-PveNodesQemuSnapshot -Node pve1 -Vmid 100).ToTable()
|
|
|
|
vmstate name parent description snaptime
|
|
------- ---- ------ ----------- --------
|
|
0 autowin10service200221183059 autowin10service200220183012 cv4pve-autosnap 1582306261
|
|
0 autowin10service200220183012 autowin10service200219183012 cv4pve-autosnap 1582219813
|
|
0 autowin10service200224183012 autowin10service200223183014 cv4pve-autosnap 1582565413
|
|
0 autowin10service200223183014 autowin10service200222183019 cv4pve-autosnap 1582479015
|
|
0 autowin10service200215183012 autowin10service200214183012 cv4pve-autosnap 1581787814
|
|
0 autowin10service200216183017 autowin10service200215183012 cv4pve-autosnap 1581874219
|
|
0 autowin10service200218183010 autowin10service200216183017 cv4pve-autosnap 1582047011
|
|
0 autowin10service200219183012 autowin10service200218183010 cv4pve-autosnap 1582133413
|
|
0 autowin10service200214183012 cv4pve-autosnap 1581701413
|
|
0 autowin10service200222183019 autowin10service200221183059 cv4pve-autosnap 1582392621
|
|
current autowin10service200224183012 You are here!
|
|
</code></pre>
|
|
<p>Other method</p>
|
|
<pre><code class="language-ps">(Get-PveVm -VmIdOrName 100 | Get-PveNodesQemuSnapshot).ToTable()
|
|
vmstate name parent description snaptime
|
|
------- ---- ------ ----------- --------
|
|
0 autowin10service200221183059 autowin10service200220183012 cv4pve-autosnap 1582306261
|
|
0 autowin10service200220183012 autowin10service200219183012 cv4pve-autosnap 1582219813
|
|
0 autowin10service200224183012 autowin10service200223183014 cv4pve-autosnap 1582565413
|
|
0 autowin10service200223183014 autowin10service200222183019 cv4pve-autosnap 1582479015
|
|
0 autowin10service200215183012 autowin10service200214183012 cv4pve-autosnap 1581787814
|
|
0 autowin10service200216183017 autowin10service200215183012 cv4pve-autosnap 1581874219
|
|
0 autowin10service200218183010 autowin10service200216183017 cv4pve-autosnap 1582047011
|
|
0 autowin10service200219183012 autowin10service200218183010 cv4pve-autosnap 1582133413
|
|
0 autowin10service200214183012 cv4pve-autosnap 1581701413
|
|
0 autowin10service200222183019 autowin10service200221183059 cv4pve-autosnap 1582392621
|
|
current autowin10service200224183012 You are here!
|
|
</code></pre>
|
|
<h2 id="indexed-data-parameter">Indexed data parameter</h2>
|
|
<p>if you need to pass indexed parameters e.g. (-ScsiN, -IdeN, -NetN) you must use the following way:</p>
|
|
<pre><code class="language-powershell">#create variabile
|
|
$networkConfig = @{ 1 = [uri]::EscapeDataString("model=virtio,bridge=vmbr0") }
|
|
$storageConfig = @{ 1 = 'ssdpool:32' }
|
|
$bootableIso = @{ 1 = 'local:iso/ubuntu.iso' }
|
|
|
|
#use variable
|
|
New-PveNodesQemu -Node $node -Vmid 105 -Memory 2048 -ScsiN $storageConfig -IdeN $bootableIso -NetN $networkConfig
|
|
</code></pre>
|
|
<p>The <strong>[uri]::EscapeDataString</strong> escape value to pass.</p>
|
|
<h2 id="build-documentation">Build documentation</h2>
|
|
<p>For build documentation use command <strong>Build-PveDocumentation</strong></p>
|
|
<p>This command accept <strong>TemplateFile</strong> parameter is a template for generate documentation.
|
|
The default <a href="https://raw.githubusercontent.com/corsinvest/cv4pve-api-powershell/master/help-out-html.ps1">file</a>.</p>
|
|
|
|
</div>
|
|
<div id="Build-PveDocumentation" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Build-PveDocumentation </h2>
|
|
<p></p>
|
|
<p class='searchable'>Build documentation for Power Shell command For Proxmox VE</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Build-PveDocumentation [[-TemplateFile] <String>] [-OutputFile] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-TemplateFile</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Template file for generation documentation</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>false</td>
|
|
<td class='visible-lg'>https://raw.githubusercontent.com/corsinvest/cv4pve-api-powershell/master/help-out-html.ps1</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-OutputFile</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Output file</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>false</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>System.Void</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Connect-PveCluster" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Connect-PveCluster </h2>
|
|
<p></p>
|
|
<p class='searchable'>Connect to Proxmox VE Cluster.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Connect-PveCluster [-HostsAndPorts] <String[]> [[-Credentials] <PSCredential>] [[-ApiToken] <String>] [[-Otp] <String>] [-SkipCertificateCheck] [-SkipRefreshPveTicketLast] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-HostsAndPorts</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Host and portsFormat 10.1.1.90:8006,10.1.1.91:8006,10.1.1.92:8006.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Credentials</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Username and password, username formatted as user@pam, user@pve, user@yourdomain or user (default domain pam).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>false</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ApiToken</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Api Token format USER@REALM!TOKENID=UUID</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>false</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Otp</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>One-time password for Two-factor authentication.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>false</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-SkipCertificateCheck</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Skips certificate validation checks.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>false</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-SkipRefreshPveTicketLast</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Skip refresh PveTicket Last global variable</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>false</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveTicket. Return ticket connection.</li></ul>
|
|
</div>
|
|
<div>
|
|
<h3> Examples </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<strong>EXAMPLE 1</strong>
|
|
<code class='powershell'>$PveTicket = Connect-PveCluster -HostsAndPorts 192.168.128.115 -Credentials (Get-Credential -Username 'root').</code>
|
|
<div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="ConvertFrom-PveUnixTime" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> ConvertFrom-PveUnixTime </h2>
|
|
<p></p>
|
|
<p class='searchable'>Convert Unix Time in DateTime</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>ConvertFrom-PveUnixTime [-Time] <Int64> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Time</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Unix Time</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>false</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>DateTime. Return DateTime from Unix Time.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="ConvertTo-PveUnixTime" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> ConvertTo-PveUnixTime </h2>
|
|
<p>Convert datetime objects to UNIX time.</p>
|
|
<p class='searchable'>Convert System.DateTime objects to UNIX time.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>ConvertTo-PveUnixTime [-Date] <DateTime> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Date</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Date time</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByValue)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>[Int32]. Return Unix Time.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Enter-PveSpice" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Enter-PveSpice </h2>
|
|
<p></p>
|
|
<p class='searchable'>Enter Spice VM.</p>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-heading'>
|
|
<h3 class='panel-title'> Aliases </h3>
|
|
</div>
|
|
<div class='panel-body'>
|
|
<ul>
|
|
<li class='searchable'>Show-PveSpice</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Enter-PveSpice [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [-Viewer] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VmIdOrName</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID or Name of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Viewer</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Path of Spice remove viewer.- Linux /usr/bin/remote-viewer- Windows C:\Program Files\VirtViewer v?.?-???\bin\remote-viewer.exe</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveAccess" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveAccess </h2>
|
|
<p></p>
|
|
<p class='searchable'>Directory index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveAccess [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveAccessAcl" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveAccessAcl </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get Access Control List (ACLs).</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveAccessAcl [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveAccessDomains" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveAccessDomains </h2>
|
|
<p></p>
|
|
<p class='searchable'>Authentication domain index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveAccessDomains [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveAccessDomainsIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveAccessDomainsIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get auth server configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveAccessDomainsIdx [[-PveTicket] <PveTicket>] [-Realm] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Realm</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Authentication domain ID</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveAccessGroups" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveAccessGroups </h2>
|
|
<p></p>
|
|
<p class='searchable'>Group index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveAccessGroups [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveAccessGroupsIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveAccessGroupsIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get group configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveAccessGroupsIdx [[-PveTicket] <PveTicket>] [-Groupid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Groupid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveAccessOpenid" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveAccessOpenid </h2>
|
|
<p></p>
|
|
<p class='searchable'>Directory index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveAccessOpenid [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveAccessPermissions" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveAccessPermissions </h2>
|
|
<p></p>
|
|
<p class='searchable'>Retrieve effective permissions of given user/token.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveAccessPermissions [[-PveTicket] <PveTicket>] [[-Path] <String>] [[-Userid] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Path</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only dump this specific path, not the whole tree.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Userid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>User ID or full API token ID</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveAccessRoles" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveAccessRoles </h2>
|
|
<p></p>
|
|
<p class='searchable'>Role index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveAccessRoles [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveAccessRolesIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveAccessRolesIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get role configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveAccessRolesIdx [[-PveTicket] <PveTicket>] [-Roleid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Roleid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveAccessTfa" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveAccessTfa </h2>
|
|
<p></p>
|
|
<p class='searchable'>List TFA configurations of users.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveAccessTfa [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveAccessTfaIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveAccessTfaIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Fetch a requested TFA entry if present.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveAccessTfaIdx [[-PveTicket] <PveTicket>] [-Id] <String> [-Userid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A TFA entry id.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Userid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Full User ID, in the `name@realm` format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveAccessTicket" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveAccessTicket </h2>
|
|
<p></p>
|
|
<p class='searchable'>Dummy. Useful for formatters which want to provide a login page.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveAccessTicket [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveAccessUsers" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveAccessUsers </h2>
|
|
<p></p>
|
|
<p class='searchable'>User index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveAccessUsers [[-PveTicket] <PveTicket>] [-Enabled] [-Full] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Enabled</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Optional filter for enable property.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Full</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Include group and token information.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveAccessUsersIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveAccessUsersIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get user configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveAccessUsersIdx [[-PveTicket] <PveTicket>] [-Userid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Userid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Full User ID, in the `name@realm` format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveAccessUsersTfa" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveAccessUsersTfa </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get user TFA types (Personal and Realm).</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveAccessUsersTfa [[-PveTicket] <PveTicket>] [-Multiple] [-Userid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Multiple</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Request all entries as an array.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Userid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Full User ID, in the `name@realm` format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveAccessUsersToken" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveAccessUsersToken </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get user API tokens.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveAccessUsersToken [[-PveTicket] <PveTicket>] [-Userid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Userid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Full User ID, in the `name@realm` format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveAccessUsersTokenIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveAccessUsersTokenIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get specific API token information.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveAccessUsersTokenIdx [[-PveTicket] <PveTicket>] [-Tokenid] <String> [-Userid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tokenid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>User-specific token identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Userid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Full User ID, in the `name@realm` format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveCluster" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveCluster </h2>
|
|
<p></p>
|
|
<p class='searchable'>Cluster index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveCluster [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterAcme" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterAcme </h2>
|
|
<p></p>
|
|
<p class='searchable'>ACMEAccount index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterAcme [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterAcmeAccount" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterAcmeAccount </h2>
|
|
<p></p>
|
|
<p class='searchable'>ACMEAccount index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterAcmeAccount [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterAcmeAccountIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterAcmeAccountIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Return existing ACME account information.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterAcmeAccountIdx [[-PveTicket] <PveTicket>] [[-Name] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>ACME account config file name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterAcmeChallengeSchema" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterAcmeChallengeSchema </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get schema of ACME challenge types.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterAcmeChallengeSchema [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterAcmeDirectories" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterAcmeDirectories </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get named known ACME directory endpoints.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterAcmeDirectories [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterAcmeMeta" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterAcmeMeta </h2>
|
|
<p></p>
|
|
<p class='searchable'>Retrieve ACME Directory Meta Information</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterAcmeMeta [[-PveTicket] <PveTicket>] [[-Directory] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Directory</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>URL of ACME CA directory endpoint.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterAcmePlugins" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterAcmePlugins </h2>
|
|
<p></p>
|
|
<p class='searchable'>ACME plugin index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterAcmePlugins [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only list ACME plugins of a specific type Enum: dns,standalone</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterAcmePluginsIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterAcmePluginsIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get ACME plugin configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterAcmePluginsIdx [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Unique identifier for ACME plugin instance.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterAcmeTos" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterAcmeTos </h2>
|
|
<p></p>
|
|
<p class='searchable'>Retrieve ACME TermsOfService URL from CA. Deprecated, please use /cluster/acme/meta.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterAcmeTos [[-PveTicket] <PveTicket>] [[-Directory] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Directory</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>URL of ACME CA directory endpoint.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterBackup" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterBackup </h2>
|
|
<p></p>
|
|
<p class='searchable'>List vzdump backup schedule.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterBackup [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterBackupIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterBackupIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read vzdump backup job definition.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterBackupIdx [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The job ID.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterBackupIncludedVolumes" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterBackupIncludedVolumes </h2>
|
|
<p></p>
|
|
<p class='searchable'>Returns included guests and the backup status of their disks. Optimized to be used in ExtJS tree views.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterBackupIncludedVolumes [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The job ID.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterBackupInfo" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterBackupInfo </h2>
|
|
<p></p>
|
|
<p class='searchable'>Index for backup info related endpoints</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterBackupInfo [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterBackupInfoNotBackedUp" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterBackupInfoNotBackedUp </h2>
|
|
<p></p>
|
|
<p class='searchable'>Shows all guests which are not covered by any backup job.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterBackupInfoNotBackedUp [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterCeph" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterCeph </h2>
|
|
<p></p>
|
|
<p class='searchable'>Cluster ceph index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterCeph [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterCephFlags" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterCephFlags </h2>
|
|
<p></p>
|
|
<p class='searchable'>get the status of all ceph flags</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterCephFlags [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterCephFlagsIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterCephFlagsIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get the status of a specific ceph flag.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterCephFlagsIdx [[-PveTicket] <PveTicket>] [-Flag] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Flag</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the flag name to get. Enum: nobackfill,nodeep-scrub,nodown,noin,noout,norebalance,norecover,noscrub,notieragent,noup,pause</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterCephMetadata" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterCephMetadata </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get ceph metadata.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterCephMetadata [[-PveTicket] <PveTicket>] [[-Scope] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Scope</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>-- Enum: all,versions</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterCephStatus" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterCephStatus </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get ceph status.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterCephStatus [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterConfig" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterConfig </h2>
|
|
<p></p>
|
|
<p class='searchable'>Directory index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterConfig [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterConfigApiversion" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterConfigApiversion </h2>
|
|
<p></p>
|
|
<p class='searchable'>Return the version of the cluster join API available on this node.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterConfigApiversion [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterConfigJoin" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterConfigJoin </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get information needed to join this cluster over the connected node.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterConfigJoin [[-PveTicket] <PveTicket>] [[-Node] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The node for which the joinee gets the nodeinfo.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterConfigNodes" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterConfigNodes </h2>
|
|
<p></p>
|
|
<p class='searchable'>Corosync node list.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterConfigNodes [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterConfigQdevice" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterConfigQdevice </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get QDevice status</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterConfigQdevice [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterConfigTotem" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterConfigTotem </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get corosync totem protocol settings.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterConfigTotem [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterFirewall" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterFirewall </h2>
|
|
<p></p>
|
|
<p class='searchable'>Directory index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterFirewall [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterFirewallAliases" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterFirewallAliases </h2>
|
|
<p></p>
|
|
<p class='searchable'>List aliases</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterFirewallAliases [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterFirewallAliasesIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterFirewallAliasesIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read alias.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterFirewallAliasesIdx [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Alias name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterFirewallGroups" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterFirewallGroups </h2>
|
|
<p></p>
|
|
<p class='searchable'>List security groups.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterFirewallGroups [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterFirewallGroupsIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterFirewallGroupsIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get single rule data.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterFirewallGroupsIdx [[-PveTicket] <PveTicket>] [-Group] <String> [[-Pos] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Group</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Security Group name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pos</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Update rule at position <pos>.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterFirewallIpset" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterFirewallIpset </h2>
|
|
<p></p>
|
|
<p class='searchable'>List IPSets</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterFirewallIpset [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterFirewallIpsetIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterFirewallIpsetIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read IP or Network settings from IPSet.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [-Name] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cidr</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network/IP specification in CIDR format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP set name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterFirewallMacros" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterFirewallMacros </h2>
|
|
<p></p>
|
|
<p class='searchable'>List available macros</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterFirewallMacros [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterFirewallOptions" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterFirewallOptions </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get Firewall options.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterFirewallOptions [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterFirewallRefs" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterFirewallRefs </h2>
|
|
<p></p>
|
|
<p class='searchable'>Lists possible IPSet/Alias reference which are allowed in source/dest properties.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterFirewallRefs [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only list references of specified type. Enum: alias,ipset</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterFirewallRules" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterFirewallRules </h2>
|
|
<p></p>
|
|
<p class='searchable'>List rules.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterFirewallRules [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterFirewallRulesIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterFirewallRulesIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get single rule data.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterFirewallRulesIdx [[-PveTicket] <PveTicket>] [[-Pos] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pos</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Update rule at position <pos>.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterHa" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterHa </h2>
|
|
<p></p>
|
|
<p class='searchable'>Directory index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterHa [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterHaGroups" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterHaGroups </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get HA groups.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterHaGroups [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterHaGroupsIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterHaGroupsIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read ha group configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterHaGroupsIdx [[-PveTicket] <PveTicket>] [-Group] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Group</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The HA group identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterHaResources" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterHaResources </h2>
|
|
<p></p>
|
|
<p class='searchable'>List HA resources.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterHaResources [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only list resources of specific type Enum: ct,vm</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterHaResourcesIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterHaResourcesIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read resource configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterHaResourcesIdx [[-PveTicket] <PveTicket>] [-Sid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Sid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example':' vm':'100 / ct':'100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example':' 100).</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterHaStatus" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterHaStatus </h2>
|
|
<p></p>
|
|
<p class='searchable'>Directory index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterHaStatus [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterHaStatusCurrent" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterHaStatusCurrent </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get HA manger status.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterHaStatusCurrent [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterHaStatusManagerStatus" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterHaStatusManagerStatus </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get full HA manger status, including LRM status.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterHaStatusManagerStatus [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterJobs" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterJobs </h2>
|
|
<p></p>
|
|
<p class='searchable'>Index for jobs related endpoints.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterJobs [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterJobsRealmSync" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterJobsRealmSync </h2>
|
|
<p></p>
|
|
<p class='searchable'>List configured realm-sync-jobs.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterJobsRealmSync [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterJobsRealmSyncIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterJobsRealmSyncIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read realm-sync job definition.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterJobsRealmSyncIdx [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterJobsScheduleAnalyze" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterJobsScheduleAnalyze </h2>
|
|
<p></p>
|
|
<p class='searchable'>Returns a list of future schedule runtimes.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterJobsScheduleAnalyze [[-PveTicket] <PveTicket>] [[-Iterations] <Int32>] [-Schedule] <String> [[-Starttime] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Iterations</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Number of event-iteration to simulate and return.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Schedule</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Job schedule. The format is a subset of `systemd` calendar events.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Starttime</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>UNIX timestamp to start the calculation from. Defaults to the current time.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterLog" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterLog </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read cluster log</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterLog [[-PveTicket] <PveTicket>] [[-Max] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Max</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Maximum number of entries.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterMapping" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterMapping </h2>
|
|
<p></p>
|
|
<p class='searchable'>List resource types.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterMapping [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterMappingPci" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterMappingPci </h2>
|
|
<p></p>
|
|
<p class='searchable'>List PCI Hardware Mapping</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterMappingPci [[-PveTicket] <PveTicket>] [[-CheckNode] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-CheckNode</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>If given, checks the configurations on the given node for correctness, and adds relevant diagnostics for the devices to the response.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterMappingPciIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterMappingPciIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get PCI Mapping.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterMappingPciIdx [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterMappingUsb" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterMappingUsb </h2>
|
|
<p></p>
|
|
<p class='searchable'>List USB Hardware Mappings</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterMappingUsb [[-PveTicket] <PveTicket>] [[-CheckNode] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-CheckNode</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>If given, checks the configurations on the given node for correctness, and adds relevant errors to the devices.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterMappingUsbIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterMappingUsbIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get USB Mapping.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterMappingUsbIdx [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterMetrics" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterMetrics </h2>
|
|
<p></p>
|
|
<p class='searchable'>Metrics index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterMetrics [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterMetricsServer" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterMetricsServer </h2>
|
|
<p></p>
|
|
<p class='searchable'>List configured metric servers.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterMetricsServer [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterMetricsServerIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterMetricsServerIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read metric server configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterMetricsServerIdx [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterNextid" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterNextid </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get next free VMID. Pass a VMID to assert that its free (at time of check).</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterNextid [[-PveTicket] <PveTicket>] [[-Vmid] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterNotifications" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterNotifications </h2>
|
|
<p></p>
|
|
<p class='searchable'>Index for notification-related API endpoints.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterNotifications [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterNotificationsEndpoints" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterNotificationsEndpoints </h2>
|
|
<p></p>
|
|
<p class='searchable'>Index for all available endpoint types.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterNotificationsEndpoints [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterNotificationsEndpointsGotify" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterNotificationsEndpointsGotify </h2>
|
|
<p></p>
|
|
<p class='searchable'>Returns a list of all gotify endpoints</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterNotificationsEndpointsGotify [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterNotificationsEndpointsGotifyIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterNotificationsEndpointsGotifyIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Return a specific gotify endpoint</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterNotificationsEndpointsGotifyIdx [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Name of the endpoint.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterNotificationsEndpointsSendmail" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterNotificationsEndpointsSendmail </h2>
|
|
<p></p>
|
|
<p class='searchable'>Returns a list of all sendmail endpoints</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterNotificationsEndpointsSendmail [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterNotificationsEndpointsSendmailIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterNotificationsEndpointsSendmailIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Return a specific sendmail endpoint</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterNotificationsEndpointsSendmailIdx [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterNotificationsEndpointsSmtp" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterNotificationsEndpointsSmtp </h2>
|
|
<p></p>
|
|
<p class='searchable'>Returns a list of all smtp endpoints</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterNotificationsEndpointsSmtp [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterNotificationsEndpointsSmtpIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterNotificationsEndpointsSmtpIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Return a specific smtp endpoint</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterNotificationsEndpointsSmtpIdx [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterNotificationsMatchers" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterNotificationsMatchers </h2>
|
|
<p></p>
|
|
<p class='searchable'>Returns a list of all matchers</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterNotificationsMatchers [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterNotificationsMatchersIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterNotificationsMatchersIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Return a specific matcher</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterNotificationsMatchersIdx [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterNotificationsTargets" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterNotificationsTargets </h2>
|
|
<p></p>
|
|
<p class='searchable'>Returns a list of all entities that can be used as notification targets.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterNotificationsTargets [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterOptions" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterOptions </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get datacenter options. Without 'Sys.Audit' on '/' not all options are returned.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterOptions [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterReplication" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterReplication </h2>
|
|
<p></p>
|
|
<p class='searchable'>List replication jobs.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterReplication [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterReplicationIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterReplicationIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read replication job configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterReplicationIdx [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterResources" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterResources </h2>
|
|
<p></p>
|
|
<p class='searchable'>Resources index (cluster wide).</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterResources [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>-- Enum: vm,storage,node,sdn</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterSdn" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterSdn </h2>
|
|
<p></p>
|
|
<p class='searchable'>Directory index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterSdn [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterSdnControllers" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterSdnControllers </h2>
|
|
<p></p>
|
|
<p class='searchable'>SDN controllers index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterSdnControllers [[-PveTicket] <PveTicket>] [-Pending] [-Running] [[-Type] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pending</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Display pending config.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Running</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Display running config.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only list sdn controllers of specific type Enum: bgp,evpn,faucet,isis</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterSdnControllersIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterSdnControllersIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read sdn controller configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterSdnControllersIdx [[-PveTicket] <PveTicket>] [-Controller] <String> [-Pending] [-Running] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Controller</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN controller object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pending</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Display pending config.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Running</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Display running config.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterSdnDns" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterSdnDns </h2>
|
|
<p></p>
|
|
<p class='searchable'>SDN dns index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterSdnDns [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only list sdn dns of specific type Enum: powerdns</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterSdnDnsIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterSdnDnsIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read sdn dns configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterSdnDnsIdx [[-PveTicket] <PveTicket>] [-Dns] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dns</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN dns object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterSdnIpams" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterSdnIpams </h2>
|
|
<p></p>
|
|
<p class='searchable'>SDN ipams index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterSdnIpams [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only list sdn ipams of specific type Enum: netbox,phpipam,pve</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterSdnIpamsIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterSdnIpamsIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read sdn ipam configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterSdnIpamsIdx [[-PveTicket] <PveTicket>] [-Ipam] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ipam</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN ipam object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterSdnIpamsStatus" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterSdnIpamsStatus </h2>
|
|
<p></p>
|
|
<p class='searchable'>List PVE IPAM Entries</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterSdnIpamsStatus [[-PveTicket] <PveTicket>] [-Ipam] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ipam</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN ipam object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterSdnVnets" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterSdnVnets </h2>
|
|
<p></p>
|
|
<p class='searchable'>SDN vnets index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterSdnVnets [[-PveTicket] <PveTicket>] [-Pending] [-Running] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pending</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Display pending config.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Running</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Display running config.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterSdnVnetsIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterSdnVnetsIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read sdn vnet configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterSdnVnetsIdx [[-PveTicket] <PveTicket>] [-Pending] [-Running] [-Vnet] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pending</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Display pending config.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Running</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Display running config.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vnet</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN vnet object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterSdnVnetsSubnets" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterSdnVnetsSubnets </h2>
|
|
<p></p>
|
|
<p class='searchable'>SDN subnets index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterSdnVnetsSubnets [[-PveTicket] <PveTicket>] [-Pending] [-Running] [-Vnet] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pending</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Display pending config.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Running</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Display running config.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vnet</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN vnet object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterSdnVnetsSubnetsIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterSdnVnetsSubnetsIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read sdn subnet configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterSdnVnetsSubnetsIdx [[-PveTicket] <PveTicket>] [-Pending] [-Running] [-Subnet] <String> [-Vnet] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pending</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Display pending config.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Running</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Display running config.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Subnet</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN subnet object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vnet</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN vnet object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterSdnZones" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterSdnZones </h2>
|
|
<p></p>
|
|
<p class='searchable'>SDN zones index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterSdnZones [[-PveTicket] <PveTicket>] [-Pending] [-Running] [[-Type] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pending</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Display pending config.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Running</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Display running config.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only list SDN zones of specific type Enum: evpn,faucet,qinq,simple,vlan,vxlan</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterSdnZonesIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterSdnZonesIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read sdn zone configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterSdnZonesIdx [[-PveTicket] <PveTicket>] [-Pending] [-Running] [-Zone] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pending</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Display pending config.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Running</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Display running config.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Zone</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN zone object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterStatus" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterStatus </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get cluster status information.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterStatus [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveClusterTasks" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveClusterTasks </h2>
|
|
<p></p>
|
|
<p class='searchable'>List recent tasks (cluster wide).</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveClusterTasks [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNode" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNode </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get nodes</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNode [[-PveTicket] <PveTicket>] [[-Node] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The Name of the node.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PSCustomObject. Return Vm Data.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodes" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodes </h2>
|
|
<p></p>
|
|
<p class='searchable'>Cluster node index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodes [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesAplinfo" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesAplinfo </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get list of appliances.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesAplinfo [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesApt" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesApt </h2>
|
|
<p></p>
|
|
<p class='searchable'>Directory index for apt (Advanced Package Tool).</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesApt [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesAptChangelog" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesAptChangelog </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get package changelogs.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesAptChangelog [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [[-Version] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Package name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Version</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Package version.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesAptRepositories" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesAptRepositories </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get APT repository information.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesAptRepositories [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesAptUpdate" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesAptUpdate </h2>
|
|
<p></p>
|
|
<p class='searchable'>List available updates.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesAptUpdate [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesAptVersions" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesAptVersions </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get package information for important Proxmox packages.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesAptVersions [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesCapabilities" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesCapabilities </h2>
|
|
<p></p>
|
|
<p class='searchable'>Node capabilities index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesCapabilities [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesCapabilitiesQemu" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesCapabilitiesQemu </h2>
|
|
<p></p>
|
|
<p class='searchable'>QEMU capabilities index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesCapabilitiesQemu [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesCapabilitiesQemuCpu" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesCapabilitiesQemuCpu </h2>
|
|
<p></p>
|
|
<p class='searchable'>List all custom and default CPU models.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesCapabilitiesQemuCpu [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesCapabilitiesQemuMachines" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesCapabilitiesQemuMachines </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get available QEMU/KVM machine types.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesCapabilitiesQemuMachines [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesCeph" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesCeph </h2>
|
|
<p></p>
|
|
<p class='searchable'>Directory index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesCeph [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesCephCfg" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesCephCfg </h2>
|
|
<p></p>
|
|
<p class='searchable'>Directory index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesCephCfg [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesCephCfgDb" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesCephCfgDb </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get the Ceph configuration database.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesCephCfgDb [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesCephCfgRaw" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesCephCfgRaw </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get the Ceph configuration file.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesCephCfgRaw [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesCephCfgValue" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesCephCfgValue </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get configured values from either the config file or config DB.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesCephCfgValue [[-PveTicket] <PveTicket>] [-ConfigKeys] <String> [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ConfigKeys</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of <section>':'<config key> items.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesCephCmdSafety" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesCephCmdSafety </h2>
|
|
<p></p>
|
|
<p class='searchable'>Heuristical check if it is safe to perform an action.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesCephCmdSafety [[-PveTicket] <PveTicket>] [-Action] <String> [-Id] <String> [-Node] <String> [-Service] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Action</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Action to check Enum: stop,destroy</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>ID of the service</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Service</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Service type Enum: osd,mon,mds</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesCephCrush" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesCephCrush </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get OSD crush map</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesCephCrush [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesCephFs" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesCephFs </h2>
|
|
<p></p>
|
|
<p class='searchable'>Directory index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesCephFs [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesCephLog" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesCephLog </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read ceph log</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesCephLog [[-PveTicket] <PveTicket>] [[-Limit] <Int32>] [-Node] <String> [[-Start] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Limit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Start</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesCephMds" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesCephMds </h2>
|
|
<p></p>
|
|
<p class='searchable'>MDS directory index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesCephMds [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesCephMgr" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesCephMgr </h2>
|
|
<p></p>
|
|
<p class='searchable'>MGR directory index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesCephMgr [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesCephMon" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesCephMon </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get Ceph monitor list.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesCephMon [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesCephOsd" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesCephOsd </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get Ceph osd list/tree.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesCephOsd [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesCephOsdIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesCephOsdIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>OSD index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesCephOsdIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Osdid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Osdid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>OSD ID</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesCephOsdLvInfo" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesCephOsdLvInfo </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get OSD volume details</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesCephOsdLvInfo [[-PveTicket] <PveTicket>] [-Node] <String> [-Osdid] <Int32> [[-Type] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Osdid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>OSD ID</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>OSD device type Enum: block,db,wal</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesCephOsdMetadata" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesCephOsdMetadata </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get OSD details</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesCephOsdMetadata [[-PveTicket] <PveTicket>] [-Node] <String> [-Osdid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Osdid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>OSD ID</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesCephPool" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesCephPool </h2>
|
|
<p></p>
|
|
<p class='searchable'>List all pools and their settings (which are settable by the POST/PUT endpoints).</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesCephPool [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesCephPoolIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesCephPoolIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Pool index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesCephPoolIdx [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the pool.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesCephPoolStatus" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesCephPoolStatus </h2>
|
|
<p></p>
|
|
<p class='searchable'>Show the current pool status.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesCephPoolStatus [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [-Verbose_] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the pool. It must be unique.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Verbose_</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>If enabled, will display additional data(eg. statistics).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesCephRules" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesCephRules </h2>
|
|
<p></p>
|
|
<p class='searchable'>List ceph rules.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesCephRules [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesCephStatus" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesCephStatus </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get ceph status.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesCephStatus [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesCertificates" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesCertificates </h2>
|
|
<p></p>
|
|
<p class='searchable'>Node index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesCertificates [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesCertificatesAcme" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesCertificatesAcme </h2>
|
|
<p></p>
|
|
<p class='searchable'>ACME index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesCertificatesAcme [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesCertificatesInfo" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesCertificatesInfo </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get information about node's certificates.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesCertificatesInfo [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesConfig" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesConfig </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get node configuration options.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesConfig [[-PveTicket] <PveTicket>] [-Node] <String> [[-Property] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Property</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Return only a specific property from the node configuration. Enum: acme,acmedomain0,acmedomain1,acmedomain2,acmedomain3,acmedomain4,acmedomain5,description,startall-onboot-delay,wakeonlan</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesDisks" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesDisks </h2>
|
|
<p></p>
|
|
<p class='searchable'>Node index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesDisks [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesDisksDirectory" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesDisksDirectory </h2>
|
|
<p></p>
|
|
<p class='searchable'>PVE Managed Directory storages.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesDisksDirectory [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesDisksList" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesDisksList </h2>
|
|
<p></p>
|
|
<p class='searchable'>List local disks.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesDisksList [[-PveTicket] <PveTicket>] [-IncludePartitions] [-Node] <String> [-Skipsmart] [[-Type] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-IncludePartitions</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Also include partitions.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Skipsmart</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Skip smart checks.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only list specific types of disks. Enum: unused,journal_disks</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesDisksLvm" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesDisksLvm </h2>
|
|
<p></p>
|
|
<p class='searchable'>List LVM Volume Groups</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesDisksLvm [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesDisksLvmthin" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesDisksLvmthin </h2>
|
|
<p></p>
|
|
<p class='searchable'>List LVM thinpools</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesDisksLvmthin [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesDisksSmart" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesDisksSmart </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get SMART Health of a disk.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesDisksSmart [[-PveTicket] <PveTicket>] [-Disk] <String> [-Healthonly] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Disk</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Block device name</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Healthonly</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>If true returns only the health status</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesDisksZfs" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesDisksZfs </h2>
|
|
<p></p>
|
|
<p class='searchable'>List Zpools.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesDisksZfs [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesDisksZfsIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesDisksZfsIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get details about a zpool.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesDisksZfsIdx [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesDns" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesDns </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read DNS settings.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesDns [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesFirewall" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesFirewall </h2>
|
|
<p></p>
|
|
<p class='searchable'>Directory index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesFirewall [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesFirewallLog" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesFirewallLog </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read firewall log</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesFirewallLog [[-PveTicket] <PveTicket>] [[-Limit] <Int32>] [-Node] <String> [[-Since] <Int32>] [[-Start] <Int32>] [[-Until] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Limit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Since</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Display log since this UNIX epoch.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Start</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Until</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Display log until this UNIX epoch.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesFirewallOptions" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesFirewallOptions </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get host firewall options.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesFirewallOptions [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesFirewallRules" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesFirewallRules </h2>
|
|
<p></p>
|
|
<p class='searchable'>List rules.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesFirewallRules [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesFirewallRulesIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesFirewallRulesIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get single rule data.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesFirewallRulesIdx [[-PveTicket] <PveTicket>] [-Node] <String> [[-Pos] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pos</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Update rule at position <pos>.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesHardware" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesHardware </h2>
|
|
<p></p>
|
|
<p class='searchable'>Index of hardware types</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesHardware [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesHardwarePci" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesHardwarePci </h2>
|
|
<p></p>
|
|
<p class='searchable'>List local PCI devices.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesHardwarePci [[-PveTicket] <PveTicket>] [-Node] <String> [[-PciClassBlacklist] <String>] [-Verbose_] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PciClassBlacklist</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of blacklisted PCI classes, which will not be returned. Following are filtered by default':' Memory Controller (05), Bridge (06) and Processor (0b).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Verbose_</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>If disabled, does only print the PCI IDs. Otherwise, additional information like vendor and device will be returned.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesHardwarePciIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesHardwarePciIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Index of available pci methods</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesHardwarePciIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Pciid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pciid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesHardwarePciMdev" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesHardwarePciMdev </h2>
|
|
<p></p>
|
|
<p class='searchable'>List mediated device types for given PCI device.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesHardwarePciMdev [[-PveTicket] <PveTicket>] [-Node] <String> [-Pciid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pciid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The PCI ID to list the mdev types for.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesHardwareUsb" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesHardwareUsb </h2>
|
|
<p></p>
|
|
<p class='searchable'>List local USB devices.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesHardwareUsb [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesHosts" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesHosts </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get the content of /etc/hosts.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesHosts [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Node index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesIdx [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesJournal" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesJournal </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read Journal</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesJournal [[-PveTicket] <PveTicket>] [[-Endcursor] <String>] [[-Lastentries] <Int32>] [-Node] <String> [[-Since] <Int32>] [[-Startcursor] <String>] [[-Until] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Endcursor</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>End before the given Cursor. Conflicts with 'until'</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Lastentries</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Limit to the last X lines. Conflicts with a range.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Since</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Display all log since this UNIX epoch. Conflicts with 'startcursor'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Startcursor</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Start after the given Cursor. Conflicts with 'since'</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Until</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Display all log until this UNIX epoch. Conflicts with 'endcursor'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesLxc" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesLxc </h2>
|
|
<p></p>
|
|
<p class='searchable'>LXC container index (per node).</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesLxc [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesLxcConfig" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesLxcConfig </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get container configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesLxcConfig [[-PveTicket] <PveTicket>] [-Current] [-Node] <String> [[-Snapshot] <String>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Current</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Get current values (instead of pending values).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Snapshot</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Fetch config values from given snapshot.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesLxcFeature" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesLxcFeature </h2>
|
|
<p></p>
|
|
<p class='searchable'>Check if feature for virtual machine is available.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesLxcFeature [[-PveTicket] <PveTicket>] [-Feature] <String> [-Node] <String> [[-Snapname] <String>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Feature</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Feature to check. Enum: snapshot,clone,copy</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Snapname</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the snapshot.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesLxcFirewall" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesLxcFirewall </h2>
|
|
<p></p>
|
|
<p class='searchable'>Directory index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesLxcFirewall [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesLxcFirewallAliases" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesLxcFirewallAliases </h2>
|
|
<p></p>
|
|
<p class='searchable'>List aliases</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesLxcFirewallAliases [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesLxcFirewallAliasesIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesLxcFirewallAliasesIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read alias.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesLxcFirewallAliasesIdx [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Alias name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesLxcFirewallIpset" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesLxcFirewallIpset </h2>
|
|
<p></p>
|
|
<p class='searchable'>List IPSets</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesLxcFirewallIpset [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesLxcFirewallIpsetIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesLxcFirewallIpsetIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read IP or Network settings from IPSet.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesLxcFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cidr</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network/IP specification in CIDR format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP set name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesLxcFirewallLog" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesLxcFirewallLog </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read firewall log</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesLxcFirewallLog [[-PveTicket] <PveTicket>] [[-Limit] <Int32>] [-Node] <String> [[-Since] <Int32>] [[-Start] <Int32>] [[-Until] <Int32>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Limit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Since</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Display log since this UNIX epoch.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Start</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Until</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Display log until this UNIX epoch.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesLxcFirewallOptions" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesLxcFirewallOptions </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get VM firewall options.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesLxcFirewallOptions [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesLxcFirewallRefs" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesLxcFirewallRefs </h2>
|
|
<p></p>
|
|
<p class='searchable'>Lists possible IPSet/Alias reference which are allowed in source/dest properties.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesLxcFirewallRefs [[-PveTicket] <PveTicket>] [-Node] <String> [[-Type] <String>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only list references of specified type. Enum: alias,ipset</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesLxcFirewallRules" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesLxcFirewallRules </h2>
|
|
<p></p>
|
|
<p class='searchable'>List rules.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesLxcFirewallRules [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesLxcFirewallRulesIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesLxcFirewallRulesIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get single rule data.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesLxcFirewallRulesIdx [[-PveTicket] <PveTicket>] [-Node] <String> [[-Pos] <Int32>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pos</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Update rule at position <pos>.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesLxcIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesLxcIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Directory index</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesLxcIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesLxcInterfaces" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesLxcInterfaces </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get IP addresses of the specified container interface.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesLxcInterfaces [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesLxcMtunnelwebsocket" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesLxcMtunnelwebsocket </h2>
|
|
<p></p>
|
|
<p class='searchable'>Migration tunnel endpoint for websocket upgrade - only for internal use by VM migration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesLxcMtunnelwebsocket [[-PveTicket] <PveTicket>] [-Node] <String> [-Socket] <String> [-Ticket] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Socket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>unix socket to forward to</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ticket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>ticket return by initial 'mtunnel' API call, or retrieved via 'ticket' tunnel command</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesLxcPending" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesLxcPending </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get container configuration, including pending changes.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesLxcPending [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesLxcRrd" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesLxcRrd </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read VM RRD statistics (returns PNG)</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesLxcRrd [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Ds] <String> [-Node] <String> [-Timeframe] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cf</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The RRD consolidation function Enum: AVERAGE,MAX</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ds</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The list of datasources you want to display.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Timeframe</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify the time frame you are interested in. Enum: hour,day,week,month,year</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesLxcRrddata" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesLxcRrddata </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read VM RRD statistics</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesLxcRrddata [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Node] <String> [-Timeframe] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cf</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The RRD consolidation function Enum: AVERAGE,MAX</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Timeframe</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify the time frame you are interested in. Enum: hour,day,week,month,year</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesLxcSnapshot" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesLxcSnapshot </h2>
|
|
<p></p>
|
|
<p class='searchable'>List all snapshots.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesLxcSnapshot [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesLxcSnapshotConfig" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesLxcSnapshotConfig </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get snapshot configuration</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesLxcSnapshotConfig [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Snapname</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the snapshot.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesLxcSnapshotIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesLxcSnapshotIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>--</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesLxcSnapshotIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Snapname</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the snapshot.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesLxcStatus" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesLxcStatus </h2>
|
|
<p></p>
|
|
<p class='searchable'>Directory index</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesLxcStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesLxcStatusCurrent" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesLxcStatusCurrent </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get virtual machine status.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesLxcStatusCurrent [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesLxcVncwebsocket" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesLxcVncwebsocket </h2>
|
|
<p></p>
|
|
<p class='searchable'>Opens a weksocket for VNC traffic.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesLxcVncwebsocket [[-PveTicket] <PveTicket>] [-Node] <String> [-Port] <Int32> [-Vmid] <Int32> [-Vncticket] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Port</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Port number returned by previous vncproxy call.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vncticket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket from previous call to vncproxy.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesNetstat" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesNetstat </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read tap/vm network device interface counters</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesNetstat [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesNetwork" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesNetwork </h2>
|
|
<p></p>
|
|
<p class='searchable'>List available networks</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesNetwork [[-PveTicket] <PveTicket>] [-Node] <String> [[-Type] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only list specific interface types. Enum: bridge,bond,eth,alias,vlan,OVSBridge,OVSBond,OVSPort,OVSIntPort,any_bridge,any_local_bridge</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesNetworkIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesNetworkIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read network device configuration</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesNetworkIdx [[-PveTicket] <PveTicket>] [-Iface] <String> [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Iface</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network interface name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemu" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemu </h2>
|
|
<p></p>
|
|
<p class='searchable'>Virtual machine index (per node).</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemu [[-PveTicket] <PveTicket>] [-Full] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Full</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Determine the full status of active VMs.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuAgent" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuAgent </h2>
|
|
<p></p>
|
|
<p class='searchable'>QEMU Guest Agent command index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuAgent [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuAgentExecStatus" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuAgentExecStatus </h2>
|
|
<p></p>
|
|
<p class='searchable'>Gets the status of the given pid started by the guest-agent</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuAgentExecStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Pid_] <Int32> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pid_</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The PID to query</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuAgentFileRead" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuAgentFileRead </h2>
|
|
<p></p>
|
|
<p class='searchable'>Reads the given file via guest agent. Is limited to 16777216 bytes.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuAgentFileRead [[-PveTicket] <PveTicket>] [-File] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-File</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The path to the file</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuAgentGetFsinfo" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuAgentGetFsinfo </h2>
|
|
<p></p>
|
|
<p class='searchable'>Execute get-fsinfo.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuAgentGetFsinfo [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuAgentGetHostName" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuAgentGetHostName </h2>
|
|
<p></p>
|
|
<p class='searchable'>Execute get-host-name.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuAgentGetHostName [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuAgentGetMemoryBlockInfo" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuAgentGetMemoryBlockInfo </h2>
|
|
<p></p>
|
|
<p class='searchable'>Execute get-memory-block-info.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuAgentGetMemoryBlockInfo [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuAgentGetMemoryBlocks" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuAgentGetMemoryBlocks </h2>
|
|
<p></p>
|
|
<p class='searchable'>Execute get-memory-blocks.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuAgentGetMemoryBlocks [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuAgentGetOsinfo" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuAgentGetOsinfo </h2>
|
|
<p></p>
|
|
<p class='searchable'>Execute get-osinfo.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuAgentGetOsinfo [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuAgentGetTime" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuAgentGetTime </h2>
|
|
<p></p>
|
|
<p class='searchable'>Execute get-time.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuAgentGetTime [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuAgentGetTimezone" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuAgentGetTimezone </h2>
|
|
<p></p>
|
|
<p class='searchable'>Execute get-timezone.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuAgentGetTimezone [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuAgentGetUsers" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuAgentGetUsers </h2>
|
|
<p></p>
|
|
<p class='searchable'>Execute get-users.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuAgentGetUsers [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuAgentGetVcpus" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuAgentGetVcpus </h2>
|
|
<p></p>
|
|
<p class='searchable'>Execute get-vcpus.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuAgentGetVcpus [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuAgentInfo" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuAgentInfo </h2>
|
|
<p></p>
|
|
<p class='searchable'>Execute info.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuAgentInfo [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuAgentNetworkGetInterfaces" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuAgentNetworkGetInterfaces </h2>
|
|
<p></p>
|
|
<p class='searchable'>Execute network-get-interfaces.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuAgentNetworkGetInterfaces [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuCloudinit" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuCloudinit </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get the cloudinit configuration with both current and pending values.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuCloudinit [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuCloudinitDump" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuCloudinitDump </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get automatically generated cloudinit config.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuCloudinitDump [[-PveTicket] <PveTicket>] [-Node] <String> [-Type] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Config type. Enum: user,network,meta</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuConfig" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuConfig </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get the virtual machine configuration with pending configuration changes applied. Set the 'current' parameter to get the current configuration instead.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuConfig [[-PveTicket] <PveTicket>] [-Current] [-Node] <String> [[-Snapshot] <String>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Current</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Get current values (instead of pending values).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Snapshot</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Fetch config values from given snapshot.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuFeature" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuFeature </h2>
|
|
<p></p>
|
|
<p class='searchable'>Check if feature for virtual machine is available.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuFeature [[-PveTicket] <PveTicket>] [-Feature] <String> [-Node] <String> [[-Snapname] <String>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Feature</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Feature to check. Enum: snapshot,clone,copy</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Snapname</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the snapshot.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuFirewall" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuFirewall </h2>
|
|
<p></p>
|
|
<p class='searchable'>Directory index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuFirewall [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuFirewallAliases" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuFirewallAliases </h2>
|
|
<p></p>
|
|
<p class='searchable'>List aliases</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuFirewallAliases [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuFirewallAliasesIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuFirewallAliasesIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read alias.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuFirewallAliasesIdx [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Alias name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuFirewallIpset" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuFirewallIpset </h2>
|
|
<p></p>
|
|
<p class='searchable'>List IPSets</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuFirewallIpset [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuFirewallIpsetIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuFirewallIpsetIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read IP or Network settings from IPSet.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cidr</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network/IP specification in CIDR format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP set name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuFirewallLog" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuFirewallLog </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read firewall log</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuFirewallLog [[-PveTicket] <PveTicket>] [[-Limit] <Int32>] [-Node] <String> [[-Since] <Int32>] [[-Start] <Int32>] [[-Until] <Int32>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Limit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Since</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Display log since this UNIX epoch.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Start</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Until</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Display log until this UNIX epoch.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuFirewallOptions" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuFirewallOptions </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get VM firewall options.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuFirewallOptions [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuFirewallRefs" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuFirewallRefs </h2>
|
|
<p></p>
|
|
<p class='searchable'>Lists possible IPSet/Alias reference which are allowed in source/dest properties.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuFirewallRefs [[-PveTicket] <PveTicket>] [-Node] <String> [[-Type] <String>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only list references of specified type. Enum: alias,ipset</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuFirewallRules" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuFirewallRules </h2>
|
|
<p></p>
|
|
<p class='searchable'>List rules.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuFirewallRules [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuFirewallRulesIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuFirewallRulesIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get single rule data.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuFirewallRulesIdx [[-PveTicket] <PveTicket>] [-Node] <String> [[-Pos] <Int32>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pos</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Update rule at position <pos>.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Directory index</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuMigrate" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuMigrate </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get preconditions for migration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuMigrate [[-PveTicket] <PveTicket>] [-Node] <String> [[-Target] <String>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Target</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Target node.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuMtunnelwebsocket" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuMtunnelwebsocket </h2>
|
|
<p></p>
|
|
<p class='searchable'>Migration tunnel endpoint for websocket upgrade - only for internal use by VM migration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuMtunnelwebsocket [[-PveTicket] <PveTicket>] [-Node] <String> [-Socket] <String> [-Ticket] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Socket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>unix socket to forward to</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ticket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>ticket return by initial 'mtunnel' API call, or retrieved via 'ticket' tunnel command</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuPending" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuPending </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get the virtual machine configuration with both current and pending values.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuPending [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuRrd" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuRrd </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read VM RRD statistics (returns PNG)</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuRrd [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Ds] <String> [-Node] <String> [-Timeframe] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cf</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The RRD consolidation function Enum: AVERAGE,MAX</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ds</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The list of datasources you want to display.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Timeframe</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify the time frame you are interested in. Enum: hour,day,week,month,year</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuRrddata" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuRrddata </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read VM RRD statistics</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuRrddata [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Node] <String> [-Timeframe] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cf</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The RRD consolidation function Enum: AVERAGE,MAX</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Timeframe</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify the time frame you are interested in. Enum: hour,day,week,month,year</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuSnapshot" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuSnapshot </h2>
|
|
<p></p>
|
|
<p class='searchable'>List all snapshots.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuSnapshotConfig" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuSnapshotConfig </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get snapshot configuration</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuSnapshotConfig [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Snapname</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the snapshot.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuSnapshotIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuSnapshotIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>--</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuSnapshotIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Snapname</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the snapshot.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuStatus" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuStatus </h2>
|
|
<p></p>
|
|
<p class='searchable'>Directory index</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuStatusCurrent" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuStatusCurrent </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get virtual machine status.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuStatusCurrent [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQemuVncwebsocket" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQemuVncwebsocket </h2>
|
|
<p></p>
|
|
<p class='searchable'>Opens a weksocket for VNC traffic.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQemuVncwebsocket [[-PveTicket] <PveTicket>] [-Node] <String> [-Port] <Int32> [-Vmid] <Int32> [-Vncticket] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Port</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Port number returned by previous vncproxy call.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vncticket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket from previous call to vncproxy.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesQueryUrlMetadata" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesQueryUrlMetadata </h2>
|
|
<p></p>
|
|
<p class='searchable'>Query metadata of an URL':' file size, file name and mime type.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesQueryUrlMetadata [[-PveTicket] <PveTicket>] [-Node] <String> [-Url] <String> [-VerifyCertificates] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Url</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The URL to query the metadata from.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VerifyCertificates</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>If false, no SSL/TLS certificates will be verified.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesReplication" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesReplication </h2>
|
|
<p></p>
|
|
<p class='searchable'>List status of all replication jobs on this node.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesReplication [[-PveTicket] <PveTicket>] [[-Guest] <Int32>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Guest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only list replication jobs for this guest.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesReplicationIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesReplicationIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Directory index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesReplicationIdx [[-PveTicket] <PveTicket>] [-Id] <String> [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesReplicationLog" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesReplicationLog </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read replication job log.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesReplicationLog [[-PveTicket] <PveTicket>] [-Id] <String> [[-Limit] <Int32>] [-Node] <String> [[-Start] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Limit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Start</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesReplicationStatus" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesReplicationStatus </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get replication job status.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesReplicationStatus [[-PveTicket] <PveTicket>] [-Id] <String> [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesReport" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesReport </h2>
|
|
<p></p>
|
|
<p class='searchable'>Gather various systems information about a node</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesReport [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesRrd" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesRrd </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read node RRD statistics (returns PNG)</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesRrd [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Ds] <String> [-Node] <String> [-Timeframe] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cf</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The RRD consolidation function Enum: AVERAGE,MAX</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ds</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The list of datasources you want to display.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Timeframe</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify the time frame you are interested in. Enum: hour,day,week,month,year</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesRrddata" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesRrddata </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read node RRD statistics</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesRrddata [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Node] <String> [-Timeframe] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cf</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The RRD consolidation function Enum: AVERAGE,MAX</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Timeframe</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify the time frame you are interested in. Enum: hour,day,week,month,year</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesScan" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesScan </h2>
|
|
<p></p>
|
|
<p class='searchable'>Index of available scan methods</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesScan [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesScanCifs" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesScanCifs </h2>
|
|
<p></p>
|
|
<p class='searchable'>Scan remote CIFS server.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesScanCifs [[-PveTicket] <PveTicket>] [[-Domain] <String>] [-Node] <String> [[-Password] <SecureString>] [-Server] <String> [[-Username] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Domain</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>SMB domain (Workgroup).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Password</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>User password.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Server</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The server address (name or IP).</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Username</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>User name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesScanGlusterfs" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesScanGlusterfs </h2>
|
|
<p></p>
|
|
<p class='searchable'>Scan remote GlusterFS server.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesScanGlusterfs [[-PveTicket] <PveTicket>] [-Node] <String> [-Server] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Server</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The server address (name or IP).</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesScanIscsi" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesScanIscsi </h2>
|
|
<p></p>
|
|
<p class='searchable'>Scan remote iSCSI server.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesScanIscsi [[-PveTicket] <PveTicket>] [-Node] <String> [-Portal] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Portal</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The iSCSI portal (IP or DNS name with optional port).</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesScanLvm" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesScanLvm </h2>
|
|
<p></p>
|
|
<p class='searchable'>List local LVM volume groups.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesScanLvm [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesScanLvmthin" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesScanLvmthin </h2>
|
|
<p></p>
|
|
<p class='searchable'>List local LVM Thin Pools.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesScanLvmthin [[-PveTicket] <PveTicket>] [-Node] <String> [-Vg] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vg</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesScanNfs" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesScanNfs </h2>
|
|
<p></p>
|
|
<p class='searchable'>Scan remote NFS server.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesScanNfs [[-PveTicket] <PveTicket>] [-Node] <String> [-Server] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Server</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The server address (name or IP).</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesScanPbs" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesScanPbs </h2>
|
|
<p></p>
|
|
<p class='searchable'>Scan remote Proxmox Backup Server.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesScanPbs [[-PveTicket] <PveTicket>] [[-Fingerprint] <String>] [-Node] <String> [-Password] <SecureString> [[-Port] <Int32>] [-Server] <String> [-Username] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Fingerprint</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Certificate SHA 256 fingerprint.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Password</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>User password or API token secret.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Port</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Optional port.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Server</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The server address (name or IP).</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Username</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>User-name or API token-ID.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesScanZfs" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesScanZfs </h2>
|
|
<p></p>
|
|
<p class='searchable'>Scan zfs pool list on local node.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesScanZfs [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesSdn" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesSdn </h2>
|
|
<p></p>
|
|
<p class='searchable'>SDN index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesSdn [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesSdnZones" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesSdnZones </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get status for all zones.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesSdnZones [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesSdnZonesContent" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesSdnZonesContent </h2>
|
|
<p></p>
|
|
<p class='searchable'>List zone content.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesSdnZonesContent [[-PveTicket] <PveTicket>] [-Node] <String> [-Zone] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Zone</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN zone object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesSdnZonesIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesSdnZonesIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>--</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesSdnZonesIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Zone] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Zone</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN zone object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesServices" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesServices </h2>
|
|
<p></p>
|
|
<p class='searchable'>Service list.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesServices [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesServicesIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesServicesIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Directory index</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesServicesIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Service] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Service</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Service ID Enum: chrony,corosync,cron,ksmtuned,postfix,pve-cluster,pve-firewall,pve-ha-crm,pve-ha-lrm,pvedaemon,pvefw-logger,pveproxy,pvescheduler,pvestatd,spiceproxy,sshd,syslog,systemd-journald,systemd-timesyncd</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesServicesState" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesServicesState </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read service properties</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesServicesState [[-PveTicket] <PveTicket>] [-Node] <String> [-Service] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Service</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Service ID Enum: chrony,corosync,cron,ksmtuned,postfix,pve-cluster,pve-firewall,pve-ha-crm,pve-ha-lrm,pvedaemon,pvefw-logger,pveproxy,pvescheduler,pvestatd,spiceproxy,sshd,syslog,systemd-journald,systemd-timesyncd</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesStatus" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesStatus </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read node status</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesStatus [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesStorage" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesStorage </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get status for all datastores.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesStorage [[-PveTicket] <PveTicket>] [[-Content] <String>] [-Enabled] [-Format] [-Node] <String> [[-Storage] <String>] [[-Target] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Content</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only list stores which support this content type.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Enabled</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only list stores which are enabled (not disabled in config).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Format</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Include information about formats</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only list status for specified storage</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Target</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesStorageContent" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesStorageContent </h2>
|
|
<p></p>
|
|
<p class='searchable'>List storage content.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesStorageContent [[-PveTicket] <PveTicket>] [[-Content] <String>] [-Node] <String> [-Storage] <String> [[-Vmid] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Content</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only list content of this type.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only list images for this VM</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesStorageContentIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesStorageContentIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get volume attributes</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesStorageContentIdx [[-PveTicket] <PveTicket>] [-Node] <String> [[-Storage] <String>] [-Volume] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Volume</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Volume identifier</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesStorageIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesStorageIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>--</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesStorageIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Storage] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesStoragePrunebackups" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesStoragePrunebackups </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get prune information for backups. NOTE':' this is only a preview and might not be what a subsequent prune call does if backups are removed/added in the meantime.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesStoragePrunebackups [[-PveTicket] <PveTicket>] [-Node] <String> [[-PruneBackups] <String>] [-Storage] <String> [[-Type] <String>] [[-Vmid] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PruneBackups</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use these retention options instead of those from the storage configuration.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Either 'qemu' or 'lxc'. Only consider backups for guests of this type. Enum: qemu,lxc</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only consider backups for this guest.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesStorageRrd" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesStorageRrd </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read storage RRD statistics (returns PNG).</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesStorageRrd [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Ds] <String> [-Node] <String> [-Storage] <String> [-Timeframe] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cf</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The RRD consolidation function Enum: AVERAGE,MAX</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ds</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The list of datasources you want to display.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Timeframe</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify the time frame you are interested in. Enum: hour,day,week,month,year</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesStorageRrddata" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesStorageRrddata </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read storage RRD statistics.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesStorageRrddata [[-PveTicket] <PveTicket>] [[-Cf] <String>] [-Node] <String> [-Storage] <String> [-Timeframe] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cf</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The RRD consolidation function Enum: AVERAGE,MAX</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Timeframe</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify the time frame you are interested in. Enum: hour,day,week,month,year</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesStorageStatus" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesStorageStatus </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read storage status.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesStorageStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Storage] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesSubscription" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesSubscription </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read subscription info.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesSubscription [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesSyslog" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesSyslog </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read system log</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesSyslog [[-PveTicket] <PveTicket>] [[-Limit] <Int32>] [-Node] <String> [[-Service] <String>] [[-Since] <String>] [[-Start] <Int32>] [[-Until] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Limit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Service</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Service ID</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Since</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Display all log since this date-time string.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Start</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Until</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Display all log until this date-time string.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesTasks" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesTasks </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read task list for one node (finished tasks).</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesTasks [[-PveTicket] <PveTicket>] [-Errors] [[-Limit] <Int32>] [-Node] <String> [[-Since] <Int32>] [[-Source] <String>] [[-Start] <Int32>] [[-Statusfilter] <String>] [[-Typefilter] <String>] [[-Until] <Int32>] [[-Userfilter] <String>] [[-Vmid] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Errors</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only list tasks with a status of ERROR.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Limit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only list this amount of tasks.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Since</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only list tasks since this UNIX epoch.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Source</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List archived, active or all tasks. Enum: archive,active,all</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Start</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List tasks beginning from this offset.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Statusfilter</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of Task States that should be returned.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Typefilter</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only list tasks of this type (e.g., vzstart, vzdump).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Until</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only list tasks until this UNIX epoch.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Userfilter</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only list tasks from this user.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only list tasks for this VM.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesTasksIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesTasksIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>--</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesTasksIdx [[-PveTicket] <PveTicket>] [-Node] <String> [-Upid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Upid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesTasksLog" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesTasksLog </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read task log.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesTasksLog [[-PveTicket] <PveTicket>] [-Download] [[-Limit] <Int32>] [-Node] <String> [[-Start] <Int32>] [-Upid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Download</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Whether the tasklog file should be downloaded. This parameter can't be used in conjunction with other parameters</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Limit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The amount of lines to read from the tasklog.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Start</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Start at this line when reading the tasklog</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Upid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The task's unique ID.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesTasksStatus" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesTasksStatus </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read task status.</p>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-heading'>
|
|
<h3 class='panel-title'> Aliases </h3>
|
|
</div>
|
|
<div class='panel-body'>
|
|
<ul>
|
|
<li class='searchable'>Get-PveTasksStatus</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesTasksStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Upid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Upid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The task's unique ID.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesTime" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesTime </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read server time and time zone settings.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesTime [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesVersion" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesVersion </h2>
|
|
<p></p>
|
|
<p class='searchable'>API version details</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesVersion [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesVncwebsocket" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesVncwebsocket </h2>
|
|
<p></p>
|
|
<p class='searchable'>Opens a websocket for VNC traffic.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesVncwebsocket [[-PveTicket] <PveTicket>] [-Node] <String> [-Port] <Int32> [-Vncticket] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Port</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Port number returned by previous vncproxy call.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vncticket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket from previous call to vncproxy.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesVzdumpDefaults" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesVzdumpDefaults </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get the currently configured vzdump defaults.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesVzdumpDefaults [[-PveTicket] <PveTicket>] [-Node] <String> [[-Storage] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveNodesVzdumpExtractconfig" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveNodesVzdumpExtractconfig </h2>
|
|
<p></p>
|
|
<p class='searchable'>Extract configuration from vzdump backup archive.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveNodesVzdumpExtractconfig [[-PveTicket] <PveTicket>] [-Node] <String> [-Volume] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Volume</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Volume identifier</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PvePools" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PvePools </h2>
|
|
<p></p>
|
|
<p class='searchable'>List pools or get pool configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PvePools [[-PveTicket] <PveTicket>] [[-Poolid] <String>] [[-Type] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Poolid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>-- Enum: qemu,lxc,storage</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PvePoolsIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PvePoolsIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get pool configuration (deprecated, no support for nested pools, use 'GET /pools/?poolid={poolid}').</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PvePoolsIdx [[-PveTicket] <PveTicket>] [-Poolid] <String> [[-Type] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Poolid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>-- Enum: qemu,lxc,storage</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveStorage" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveStorage </h2>
|
|
<p></p>
|
|
<p class='searchable'>Storage index.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveStorage [[-PveTicket] <PveTicket>] [[-Type] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only list storage of specific type Enum: btrfs,cephfs,cifs,dir,glusterfs,iscsi,iscsidirect,lvm,lvmthin,nfs,pbs,rbd,zfs,zfspool</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveStorageIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveStorageIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Read storage configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveStorageIdx [[-PveTicket] <PveTicket>] [-Storage] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveTaskIsRunning" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveTaskIsRunning </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get task is running.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveTaskIsRunning [[-PveTicket] <PveTicket>] [-Upid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Upid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Upid task e.g UPID:pve1:00004A1A:0964214C:5EECEF11:vzdump:134:root@pam:</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>Bool. Return tas is running.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveVersion" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveVersion </h2>
|
|
<p></p>
|
|
<p class='searchable'>API version details, including some parts of the global datacenter config.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveVersion [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveVm" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveVm </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get VMs/CTs from id or name.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveVm [[-PveTicket] <PveTicket>] [[-VmIdOrName] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VmIdOrName</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The id or name VM/CT comma separated (eg. 100,101,102,TestDebian)-vmid or -name exclude (e.g. -200,-TestUbuntu)range 100:107,-105,200:204'@pool-???' for all VM/CT in specific pool (e.g. @pool-customer1),'@tag-???' for all VM/CT in specific tags (e.g. @tag-customerA),'@node-???' for all VM/CT in specific node (e.g. @node-pve1, @node-\$(hostname)),'@all-???' for all VM/CT in specific host (e.g. @all-pve1, @all-\$(hostname)),'@all' for all VM/CT in cluster";</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PSCustomObject. Return Vm Data.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Get-PveVmSnapshot" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Get-PveVmSnapshot </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get snapshots VM.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Get-PveVmSnapshot [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VmIdOrName</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID or Name of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Invoke-PveRestApi" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Invoke-PveRestApi </h2>
|
|
<p></p>
|
|
<p class='searchable'>Invoke Proxmox VE Rest API</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Invoke-PveRestApi [[-PveTicket] <PveTicket>] [-Resource] <String> [[-Method] <String>] [[-ResponseType] <String>] [[-Parameters] <Hashtable>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Resource</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Resource Request</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>false</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Method</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Method request</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>false</td>
|
|
<td class='visible-lg'>Get</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ResponseType</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Type request</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>false</td>
|
|
<td class='visible-lg'>json</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Parameters</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Parameters request</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>false</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>Return object request</li></ul>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-heading'>
|
|
<h3 class='panel-title'> Note </h3>
|
|
</div>
|
|
<div class='panel-body'>This must be used before any other cmdlets are used</div>
|
|
</div>
|
|
<div>
|
|
<h3> Examples </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<strong>EXAMPLE 1</strong>
|
|
<code class='powershell'>$PveTicket = Connect-PveCluster -HostsAndPorts '192.168.128.115' -Credentials (Get-Credential -Username 'root').
|
|
(Invoke-PveRestApi -PveTicket $PveTicket -Method Get -Resource '/version').Resonse.data</code>
|
|
<div>data----@{version=5.4; release=15; repoid=d0ec33c6; keyboard=it}</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="IsNumeric" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> IsNumeric </h2>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-x</nobr></td>
|
|
<td class='visible-lg visible-md searchable'>None</td>
|
|
<td class='searchable'></td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>false</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveAccessDomains" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveAccessDomains </h2>
|
|
<p></p>
|
|
<p class='searchable'>Add an authentication server.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveAccessDomains [[-PveTicket] <PveTicket>] [[-AcrValues] <String>] [-Autocreate] [[-BaseDn] <String>] [[-BindDn] <String>] [[-Capath] <String>] [-CaseSensitive] [[-Cert] <String>] [[-Certkey] <String>] [-CheckConnection] [[-ClientId] <String>] [[-ClientKey] <String>] [[-Comment] <String>] [-Default] [[-Domain] <String>] [[-Filter] <String>] [[-GroupClasses] <String>] [[-GroupDn] <String>] [[-GroupFilter] <String>] [[-GroupNameAttr] <String>] [[-IssuerUrl] <String>] [[-Mode] <String>] [[-Password] <SecureString>] [[-Port] <Int32>] [[-Prompt] <String>] [-Realm] <String> [[-Scopes] <String>] [-Secure] [[-Server1] <String>] [[-Server2] <String>] [[-Sslversion] <String>] [[-SyncDefaultsOptions] <String>] [[-SyncAttributes] <String>] [[-Tfa] <String>] [-Type] <String> [[-UserAttr] <String>] [[-UserClasses] <String>] [[-UsernameClaim] <String>] [-Verify] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-AcrValues</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Autocreate</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Automatically create users if they do not exist.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-BaseDn</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>LDAP base domain name</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-BindDn</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>LDAP bind domain name</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Capath</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Path to the CA certificate store</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-CaseSensitive</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>username is case-sensitive</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cert</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Path to the client certificate</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Certkey</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Path to the client certificate key</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-CheckConnection</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Check bind connection to the server.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ClientId</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>OpenID Client ID</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ClientKey</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>OpenID Client Key</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Description.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Default</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use this as default realm</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Domain</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>AD domain name</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Filter</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>LDAP filter for user sync.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-GroupClasses</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The objectclasses for groups.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-GroupDn</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>LDAP base domain name for group sync. If not set, the base_dn will be used.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-GroupFilter</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>LDAP filter for group sync.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-GroupNameAttr</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>LDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-IssuerUrl</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>OpenID Issuer Url</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mode</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>LDAP protocol mode. Enum: ldap,ldaps,ldap+starttls</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Password</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>LDAP bind password. Will be stored in '/etc/pve/priv/realm/<REALM>.pw'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Port</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Server port.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Prompt</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specifies whether the Authorization Server prompts the End-User for reauthentication and consent.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Realm</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Authentication domain ID</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Scopes</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Secure</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use secure LDAPS protocol. DEPRECATED':' use 'mode' instead.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Server1</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Server IP address (or DNS name)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Server2</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Fallback Server IP address (or DNS name)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Sslversion</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>LDAPS TLS/SSL version. It's not recommended to use version older than 1.2! Enum: tlsv1,tlsv1_1,tlsv1_2,tlsv1_3</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-SyncDefaultsOptions</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The default options for behavior of synchronizations.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-SyncAttributes</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Comma separated list of key=value pairs for specifying which LDAP attributes map to which PVE user field. For example, to map the LDAP attribute 'mail' to PVEs 'email', write 'email=mail'. By default, each PVE user field is represented by an LDAP attribute of the same name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tfa</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use Two-factor authentication.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Realm type. Enum: ad,ldap,openid,pam,pve</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-UserAttr</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>LDAP user attribute name</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-UserClasses</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The objectclasses for users.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-UsernameClaim</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>OpenID claim used to generate the unique username.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Verify</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Verify the server's SSL certificate</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveAccessDomainsSync" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveAccessDomainsSync </h2>
|
|
<p></p>
|
|
<p class='searchable'>Syncs users and/or groups from the configured LDAP to user.cfg. NOTE':' Synced groups will have the name 'name-$realm', so make sure those groups do not exist to prevent overwriting.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveAccessDomainsSync [[-PveTicket] <PveTicket>] [-DryRun] [-EnableNew] [-Full] [-Purge] [-Realm] <String> [[-RemoveVanished] <String>] [[-Scope] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-DryRun</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>If set, does not write anything.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-EnableNew</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable newly synced users immediately.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Full</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>DEPRECATED':' use 'remove-vanished' instead. If set, uses the LDAP Directory as source of truth, deleting users or groups not returned from the sync and removing all locally modified properties of synced users. If not set, only syncs information which is present in the synced data, and does not delete or modify anything else.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Purge</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>DEPRECATED':' use 'remove-vanished' instead. Remove ACLs for users or groups which were removed from the config during a sync.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Realm</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Authentication domain ID</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-RemoveVanished</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A semicolon-seperated list of things to remove when they or the user vanishes during a sync. The following values are possible':' 'entry' removes the user/group when not returned from the sync. 'properties' removes the set properties on existing user/group that do not appear in the source (even custom ones). 'acl' removes acls when the user/group is not returned from the sync. Instead of a list it also can be 'none' (the default).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Scope</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Select what to sync. Enum: users,groups,both</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveAccessGroups" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveAccessGroups </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create new group.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveAccessGroups [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-Groupid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Groupid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveAccessOpenidAuthUrl" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveAccessOpenidAuthUrl </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get the OpenId Authorization Url for the specified realm.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveAccessOpenidAuthUrl [[-PveTicket] <PveTicket>] [-Realm] <String> [-RedirectUrl] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Realm</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Authentication domain ID</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-RedirectUrl</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Redirection Url. The client should set this to the used server url (location.origin).</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveAccessOpenidLogin" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveAccessOpenidLogin </h2>
|
|
<p></p>
|
|
<p class='searchable'>Verify OpenID authorization code and create a ticket.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveAccessOpenidLogin [[-PveTicket] <PveTicket>] [-Code] <String> [-RedirectUrl] <String> [-State] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Code</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>OpenId authorization code.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-RedirectUrl</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Redirection Url. The client should set this to the used server url (location.origin).</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-State</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>OpenId state.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveAccessRoles" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveAccessRoles </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create new role.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveAccessRoles [[-PveTicket] <PveTicket>] [[-Privs] <String>] [-Roleid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Privs</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Roleid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveAccessTfa" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveAccessTfa </h2>
|
|
<p></p>
|
|
<p class='searchable'>Add a TFA entry for a user.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveAccessTfa [[-PveTicket] <PveTicket>] [[-Challenge] <String>] [[-Description] <String>] [[-Password] <SecureString>] [[-Totp] <String>] [-Type] <String> [-Userid] <String> [[-Value] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Challenge</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>When responding to a u2f challenge':' the original challenge string</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Description</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A description to distinguish multiple entries from one another</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Password</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The current password.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Totp</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A totp URI.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>TFA Entry Type. Enum: totp,u2f,webauthn,recovery,yubico</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Userid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Full User ID, in the `name@realm` format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Value</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The current value for the provided totp URI, or a Webauthn/U2F challenge response</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveAccessTicket" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveAccessTicket </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create or verify authentication ticket.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveAccessTicket [[-PveTicket] <PveTicket>] [-NewFormat] [[-Otp] <String>] [-Password] <SecureString> [[-Path] <String>] [[-Privs] <String>] [[-Realm] <String>] [[-TfaChallenge] <String>] [-Username] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-NewFormat</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>This parameter is now ignored and assumed to be 1.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Otp</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>One-time password for Two-factor authentication.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Password</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The secret password. This can also be a valid ticket.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Path</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Verify ticket, and check if user have access 'privs' on 'path'</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Privs</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Verify ticket, and check if user have access 'privs' on 'path'</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Realm</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>You can optionally pass the realm using this parameter. Normally the realm is simply added to the username <username>@<relam>.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-TfaChallenge</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The signed TFA challenge string the user wants to respond to.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Username</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>User name</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveAccessUsers" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveAccessUsers </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create new user.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveAccessUsers [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Email] <String>] [-Enable] [[-Expire] <Int32>] [[-Firstname] <String>] [[-Groups] <String>] [[-Keys] <String>] [[-Lastname] <String>] [[-Password] <SecureString>] [-Userid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Email</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Enable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable the account (default). You can set this to '0' to disable the account</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Expire</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Account expiration date (seconds since epoch). '0' means no expiration date.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Firstname</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Groups</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Keys</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Keys for two factor auth (yubico).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Lastname</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Password</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Initial password.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Userid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Full User ID, in the `name@realm` format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveAccessUsersToken" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveAccessUsersToken </h2>
|
|
<p></p>
|
|
<p class='searchable'>Generate a new API token for a specific user. NOTE':' returns API token value, which needs to be stored as it cannot be retrieved afterwards!</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveAccessUsersToken [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Expire] <Int32>] [-Privsep] [-Tokenid] <String> [-Userid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Expire</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>API token expiration date (seconds since epoch). '0' means no expiration date.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Privsep</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tokenid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>User-specific token identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Userid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Full User ID, in the `name@realm` format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterAcmeAccount" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterAcmeAccount </h2>
|
|
<p></p>
|
|
<p class='searchable'>Register a new ACME account with CA.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterAcmeAccount [[-PveTicket] <PveTicket>] [-Contact] <String> [[-Directory] <String>] [[-EabHmacKey] <String>] [[-EabKid] <String>] [[-Name] <String>] [[-TosUrl] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Contact</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Contact email addresses.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Directory</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>URL of ACME CA directory endpoint.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-EabHmacKey</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>HMAC key for External Account Binding.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-EabKid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Key Identifier for External Account Binding.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>ACME account config file name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-TosUrl</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>URL of CA TermsOfService - setting this indicates agreement.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterAcmePlugins" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterAcmePlugins </h2>
|
|
<p></p>
|
|
<p class='searchable'>Add ACME plugin configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterAcmePlugins [[-PveTicket] <PveTicket>] [[-Api] <String>] [[-Data] <String>] [-Disable] [-Id] <String> [[-Nodes] <String>] [-Type] <String> [[-ValidationDelay] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Api</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>API plugin name Enum: 1984hosting,acmedns,acmeproxy,active24,ad,ali,anx,artfiles,arvan,aurora,autodns,aws,azion,azure,bookmyname,bunny,cf,clouddns,cloudns,cn,conoha,constellix,cpanel,curanet,cyon,da,ddnss,desec,df,dgon,dnsexit,dnshome,dnsimple,dnsservices,do,doapi,domeneshop,dp,dpi,dreamhost,duckdns,durabledns,dyn,dynu,dynv6,easydns,edgedns,euserv,exoscale,fornex,freedns,gandi_livedns,gcloud,gcore,gd,geoscaling,googledomains,he,hetzner,hexonet,hostingde,huaweicloud,infoblox,infomaniak,internetbs,inwx,ionos,ipv64,ispconfig,jd,joker,kappernet,kas,kinghost,knot,la,leaseweb,lexicon,linode,linode_v4,loopia,lua,maradns,me,miab,misaka,myapi,mydevil,mydnsjp,mythic_beasts,namecheap,namecom,namesilo,nanelo,nederhost,neodigit,netcup,netlify,nic,njalla,nm,nsd,nsone,nsupdate,nw,oci,one,online,openprovider,openstack,opnsense,ovh,pdns,pleskxml,pointhq,porkbun,rackcorp,rackspace,rage4,rcode0,regru,scaleway,schlundtech,selectel,selfhost,servercow,simply,tele3,tencent,transip,udr,ultra,unoeuro,variomedia,veesp,vercel,vscale,vultr,websupport,world4you,yandex,yc,zilore,zone,zonomi</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Data</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>DNS plugin data. (base64 encoded)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Disable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Flag to disable the config.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>ACME Plugin ID name</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nodes</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of cluster node names.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>ACME challenge type. Enum: dns,standalone</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ValidationDelay</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterBackup" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterBackup </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create new vzdump backup job.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterBackup [[-PveTicket] <PveTicket>] [-All] [[-Bwlimit] <Int32>] [[-Comment] <String>] [[-Compress] <String>] [[-Dow] <String>] [[-Dumpdir] <String>] [-Enabled] [[-Exclude] <String>] [[-ExcludePath] <Array>] [[-Id] <String>] [[-Ionice] <Int32>] [[-Lockwait] <Int32>] [[-Mailnotification] <String>] [[-Mailto] <String>] [[-Maxfiles] <Int32>] [[-Mode] <String>] [[-Node] <String>] [[-NotesTemplate] <String>] [[-NotificationPolicy] <String>] [[-NotificationTarget] <String>] [[-Performance] <String>] [[-Pigz] <Int32>] [[-Pool] <String>] [-Protected] [[-PruneBackups] <String>] [-Quiet] [-Remove] [-RepeatMissed] [[-Schedule] <String>] [[-Script] <String>] [[-Starttime] <String>] [-Stdexcludes] [-Stop] [[-Stopwait] <Int32>] [[-Storage] <String>] [[-Tmpdir] <String>] [[-Vmid] <String>] [[-Zstd] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-All</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Backup all known guest systems on this host.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Bwlimit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Limit I/O bandwidth (in KiB/s).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Description for the Job.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Compress</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Compress dump file. Enum: 0,1,gzip,lzo,zstd</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dow</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Day of week selection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dumpdir</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Store resulting files to specified directory.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Enabled</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable or disable the job.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Exclude</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Exclude specified guest systems (assumes --all)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ExcludePath</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Job ID (will be autogenerated).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ionice</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Lockwait</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Maximal time to wait for the global lock (minutes).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mailnotification</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Deprecated':' use 'notification-policy' instead. Enum: always,failure</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mailto</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Comma-separated list of email addresses or users that should receive email notifications. Has no effect if the 'notification-target' option is set at the same time.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Maxfiles</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Deprecated':' use 'prune-backups' instead. Maximal number of backup files per guest system.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mode</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Backup mode. Enum: snapshot,suspend,stop</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only run if executed on this node.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-NotesTemplate</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-NotificationPolicy</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify when to send a notification Enum: always,failure,never</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-NotificationTarget</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Determine the target to which notifications should be sent. Can either be a notification endpoint or a notification group. This option takes precedence over 'mailto', meaning that if both are set, the 'mailto' option will be ignored.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Performance</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Other performance-related settings.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pigz</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pool</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Backup all known guest systems included in the specified pool.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Protected</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>If true, mark backup(s) as protected.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PruneBackups</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use these retention options instead of those from the storage configuration.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Quiet</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Be quiet.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Remove</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prune older backups according to 'prune-backups'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-RepeatMissed</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>If true, the job will be run as soon as possible if it was missed while the scheduler was not running.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Schedule</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Backup schedule. The format is a subset of `systemd` calendar events.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Script</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use specified hook script.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Starttime</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Job Start time.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Stdexcludes</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Exclude temporary files and logs.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Stop</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Stop running backup jobs on this host.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Stopwait</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Maximal time to wait until a guest system is stopped (minutes).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Store resulting file to this storage.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tmpdir</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Store temporary files to specified directory.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The ID of the guest system you want to backup.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Zstd</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Zstd threads. N=0 uses half of the available cores, N>0 uses N as thread count.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterConfig" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterConfig </h2>
|
|
<p></p>
|
|
<p class='searchable'>Generate new cluster configuration. If no links given, default to local IP address as link0.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterConfig [[-PveTicket] <PveTicket>] [-Clustername] <String> [[-LinkN] <Hashtable>] [[-Nodeid] <Int32>] [[-Votes] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Clustername</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the cluster.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-LinkN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Address and priority information of a single corosync link. (up to 8 links supported; link0..link7)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nodeid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Node id for this node.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Votes</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Number of votes for this node.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterConfigJoin" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterConfigJoin </h2>
|
|
<p></p>
|
|
<p class='searchable'>Joins this node into an existing cluster. If no links are given, default to IP resolved by node's hostname on single link (fallback fails for clusters with multiple links).</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterConfigJoin [[-PveTicket] <PveTicket>] [-Fingerprint] <String> [-Force] [-Hostname] <String> [[-LinkN] <Hashtable>] [[-Nodeid] <Int32>] [-Password] <SecureString> [[-Votes] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Fingerprint</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Certificate SHA 256 fingerprint.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Force</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Do not throw error if node already exists.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Hostname</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Hostname (or IP) of an existing cluster member.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-LinkN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Address and priority information of a single corosync link. (up to 8 links supported; link0..link7)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nodeid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Node id for this node.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Password</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Superuser (root) password of peer node.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Votes</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Number of votes for this node</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterConfigNodes" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterConfigNodes </h2>
|
|
<p></p>
|
|
<p class='searchable'>Adds a node to the cluster configuration. This call is for internal use.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterConfigNodes [[-PveTicket] <PveTicket>] [[-Apiversion] <Int32>] [-Force] [[-LinkN] <Hashtable>] [[-NewNodeIp] <String>] [-Node] <String> [[-Nodeid] <Int32>] [[-Votes] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Apiversion</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The JOIN_API_VERSION of the new node.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Force</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Do not throw error if node already exists.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-LinkN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Address and priority information of a single corosync link. (up to 8 links supported; link0..link7)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-NewNodeIp</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP Address of node to add. Used as fallback if no links are given.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nodeid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Node id for this node.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Votes</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Number of votes for this node</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterFirewallAliases" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterFirewallAliases </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create IP or Network Alias.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [-Name] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cidr</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network/IP specification in CIDR format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Alias name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterFirewallGroups" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterFirewallGroups </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create new security group.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterFirewallGroups [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Digest] <String>] [-Group] <String> [[-Rename] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Group</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Security Group name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Rename</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rename/update an existing security group. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing group.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterFirewallGroupsIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterFirewallGroupsIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create new rule.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterFirewallGroupsIdx [[-PveTicket] <PveTicket>] [-Action] <String> [[-Comment] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [-Group] <String> [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [-Type] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Action</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Descriptive comment.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dport</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Enable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Flag to enable/disable a rule.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Group</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Security Group name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-IcmpType</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Iface</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Log</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Macro</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use predefined standard macro.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pos</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Update rule at position <pos>.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Proto</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Source</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Sport</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rule type. Enum: in,out,group</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterFirewallIpset" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterFirewallIpset </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create new IPSet</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterFirewallIpset [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [[-Rename] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP set name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Rename</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterFirewallIpsetIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterFirewallIpsetIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Add IP or Network to IPSet.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [-Name] <String> [-Nomatch] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cidr</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network/IP specification in CIDR format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP set name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nomatch</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterFirewallRules" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterFirewallRules </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create new rule.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterFirewallRules [[-PveTicket] <PveTicket>] [-Action] <String> [[-Comment] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [-Type] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Action</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Descriptive comment.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dport</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Enable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Flag to enable/disable a rule.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-IcmpType</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Iface</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Log</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Macro</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use predefined standard macro.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pos</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Update rule at position <pos>.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Proto</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Source</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Sport</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rule type. Enum: in,out,group</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterHaGroups" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterHaGroups </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create a new HA group.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterHaGroups [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-Group] <String> [-Nodes] <String> [-Nofailback] [-Restricted] [[-Type] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Description.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Group</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The HA group identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nodes</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of cluster node names with optional priority.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nofailback</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Restricted</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Resources bound to restricted groups may only run on nodes defined by the group.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Group type. Enum: group</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterHaResources" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterHaResources </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create a new HA resource.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterHaResources [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Group] <String>] [[-MaxRelocate] <Int32>] [[-MaxRestart] <Int32>] [-Sid] <String> [[-State] <String>] [[-Type] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Description.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Group</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The HA group identifier.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MaxRelocate</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Maximal number of service relocate tries when a service failes to start.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MaxRestart</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Maximal number of tries to restart the service on a node after its start failed.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Sid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example':' vm':'100 / ct':'100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example':' 100).</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-State</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Requested resource state. Enum: started,stopped,enabled,disabled,ignored</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Resource type. Enum: ct,vm</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterHaResourcesMigrate" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterHaResourcesMigrate </h2>
|
|
<p></p>
|
|
<p class='searchable'>Request resource migration (online) to another node.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterHaResourcesMigrate [[-PveTicket] <PveTicket>] [-Node] <String> [-Sid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Target node.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Sid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example':' vm':'100 / ct':'100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example':' 100).</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterHaResourcesRelocate" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterHaResourcesRelocate </h2>
|
|
<p></p>
|
|
<p class='searchable'>Request resource relocatzion to another node. This stops the service on the old node, and restarts it on the target node.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterHaResourcesRelocate [[-PveTicket] <PveTicket>] [-Node] <String> [-Sid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Target node.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Sid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example':' vm':'100 / ct':'100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example':' 100).</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterJobsRealmSync" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterJobsRealmSync </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create new realm-sync job.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterJobsRealmSync [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-EnableNew] [-Enabled] [-Id] <String> [[-Realm] <String>] [[-RemoveVanished] <String>] [-Schedule] <String> [[-Scope] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Description for the Job.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-EnableNew</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable newly synced users immediately.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Enabled</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Determines if the job is enabled.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The ID of the job.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Realm</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Authentication domain ID</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-RemoveVanished</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A semicolon-seperated list of things to remove when they or the user vanishes during a sync. The following values are possible':' 'entry' removes the user/group when not returned from the sync. 'properties' removes the set properties on existing user/group that do not appear in the source (even custom ones). 'acl' removes acls when the user/group is not returned from the sync. Instead of a list it also can be 'none' (the default).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Schedule</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Backup schedule. The format is a subset of `systemd` calendar events.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Scope</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Select what to sync. Enum: users,groups,both</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterMappingPci" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterMappingPci </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create a new hardware mapping.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterMappingPci [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Id] <String> [-Map] <Array> [-Mdev] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Description</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Description of the logical PCI device.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The ID of the logical PCI mapping.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Map</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of maps for the cluster nodes.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mdev</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterMappingUsb" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterMappingUsb </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create a new hardware mapping.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterMappingUsb [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Id] <String> [-Map] <Array> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Description</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Description of the logical USB device.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The ID of the logical USB mapping.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Map</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of maps for the cluster nodes.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterMetricsServer" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterMetricsServer </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create a new external metric server config</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterMetricsServer [[-PveTicket] <PveTicket>] [[-ApiPathPrefix] <String>] [[-Bucket] <String>] [-Disable] [-Id] <String> [[-Influxdbproto] <String>] [[-MaxBodySize] <Int32>] [[-Mtu] <Int32>] [[-Organization] <String>] [[-Path] <String>] [-Port] <Int32> [[-Proto] <String>] [-Server] <String> [[-Timeout] <Int32>] [[-Token] <String>] [-Type] <String> [-VerifyCertificate] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ApiPathPrefix</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>An API path prefix inserted between '<host>':'<port>/' and '/api2/'. Can be useful if the InfluxDB service runs behind a reverse proxy.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Bucket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The InfluxDB bucket/db. Only necessary when using the http v2 api.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Disable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Flag to disable the plugin.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The ID of the entry.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Influxdbproto</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>-- Enum: udp,http,https</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MaxBodySize</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>InfluxDB max-body-size in bytes. Requests are batched up to this size.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mtu</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>MTU for metrics transmission over UDP</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Organization</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The InfluxDB organization. Only necessary when using the http v2 api. Has no meaning when using v2 compatibility api.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Path</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>root graphite path (ex':' proxmox.mycluster.mykey)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Port</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>server network port</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Proto</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Protocol to send graphite data. TCP or UDP (default) Enum: udp,tcp</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Server</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>server dns name or IP address</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Timeout</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>graphite TCP socket timeout (default=1)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Token</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The InfluxDB access token. Only necessary when using the http v2 api. If the v2 compatibility api is used, use 'user':'password' instead.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Plugin type. Enum: graphite,influxdb</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VerifyCertificate</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set to 0 to disable certificate verification for https endpoints.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterNotificationsEndpointsGotify" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterNotificationsEndpointsGotify </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create a new gotify endpoint</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterNotificationsEndpointsGotify [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-Disable] [-Name] <String> [-Server] <String> [-Token] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Comment</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Disable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Disable this target</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the endpoint.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Server</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Server URL</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Token</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Secret token</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterNotificationsEndpointsSendmail" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterNotificationsEndpointsSendmail </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create a new sendmail endpoint</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterNotificationsEndpointsSendmail [[-PveTicket] <PveTicket>] [[-Author] <String>] [[-Comment] <String>] [-Disable] [[-FromAddress] <String>] [[-Mailto] <Array>] [[-MailtoUser] <Array>] [-Name] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Author</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Author of the mail</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Comment</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Disable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Disable this target</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-FromAddress</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>`From` address for the mail</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mailto</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of email recipients</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MailtoUser</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of users</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the endpoint.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterNotificationsEndpointsSmtp" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterNotificationsEndpointsSmtp </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create a new smtp endpoint</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterNotificationsEndpointsSmtp [[-PveTicket] <PveTicket>] [[-Author] <String>] [[-Comment] <String>] [-Disable] [-FromAddress] <String> [[-Mailto] <Array>] [[-MailtoUser] <Array>] [[-Mode] <String>] [-Name] <String> [[-Password] <SecureString>] [[-Port] <Int32>] [-Server] <String> [[-Username] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Author</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Author of the mail. Defaults to 'Proxmox VE'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Comment</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Disable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Disable this target</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-FromAddress</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>`From` address for the mail</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mailto</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of email recipients</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MailtoUser</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of users</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mode</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Determine which encryption method shall be used for the connection. Enum: insecure,starttls,tls</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the endpoint.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Password</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Password for SMTP authentication</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Port</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The port to be used. Defaults to 465 for TLS based connections, 587 for STARTTLS based connections and port 25 for insecure plain-text connections.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Server</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The address of the SMTP server.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Username</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Username for SMTP authentication</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterNotificationsMatchers" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterNotificationsMatchers </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create a new matcher</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterNotificationsMatchers [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-Disable] [-InvertMatch] [[-MatchCalendar] <Array>] [[-MatchField] <Array>] [[-MatchSeverity] <Array>] [[-Mode] <String>] [-Name] <String> [[-Target] <Array>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Comment</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Disable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Disable this matcher</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-InvertMatch</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Invert match of the whole matcher</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MatchCalendar</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Match notification timestamp</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MatchField</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Metadata fields to match (regex or exact match). Must be in the form (regex|exact)':'<field>=<value></td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MatchSeverity</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Notification severities to match</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mode</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Choose between 'all' and 'any' for when multiple properties are specified Enum: all,any</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Name of the matcher.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Target</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Targets to notify on match</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterReplication" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterReplication </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create a new replication job</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterReplication [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-Disable] [-Id] <String> [[-Rate] <Single>] [[-RemoveJob] <String>] [[-Schedule] <String>] [[-Source] <String>] [-Target] <String> [-Type] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Description.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Disable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Flag to disable/deactivate the entry.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Rate</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rate limit in mbps (megabytes per second) as floating point number.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-RemoveJob</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Mark the replication job for removal. The job will remove all local replication snapshots. When set to 'full', it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file. Enum: local,full</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Schedule</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Storage replication schedule. The format is a subset of `systemd` calendar events.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Source</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>For internal use, to detect if the guest was stolen.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Target</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Target node.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Section type. Enum: local</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterSdnControllers" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterSdnControllers </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create a new sdn controller object.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterSdnControllers [[-PveTicket] <PveTicket>] [[-Asn] <Int32>] [-BgpMultipathAsPathRelax] [-Controller] <String> [-Ebgp] [[-EbgpMultihop] <Int32>] [[-IsisDomain] <String>] [[-IsisIfaces] <String>] [[-IsisNet] <String>] [[-Loopback] <String>] [[-Node] <String>] [[-Peers] <String>] [-Type] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Asn</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>autonomous system number</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-BgpMultipathAsPathRelax</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Controller</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN controller object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ebgp</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable ebgp. (remote-as external)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-EbgpMultihop</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-IsisDomain</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>ISIS domain.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-IsisIfaces</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>ISIS interface.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-IsisNet</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>ISIS network entity title.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Loopback</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>source loopback interface.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Peers</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>peers address list.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Plugin type. Enum: bgp,evpn,faucet,isis</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterSdnDns" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterSdnDns </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create a new sdn dns object.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterSdnDns [[-PveTicket] <PveTicket>] [-Dns] <String> [-Key] <String> [[-Reversemaskv6] <Int32>] [[-Reversev6mask] <Int32>] [[-Ttl] <Int32>] [-Type] <String> [-Url] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dns</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN dns object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Key</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Reversemaskv6</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Reversev6mask</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ttl</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Plugin type. Enum: powerdns</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Url</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterSdnIpams" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterSdnIpams </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create a new sdn ipam object.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterSdnIpams [[-PveTicket] <PveTicket>] [-Ipam] <String> [[-Section] <Int32>] [[-Token] <String>] [-Type] <String> [[-Url] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ipam</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN ipam object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Section</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Token</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Plugin type. Enum: netbox,phpipam,pve</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Url</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterSdnVnets" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterSdnVnets </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create a new sdn vnet object.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterSdnVnets [[-PveTicket] <PveTicket>] [[-Alias] <String>] [[-Tag] <Int32>] [[-Type] <String>] [-Vlanaware] [-Vnet] <String> [-Zone] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Alias</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>alias name of the vnet</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tag</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>vlan or vxlan id</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Type Enum: vnet</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vlanaware</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Allow vm VLANs to pass through this vnet.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vnet</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN vnet object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Zone</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>zone id</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterSdnVnetsIps" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterSdnVnetsIps </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create IP Mapping in a VNet</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterSdnVnetsIps [[-PveTicket] <PveTicket>] [-Ip] <String> [[-Mac] <String>] [-Vnet] <String> [-Zone] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ip</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The IP address to associate with the given MAC address</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mac</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Unicast MAC address.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vnet</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN vnet object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Zone</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN zone object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterSdnVnetsSubnets" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterSdnVnetsSubnets </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create a new sdn subnet object.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterSdnVnetsSubnets [[-PveTicket] <PveTicket>] [[-DhcpDnsServer] <String>] [[-DhcpRange] <Array>] [[-Dnszoneprefix] <String>] [[-Gateway] <String>] [-Snat] [-Subnet] <String> [-Type] <String> [-Vnet] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-DhcpDnsServer</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP address for the DNS server</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-DhcpRange</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of DHCP ranges for this subnet</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dnszoneprefix</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>dns domain zone prefix ex':' 'adm' -> <hostname>.adm.mydomain.com</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Gateway</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Subnet Gateway':' Will be assign on vnet for layer3 zones</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Snat</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>enable masquerade for this subnet if pve-firewall</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Subnet</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN subnet object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>-- Enum: subnet</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vnet</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>associated vnet</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveClusterSdnZones" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveClusterSdnZones </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create a new sdn zone object.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveClusterSdnZones [[-PveTicket] <PveTicket>] [-AdvertiseSubnets] [[-Bridge] <String>] [-BridgeDisableMacLearning] [[-Controller] <String>] [[-Dhcp] <String>] [-DisableArpNdSuppression] [[-Dns] <String>] [[-Dnszone] <String>] [[-DpId] <Int32>] [[-Exitnodes] <String>] [-ExitnodesLocalRouting] [[-ExitnodesPrimary] <String>] [[-Ipam] <String>] [[-Mac] <String>] [[-Mtu] <Int32>] [[-Nodes] <String>] [[-Peers] <String>] [[-Reversedns] <String>] [[-RtImport] <String>] [[-Tag] <Int32>] [-Type] <String> [[-VlanProtocol] <String>] [[-VrfVxlan] <Int32>] [[-VxlanPort] <Int32>] [-Zone] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-AdvertiseSubnets</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Advertise evpn subnets if you have silent hosts</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Bridge</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-BridgeDisableMacLearning</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Disable auto mac learning.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Controller</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Frr router name</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dhcp</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Type of the DHCP backend for this zone Enum: dnsmasq</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-DisableArpNdSuppression</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Disable ipv4 arp && ipv6 neighbour discovery suppression</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dns</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>dns api server</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dnszone</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>dns domain zone ex':' mydomain.com</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-DpId</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Faucet dataplane id</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Exitnodes</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of cluster node names.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ExitnodesLocalRouting</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Allow exitnodes to connect to evpn guests</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ExitnodesPrimary</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Force traffic to this exitnode first.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ipam</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>use a specific ipam</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mac</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Anycast logical router mac address</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mtu</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>MTU</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nodes</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of cluster node names.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Peers</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>peers address list.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Reversedns</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>reverse dns api server</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-RtImport</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Route-Target import</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tag</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Service-VLAN Tag</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Plugin type. Enum: evpn,faucet,qinq,simple,vlan,vxlan</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VlanProtocol</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>-- Enum: 802.1q,802.1ad</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VrfVxlan</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>l3vni.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VxlanPort</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Vxlan tunnel udp port (default 4789).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Zone</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN zone object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesAplinfo" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesAplinfo </h2>
|
|
<p></p>
|
|
<p class='searchable'>Download appliance templates.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesAplinfo [[-PveTicket] <PveTicket>] [-Node] <String> [-Storage] <String> [-Template] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage where the template will be stored</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Template</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The template which will downloaded</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesAptRepositories" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesAptRepositories </h2>
|
|
<p></p>
|
|
<p class='searchable'>Change the properties of a repository. Currently only allows enabling/disabling.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesAptRepositories [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Enabled] [-Index] <Int32> [-Node] <String> [-Path] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Digest to detect modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Enabled</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Whether the repository should be enabled or not.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Index</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Index within the file (starting from 0).</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Path</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Path to the containing file.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesAptUpdate" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesAptUpdate </h2>
|
|
<p></p>
|
|
<p class='searchable'>This is used to resynchronize the package index files from their sources (apt-get update).</p>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-heading'>
|
|
<h3 class='panel-title'> Aliases </h3>
|
|
</div>
|
|
<div class='panel-body'>
|
|
<ul>
|
|
<li class='searchable'>Update-PveNode</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesAptUpdate [[-PveTicket] <PveTicket>] [-Node] <String> [-Notify] [-Quiet] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Notify</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Send notification about new packages.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Quiet</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only produces output suitable for logging, omitting progress indicators.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesCephFs" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesCephFs </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create a Ceph filesystem</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesCephFs [[-PveTicket] <PveTicket>] [-AddStorage] [[-Name] <String>] [-Node] <String> [[-PgNum] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-AddStorage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Configure the created CephFS as storage for this cluster.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The ceph filesystem name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PgNum</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Number of placement groups for the backing data pool. The metadata pool will use a quarter of this.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesCephInit" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesCephInit </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create initial ceph default configuration and setup symlinks.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesCephInit [[-PveTicket] <PveTicket>] [[-ClusterNetwork] <String>] [-DisableCephx] [[-MinSize] <Int32>] [[-Network] <String>] [-Node] <String> [[-PgBits] <Int32>] [[-Size] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ClusterNetwork</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Declare a separate cluster network, OSDs will routeheartbeat, object replication and recovery traffic over it</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-DisableCephx</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Disable cephx authentication.WARNING':' cephx is a security feature protecting against man-in-the-middle attacks. Only consider disabling cephx if your network is private!</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MinSize</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Minimum number of available replicas per object to allow I/O</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Network</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use specific network for all ceph related traffic</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PgBits</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Placement group bits, used to specify the default number of placement groups.Depreacted. This setting was deprecated in recent Ceph versions.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Size</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Targeted number of replicas per object</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesCephMds" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesCephMds </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create Ceph Metadata Server (MDS)</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesCephMds [[-PveTicket] <PveTicket>] [-Hotstandby] [[-Name] <String>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Hotstandby</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Determines whether a ceph-mds daemon should poll and replay the log of an active MDS. Faster switch on MDS failure, but needs more idle resources.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The ID for the mds, when omitted the same as the nodename</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesCephMgr" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesCephMgr </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create Ceph Manager</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesCephMgr [[-PveTicket] <PveTicket>] [[-Id] <String>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The ID for the manager, when omitted the same as the nodename</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesCephMon" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesCephMon </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create Ceph Monitor and Manager</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesCephMon [[-PveTicket] <PveTicket>] [[-MonAddress] <String>] [[-Monid] <String>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MonAddress</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Overwrites autodetected monitor IP address(es). Must be in the public network(s) of Ceph.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Monid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The ID for the monitor, when omitted the same as the nodename</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesCephOsd" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesCephOsd </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create OSD</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesCephOsd [[-PveTicket] <PveTicket>] [[-CrushDeviceClass] <String>] [[-DbDev] <String>] [[-DbDevSize] <Single>] [-Dev] <String> [-Encrypted] [-Node] <String> [[-OsdsPerDevice] <Int32>] [[-WalDev] <String>] [[-WalDevSize] <Single>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-CrushDeviceClass</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set the device class of the OSD in crush.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-DbDev</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Block device name for block.db.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-DbDevSize</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Size in GiB for block.db.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dev</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Block device name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Encrypted</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enables encryption of the OSD.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-OsdsPerDevice</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>OSD services per physical device. Only useful for fast NVMe devices" ." to utilize their performance better.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-WalDev</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Block device name for block.wal.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-WalDevSize</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Size in GiB for block.wal.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesCephOsdIn" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesCephOsdIn </h2>
|
|
<p></p>
|
|
<p class='searchable'>ceph osd in</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesCephOsdIn [[-PveTicket] <PveTicket>] [-Node] <String> [-Osdid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Osdid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>OSD ID</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesCephOsdOut" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesCephOsdOut </h2>
|
|
<p></p>
|
|
<p class='searchable'>ceph osd out</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesCephOsdOut [[-PveTicket] <PveTicket>] [-Node] <String> [-Osdid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Osdid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>OSD ID</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesCephOsdScrub" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesCephOsdScrub </h2>
|
|
<p></p>
|
|
<p class='searchable'>Instruct the OSD to scrub.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesCephOsdScrub [[-PveTicket] <PveTicket>] [-Deep] [-Node] <String> [-Osdid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Deep</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>If set, instructs a deep scrub instead of a normal one.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Osdid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>OSD ID</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesCephPool" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesCephPool </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create Ceph pool</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesCephPool [[-PveTicket] <PveTicket>] [-AddStorages] [[-Application] <String>] [[-CrushRule] <String>] [[-ErasureCoding] <String>] [[-MinSize] <Int32>] [-Name] <String> [-Node] <String> [[-PgAutoscaleMode] <String>] [[-PgNum] <Int32>] [[-PgNumMin] <Int32>] [[-Size] <Int32>] [[-TargetSize] <String>] [[-TargetSizeRatio] <Single>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-AddStorages</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Configure VM and CT storage using the new pool.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Application</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The application of the pool. Enum: rbd,cephfs,rgw</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-CrushRule</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The rule to use for mapping object placement in the cluster.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ErasureCoding</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Create an erasure coded pool for RBD with an accompaning replicated pool for metadata storage. With EC, the common ceph options 'size', 'min_size' and 'crush_rule' parameters will be applied to the metadata pool.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MinSize</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Minimum number of replicas per object</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the pool. It must be unique.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PgAutoscaleMode</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The automatic PG scaling mode of the pool. Enum: on,off,warn</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PgNum</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Number of placement groups.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PgNumMin</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Minimal number of placement groups.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Size</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Number of replicas per object</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-TargetSize</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The estimated target size of the pool for the PG autoscaler.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-TargetSizeRatio</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The estimated target ratio of the pool for the PG autoscaler.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesCephRestart" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesCephRestart </h2>
|
|
<p></p>
|
|
<p class='searchable'>Restart ceph services.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesCephRestart [[-PveTicket] <PveTicket>] [-Node] <String> [[-Service] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Service</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ceph service name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesCephStart" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesCephStart </h2>
|
|
<p></p>
|
|
<p class='searchable'>Start ceph services.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesCephStart [[-PveTicket] <PveTicket>] [-Node] <String> [[-Service] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Service</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ceph service name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesCephStop" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesCephStop </h2>
|
|
<p></p>
|
|
<p class='searchable'>Stop ceph services.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesCephStop [[-PveTicket] <PveTicket>] [-Node] <String> [[-Service] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Service</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ceph service name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesCertificatesAcmeCertificate" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesCertificatesAcmeCertificate </h2>
|
|
<p></p>
|
|
<p class='searchable'>Order a new certificate from ACME-compatible CA.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesCertificatesAcmeCertificate [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Force</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Overwrite existing custom certificate.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesCertificatesCustom" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesCertificatesCustom </h2>
|
|
<p></p>
|
|
<p class='searchable'>Upload or update custom certificate chain and key.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesCertificatesCustom [[-PveTicket] <PveTicket>] [-Certificates] <String> [-Force] [[-Key] <String>] [-Node] <String> [-Restart] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Certificates</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>PEM encoded certificate (chain).</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Force</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Overwrite existing custom or ACME certificate files.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Key</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>PEM encoded private key.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Restart</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restart pveproxy.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesDisksDirectory" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesDisksDirectory </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create a Filesystem on an unused disk. Will be mounted under '/mnt/pve/NAME'.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesDisksDirectory [[-PveTicket] <PveTicket>] [-AddStorage] [-Device] <String> [[-Filesystem] <String>] [-Name] <String> [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-AddStorage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Configure storage using the directory.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Device</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The block device you want to create the filesystem on.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Filesystem</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The desired filesystem. Enum: ext4,xfs</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesDisksInitgpt" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesDisksInitgpt </h2>
|
|
<p></p>
|
|
<p class='searchable'>Initialize Disk with GPT</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesDisksInitgpt [[-PveTicket] <PveTicket>] [-Disk] <String> [-Node] <String> [[-Uuid] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Disk</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Block device name</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Uuid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>UUID for the GPT table</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesDisksLvm" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesDisksLvm </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create an LVM Volume Group</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesDisksLvm [[-PveTicket] <PveTicket>] [-AddStorage] [-Device] <String> [-Name] <String> [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-AddStorage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Configure storage using the Volume Group</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Device</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The block device you want to create the volume group on</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesDisksLvmthin" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesDisksLvmthin </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create an LVM thinpool</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesDisksLvmthin [[-PveTicket] <PveTicket>] [-AddStorage] [-Device] <String> [-Name] <String> [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-AddStorage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Configure storage using the thinpool.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Device</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The block device you want to create the thinpool on.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesDisksZfs" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesDisksZfs </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create a ZFS pool.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesDisksZfs [[-PveTicket] <PveTicket>] [-AddStorage] [[-Ashift] <Int32>] [[-Compression] <String>] [-Devices] <String> [[-DraidConfig] <String>] [-Name] <String> [-Node] <String> [-Raidlevel] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-AddStorage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Configure storage using the zpool.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ashift</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Pool sector size exponent.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Compression</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The compression algorithm to use. Enum: on,off,gzip,lz4,lzjb,zle,zstd</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Devices</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The block devices you want to create the zpool on.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-DraidConfig</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Raidlevel</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The RAID level to use. Enum: single,mirror,raid10,raidz,raidz2,raidz3,draid,draid2,draid3</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesExecute" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesExecute </h2>
|
|
<p></p>
|
|
<p class='searchable'>Execute multiple commands in order, root only.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesExecute [[-PveTicket] <PveTicket>] [-Commands] <String> [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Commands</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>JSON encoded array of commands.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesFirewallRules" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesFirewallRules </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create new rule.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesFirewallRules [[-PveTicket] <PveTicket>] [-Action] <String> [[-Comment] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [-Node] <String> [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [-Type] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Action</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Descriptive comment.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dport</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Enable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Flag to enable/disable a rule.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-IcmpType</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Iface</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Log</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Macro</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use predefined standard macro.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pos</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Update rule at position <pos>.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Proto</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Source</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Sport</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rule type. Enum: in,out,group</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesHosts" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesHosts </h2>
|
|
<p></p>
|
|
<p class='searchable'>Write /etc/hosts.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesHosts [[-PveTicket] <PveTicket>] [-Data] <String> [[-Digest] <String>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Data</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The target content of /etc/hosts.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesLxc" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesLxc </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create or restore a container.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesLxc [[-PveTicket] <PveTicket>] [[-Arch] <String>] [[-Bwlimit] <Single>] [[-Cmode] <String>] [-Console] [[-Cores] <Int32>] [[-Cpulimit] <Single>] [[-Cpuunits] <Int32>] [-Debug_] [[-Description] <String>] [[-DevN] <Hashtable>] [[-Features] <String>] [-Force] [[-Hookscript] <String>] [[-Hostname] <String>] [-IgnoreUnpackErrors] [[-Lock] <String>] [[-Memory] <Int32>] [[-MpN] <Hashtable>] [[-Nameserver] <String>] [[-NetN] <Hashtable>] [-Node] <String> [-Onboot] [-Ostemplate] <String> [[-Ostype] <String>] [[-Password] <SecureString>] [[-Pool] <String>] [-Protection] [-Restore] [[-Rootfs] <String>] [[-Searchdomain] <String>] [[-SshPublicKeys] <String>] [-Start] [[-Startup] <String>] [[-Storage] <String>] [[-Swap] <Int32>] [[-Tags] <String>] [-Template] [[-Timezone] <String>] [[-Tty] <Int32>] [-Unique] [-Unprivileged] [[-UnusedN] <Hashtable>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Arch</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>OS architecture type. Enum: amd64,i386,arm64,armhf,riscv32,riscv64</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Bwlimit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Override I/O bandwidth limit (in KiB/s).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cmode</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login). Enum: shell,console,tty</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Console</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Attach a console device (/dev/console) to the container.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cores</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The number of cores assigned to the container. A container can use all available cores by default.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cpulimit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Limit of CPU usage.NOTE':' If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cpuunits</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>CPU weight for a container, will be clamped to \[1, 10000] in cgroup v2.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Debug_</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Try to be more verbose. For now this only enables debug log-level on start.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Description</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-DevN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Device to pass through to the container</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Features</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Allow containers access to advanced features.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Force</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Allow to overwrite existing container.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Hookscript</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Script that will be exectued during various steps in the containers lifetime.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Hostname</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set a host name for the container.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-IgnoreUnpackErrors</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ignore errors when extracting the template.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Lock</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Lock/unlock the container. Enum: backup,create,destroyed,disk,fstrim,migrate,mounted,rollback,snapshot,snapshot-delete</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Memory</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Amount of RAM for the container in MB.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MpN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use volume as container mount point. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nameserver</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-NetN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specifies network interfaces for the container.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Onboot</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specifies whether a container will be started during system bootup.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ostemplate</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The OS template or backup file.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ostype</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. Enum: debian,devuan,ubuntu,centos,fedora,opensuse,archlinux,alpine,gentoo,nixos,unmanaged</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Password</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Sets root password inside container.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pool</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Add the VM to the specified pool.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Protection</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Restore</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Mark this as restore task.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Rootfs</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use volume as container root.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Searchdomain</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-SshPublicKeys</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Setup public SSH keys (one key per line, OpenSSH format).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Start</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Start the CT after its creation finished successfully.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Startup</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Default Storage.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Swap</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Amount of SWAP for the container in MB.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tags</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Tags of the Container. This is only meta information.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Template</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable Template.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Timezone</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tty</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify the number of tty available to the container</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Unique</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Assign a unique random ethernet address.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Unprivileged</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Makes the container run as unprivileged user. (Should not be modified manually.)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-UnusedN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Reference to unused volumes. This is used internally, and should not be modified manually.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesLxcClone" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesLxcClone </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create a container clone/copy</p>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-heading'>
|
|
<h3 class='panel-title'> Aliases </h3>
|
|
</div>
|
|
<div class='panel-body'>
|
|
<ul>
|
|
<li class='searchable'>Copy-PveLxc</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesLxcClone [[-PveTicket] <PveTicket>] [[-Bwlimit] <Single>] [[-Description] <String>] [-Full] [[-Hostname] <String>] [-Newid] <Int32> [-Node] <String> [[-Pool] <String>] [[-Snapname] <String>] [[-Storage] <String>] [[-Target] <String>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Bwlimit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Override I/O bandwidth limit (in KiB/s).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Description</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Description for the new CT.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Full</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Create a full copy of all disks. This is always done when you clone a normal CT. For CT templates, we try to create a linked clone by default.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Hostname</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set a hostname for the new CT.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Newid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>VMID for the clone.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pool</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Add the new CT to the specified pool.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Snapname</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the snapshot.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Target storage for full clone.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Target</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Target node. Only allowed if the original VM is on shared storage.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesLxcFirewallAliases" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesLxcFirewallAliases </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create IP or Network Alias.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesLxcFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cidr</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network/IP specification in CIDR format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Alias name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesLxcFirewallIpset" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesLxcFirewallIpset </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create new IPSet</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesLxcFirewallIpset [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [[-Rename] <String>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP set name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Rename</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesLxcFirewallIpsetIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesLxcFirewallIpsetIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Add IP or Network to IPSet.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesLxcFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [-Name] <String> [-Node] <String> [-Nomatch] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cidr</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network/IP specification in CIDR format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP set name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nomatch</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesLxcFirewallRules" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesLxcFirewallRules </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create new rule.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesLxcFirewallRules [[-PveTicket] <PveTicket>] [-Action] <String> [[-Comment] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [-Node] <String> [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [-Type] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Action</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Descriptive comment.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dport</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Enable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Flag to enable/disable a rule.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-IcmpType</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Iface</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Log</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Macro</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use predefined standard macro.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pos</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Update rule at position <pos>.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Proto</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Source</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Sport</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rule type. Enum: in,out,group</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesLxcMigrate" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesLxcMigrate </h2>
|
|
<p></p>
|
|
<p class='searchable'>Migrate the container to another node. Creates a new migration task.</p>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-heading'>
|
|
<h3 class='panel-title'> Aliases </h3>
|
|
</div>
|
|
<div class='panel-body'>
|
|
<ul>
|
|
<li class='searchable'>Move-PveLxc</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesLxcMigrate [[-PveTicket] <PveTicket>] [[-Bwlimit] <Single>] [-Node] <String> [-Online] [-Restart] [-Target] <String> [[-TargetStorage] <String>] [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Bwlimit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Override I/O bandwidth limit (in KiB/s).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Online</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use online/live migration.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Restart</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use restart migration</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Target</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Target node.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-TargetStorage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Timeout</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Timeout in seconds for shutdown for restart migration</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesLxcMoveVolume" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesLxcMoveVolume </h2>
|
|
<p></p>
|
|
<p class='searchable'>Move a rootfs-/mp-volume to a different storage or to a different container.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesLxcMoveVolume [[-PveTicket] <PveTicket>] [[-Bwlimit] <Single>] [-Delete] [[-Digest] <String>] [-Node] <String> [[-Storage] <String>] [[-TargetDigest] <String>] [[-TargetVmid] <Int32>] [[-TargetVolume] <String>] [-Vmid] <Int32> [-Volume] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Bwlimit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Override I/O bandwidth limit (in KiB/s).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Delete the original volume after successful copy. By default the original is kept as an unused volume entry.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has different SHA1 " . "digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Target Storage.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-TargetDigest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file of the target " . "container has a different SHA1 digest. This can be used to prevent " . "concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-TargetVmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-TargetVolume</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The config key the volume will be moved to. Default is the source volume key. Enum: rootfs,mp0,mp1,mp2,mp3,mp4,mp5,mp6,mp7,mp8,mp9,mp10,mp11,mp12,mp13,mp14,mp15,mp16,mp17,mp18,mp19,mp20,mp21,mp22,mp23,mp24,mp25,mp26,mp27,mp28,mp29,mp30,mp31,mp32,mp33,mp34,mp35,mp36,mp37,mp38,mp39,mp40,mp41,mp42,mp43,mp44,mp45,mp46,mp47,mp48,mp49,mp50,mp51,mp52,mp53,mp54,mp55,mp56,mp57,mp58,mp59,mp60,mp61,mp62,mp63,mp64,mp65,mp66,mp67,mp68,mp69,mp70,mp71,mp72,mp73,mp74,mp75,mp76,mp77,mp78,mp79,mp80,mp81,mp82,mp83,mp84,mp85,mp86,mp87,mp88,mp89,mp90,mp91,mp92,mp93,mp94,mp95,mp96,mp97,mp98,mp99,mp100,mp101,mp102,mp103,mp104,mp105,mp106,mp107,mp108,mp109,mp110,mp111,mp112,mp113,mp114,mp115,mp116,mp117,mp118,mp119,mp120,mp121,mp122,mp123,mp124,mp125,mp126,mp127,mp128,mp129,mp130,mp131,mp132,mp133,mp134,mp135,mp136,mp137,mp138,mp139,mp140,mp141,mp142,mp143,mp144,mp145,mp146,mp147,mp148,mp149,mp150,mp151,mp152,mp153,mp154,mp155,mp156,mp157,mp158,mp159,mp160,mp161,mp162,mp163,mp164,mp165,mp166,mp167,mp168,mp169,mp170,mp171,mp172,mp173,mp174,mp175,mp176,mp177,mp178,mp179,mp180,mp181,mp182,mp183,mp184,mp185,mp186,mp187,mp188,mp189,mp190,mp191,mp192,mp193,mp194,mp195,mp196,mp197,mp198,mp199,mp200,mp201,mp202,mp203,mp204,mp205,mp206,mp207,mp208,mp209,mp210,mp211,mp212,mp213,mp214,mp215,mp216,mp217,mp218,mp219,mp220,mp221,mp222,mp223,mp224,mp225,mp226,mp227,mp228,mp229,mp230,mp231,mp232,mp233,mp234,mp235,mp236,mp237,mp238,mp239,mp240,mp241,mp242,mp243,mp244,mp245,mp246,mp247,mp248,mp249,mp250,mp251,mp252,mp253,mp254,mp255,unused0,unused1,unused2,unused3,unused4,unused5,unused6,unused7,unused8,unused9,unused10,unused11,unused12,unused13,unused14,unused15,unused16,unused17,unused18,unused19,unused20,unused21,unused22,unused23,unused24,unused25,unused26,unused27,unused28,unused29,unused30,unused31,unused32,unused33,unused34,unused35,unused36,unused37,unused38,unused39,unused40,unused41,unused42,unused43,unused44,unused45,unused46,unused47,unused48,unused49,unused50,unused51,unused52,unused53,unused54,unused55,unused56,unused57,unused58,unused59,unused60,unused61,unused62,unused63,unused64,unused65,unused66,unused67,unused68,unused69,unused70,unused71,unused72,unused73,unused74,unused75,unused76,unused77,unused78,unused79,unused80,unused81,unused82,unused83,unused84,unused85,unused86,unused87,unused88,unused89,unused90,unused91,unused92,unused93,unused94,unused95,unused96,unused97,unused98,unused99,unused100,unused101,unused102,unused103,unused104,unused105,unused106,unused107,unused108,unused109,unused110,unused111,unused112,unused113,unused114,unused115,unused116,unused117,unused118,unused119,unused120,unused121,unused122,unused123,unused124,unused125,unused126,unused127,unused128,unused129,unused130,unused131,unused132,unused133,unused134,unused135,unused136,unused137,unused138,unused139,unused140,unused141,unused142,unused143,unused144,unused145,unused146,unused147,unused148,unused149,unused150,unused151,unused152,unused153,unused154,unused155,unused156,unused157,unused158,unused159,unused160,unused161,unused162,unused163,unused164,unused165,unused166,unused167,unused168,unused169,unused170,unused171,unused172,unused173,unused174,unused175,unused176,unused177,unused178,unused179,unused180,unused181,unused182,unused183,unused184,unused185,unused186,unused187,unused188,unused189,unused190,unused191,unused192,unused193,unused194,unused195,unused196,unused197,unused198,unused199,unused200,unused201,unused202,unused203,unused204,unused205,unused206,unused207,unused208,unused209,unused210,unused211,unused212,unused213,unused214,unused215,unused216,unused217,unused218,unused219,unused220,unused221,unused222,unused223,unused224,unused225,unused226,unused227,unused228,unused229,unused230,unused231,unused232,unused233,unused234,unused235,unused236,unused237,unused238,unused239,unused240,unused241,unused242,unused243,unused244,unused245,unused246,unused247,unused248,unused249,unused250,unused251,unused252,unused253,unused254,unused255</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Volume</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Volume which will be moved. Enum: rootfs,mp0,mp1,mp2,mp3,mp4,mp5,mp6,mp7,mp8,mp9,mp10,mp11,mp12,mp13,mp14,mp15,mp16,mp17,mp18,mp19,mp20,mp21,mp22,mp23,mp24,mp25,mp26,mp27,mp28,mp29,mp30,mp31,mp32,mp33,mp34,mp35,mp36,mp37,mp38,mp39,mp40,mp41,mp42,mp43,mp44,mp45,mp46,mp47,mp48,mp49,mp50,mp51,mp52,mp53,mp54,mp55,mp56,mp57,mp58,mp59,mp60,mp61,mp62,mp63,mp64,mp65,mp66,mp67,mp68,mp69,mp70,mp71,mp72,mp73,mp74,mp75,mp76,mp77,mp78,mp79,mp80,mp81,mp82,mp83,mp84,mp85,mp86,mp87,mp88,mp89,mp90,mp91,mp92,mp93,mp94,mp95,mp96,mp97,mp98,mp99,mp100,mp101,mp102,mp103,mp104,mp105,mp106,mp107,mp108,mp109,mp110,mp111,mp112,mp113,mp114,mp115,mp116,mp117,mp118,mp119,mp120,mp121,mp122,mp123,mp124,mp125,mp126,mp127,mp128,mp129,mp130,mp131,mp132,mp133,mp134,mp135,mp136,mp137,mp138,mp139,mp140,mp141,mp142,mp143,mp144,mp145,mp146,mp147,mp148,mp149,mp150,mp151,mp152,mp153,mp154,mp155,mp156,mp157,mp158,mp159,mp160,mp161,mp162,mp163,mp164,mp165,mp166,mp167,mp168,mp169,mp170,mp171,mp172,mp173,mp174,mp175,mp176,mp177,mp178,mp179,mp180,mp181,mp182,mp183,mp184,mp185,mp186,mp187,mp188,mp189,mp190,mp191,mp192,mp193,mp194,mp195,mp196,mp197,mp198,mp199,mp200,mp201,mp202,mp203,mp204,mp205,mp206,mp207,mp208,mp209,mp210,mp211,mp212,mp213,mp214,mp215,mp216,mp217,mp218,mp219,mp220,mp221,mp222,mp223,mp224,mp225,mp226,mp227,mp228,mp229,mp230,mp231,mp232,mp233,mp234,mp235,mp236,mp237,mp238,mp239,mp240,mp241,mp242,mp243,mp244,mp245,mp246,mp247,mp248,mp249,mp250,mp251,mp252,mp253,mp254,mp255,unused0,unused1,unused2,unused3,unused4,unused5,unused6,unused7,unused8,unused9,unused10,unused11,unused12,unused13,unused14,unused15,unused16,unused17,unused18,unused19,unused20,unused21,unused22,unused23,unused24,unused25,unused26,unused27,unused28,unused29,unused30,unused31,unused32,unused33,unused34,unused35,unused36,unused37,unused38,unused39,unused40,unused41,unused42,unused43,unused44,unused45,unused46,unused47,unused48,unused49,unused50,unused51,unused52,unused53,unused54,unused55,unused56,unused57,unused58,unused59,unused60,unused61,unused62,unused63,unused64,unused65,unused66,unused67,unused68,unused69,unused70,unused71,unused72,unused73,unused74,unused75,unused76,unused77,unused78,unused79,unused80,unused81,unused82,unused83,unused84,unused85,unused86,unused87,unused88,unused89,unused90,unused91,unused92,unused93,unused94,unused95,unused96,unused97,unused98,unused99,unused100,unused101,unused102,unused103,unused104,unused105,unused106,unused107,unused108,unused109,unused110,unused111,unused112,unused113,unused114,unused115,unused116,unused117,unused118,unused119,unused120,unused121,unused122,unused123,unused124,unused125,unused126,unused127,unused128,unused129,unused130,unused131,unused132,unused133,unused134,unused135,unused136,unused137,unused138,unused139,unused140,unused141,unused142,unused143,unused144,unused145,unused146,unused147,unused148,unused149,unused150,unused151,unused152,unused153,unused154,unused155,unused156,unused157,unused158,unused159,unused160,unused161,unused162,unused163,unused164,unused165,unused166,unused167,unused168,unused169,unused170,unused171,unused172,unused173,unused174,unused175,unused176,unused177,unused178,unused179,unused180,unused181,unused182,unused183,unused184,unused185,unused186,unused187,unused188,unused189,unused190,unused191,unused192,unused193,unused194,unused195,unused196,unused197,unused198,unused199,unused200,unused201,unused202,unused203,unused204,unused205,unused206,unused207,unused208,unused209,unused210,unused211,unused212,unused213,unused214,unused215,unused216,unused217,unused218,unused219,unused220,unused221,unused222,unused223,unused224,unused225,unused226,unused227,unused228,unused229,unused230,unused231,unused232,unused233,unused234,unused235,unused236,unused237,unused238,unused239,unused240,unused241,unused242,unused243,unused244,unused245,unused246,unused247,unused248,unused249,unused250,unused251,unused252,unused253,unused254,unused255</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesLxcMtunnel" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesLxcMtunnel </h2>
|
|
<p></p>
|
|
<p class='searchable'>Migration tunnel endpoint - only for internal use by CT migration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesLxcMtunnel [[-PveTicket] <PveTicket>] [[-Bridges] <String>] [-Node] <String> [[-Storages] <String>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Bridges</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of network bridges to check availability. Will be checked again for actually used bridges during migration.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storages</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of storages to check permission and availability. Will be checked again for all actually used storages during migration.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesLxcRemoteMigrate" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesLxcRemoteMigrate </h2>
|
|
<p></p>
|
|
<p class='searchable'>Migrate the container to another cluster. Creates a new migration task. EXPERIMENTAL feature!</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesLxcRemoteMigrate [[-PveTicket] <PveTicket>] [[-Bwlimit] <Single>] [-Delete] [-Node] <String> [-Online] [-Restart] [-TargetBridge] <String> [-TargetEndpoint] <String> [-TargetStorage] <String> [[-TargetVmid] <Int32>] [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Bwlimit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Override I/O bandwidth limit (in KiB/s).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Delete the original CT and related data after successful migration. By default the original CT is kept on the source cluster in a stopped state.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Online</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use online/live migration.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Restart</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use restart migration</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-TargetBridge</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Mapping from source to target bridges. Providing only a single bridge ID maps all source bridges to that bridge. Providing the special value '1' will map each source bridge to itself.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-TargetEndpoint</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Remote target endpoint</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-TargetStorage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-TargetVmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Timeout</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Timeout in seconds for shutdown for restart migration</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesLxcSnapshot" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesLxcSnapshot </h2>
|
|
<p></p>
|
|
<p class='searchable'>Snapshot a container.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesLxcSnapshot [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Description</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A textual description or comment.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Snapname</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the snapshot.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesLxcSnapshotRollback" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesLxcSnapshotRollback </h2>
|
|
<p></p>
|
|
<p class='searchable'>Rollback LXC state to specified snapshot.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesLxcSnapshotRollback [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Start] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Snapname</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the snapshot.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Start</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Whether the container should get started after rolling back successfully</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesLxcSpiceproxy" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesLxcSpiceproxy </h2>
|
|
<p></p>
|
|
<p class='searchable'>Returns a SPICE configuration to connect to the CT.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesLxcSpiceproxy [[-PveTicket] <PveTicket>] [-Node] <String> [[-Proxy] <String>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Proxy</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesLxcStatusReboot" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesLxcStatusReboot </h2>
|
|
<p></p>
|
|
<p class='searchable'>Reboot the container by shutting it down, and starting it again. Applies pending changes.</p>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-heading'>
|
|
<h3 class='panel-title'> Aliases </h3>
|
|
</div>
|
|
<div class='panel-body'>
|
|
<ul>
|
|
<li class='searchable'>Restart-PveLxc</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesLxcStatusReboot [[-PveTicket] <PveTicket>] [-Node] <String> [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Timeout</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Wait maximal timeout seconds for the shutdown.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesLxcStatusResume" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesLxcStatusResume </h2>
|
|
<p></p>
|
|
<p class='searchable'>Resume the container.</p>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-heading'>
|
|
<h3 class='panel-title'> Aliases </h3>
|
|
</div>
|
|
<div class='panel-body'>
|
|
<ul>
|
|
<li class='searchable'>Resume-PveLxc</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesLxcStatusResume [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesLxcStatusShutdown" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesLxcStatusShutdown </h2>
|
|
<p></p>
|
|
<p class='searchable'>Shutdown the container. This will trigger a clean shutdown of the container, see lxc-stop(1) for details.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesLxcStatusShutdown [[-PveTicket] <PveTicket>] [-Forcestop] [-Node] <String> [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Forcestop</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Make sure the Container stops.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Timeout</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Wait maximal timeout seconds.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesLxcStatusStart" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesLxcStatusStart </h2>
|
|
<p></p>
|
|
<p class='searchable'>Start the container.</p>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-heading'>
|
|
<h3 class='panel-title'> Aliases </h3>
|
|
</div>
|
|
<div class='panel-body'>
|
|
<ul>
|
|
<li class='searchable'>Start-PveLxc</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesLxcStatusStart [[-PveTicket] <PveTicket>] [-Debug_] [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Debug_</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>If set, enables very verbose debug log-level on start.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Skiplock</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ignore locks - only root is allowed to use this option.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesLxcStatusStop" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesLxcStatusStop </h2>
|
|
<p></p>
|
|
<p class='searchable'>Stop the container. This will abruptly stop all processes running in the container.</p>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-heading'>
|
|
<h3 class='panel-title'> Aliases </h3>
|
|
</div>
|
|
<div class='panel-body'>
|
|
<ul>
|
|
<li class='searchable'>Stop-PveLxc</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesLxcStatusStop [[-PveTicket] <PveTicket>] [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Skiplock</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ignore locks - only root is allowed to use this option.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesLxcStatusSuspend" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesLxcStatusSuspend </h2>
|
|
<p></p>
|
|
<p class='searchable'>Suspend the container. This is experimental.</p>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-heading'>
|
|
<h3 class='panel-title'> Aliases </h3>
|
|
</div>
|
|
<div class='panel-body'>
|
|
<ul>
|
|
<li class='searchable'>Suspend-PveLxc</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesLxcStatusSuspend [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesLxcTemplate" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesLxcTemplate </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create a Template.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesLxcTemplate [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesLxcTermproxy" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesLxcTermproxy </h2>
|
|
<p></p>
|
|
<p class='searchable'>Creates a TCP proxy connection.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesLxcTermproxy [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesLxcVncproxy" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesLxcVncproxy </h2>
|
|
<p></p>
|
|
<p class='searchable'>Creates a TCP VNC proxy connections.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesLxcVncproxy [[-PveTicket] <PveTicket>] [[-Height] <Int32>] [-Node] <String> [-Vmid] <Int32> [-Websocket] [[-Width] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Height</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>sets the height of the console in pixels.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Websocket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>use websocket instead of standard VNC.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Width</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>sets the width of the console in pixels.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesMigrateall" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesMigrateall </h2>
|
|
<p></p>
|
|
<p class='searchable'>Migrate all VMs and Containers.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesMigrateall [[-PveTicket] <PveTicket>] [[-Maxworkers] <Int32>] [-Node] <String> [-Target] <String> [[-Vms] <String>] [-WithLocalDisks] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Maxworkers</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Maximal number of parallel migration job. If not set, uses'max_workers' from datacenter.cfg. One of both must be set!</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Target</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Target node.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vms</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only consider Guests with these IDs.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-WithLocalDisks</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable live storage migration for local disk</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesNetwork" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesNetwork </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create network device configuration</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesNetwork [[-PveTicket] <PveTicket>] [[-Address] <String>] [[-Address6] <String>] [-Autostart] [[-BondPrimary] <String>] [[-BondMode] <String>] [[-BondXmitHashPolicy] <String>] [[-BridgePorts] <String>] [-BridgeVlanAware] [[-Cidr] <String>] [[-Cidr6] <String>] [[-Comments] <String>] [[-Comments6] <String>] [[-Gateway] <String>] [[-Gateway6] <String>] [-Iface] <String> [[-Mtu] <Int32>] [[-Netmask] <String>] [[-Netmask6] <Int32>] [-Node] <String> [[-OvsBonds] <String>] [[-OvsBridge] <String>] [[-OvsOptions] <String>] [[-OvsPorts] <String>] [[-OvsTag] <Int32>] [[-Slaves] <String>] [-Type] <String> [[-VlanId] <Int32>] [[-VlanRawDevice] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Address</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP address.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Address6</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP address.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Autostart</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Automatically start interface on boot.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-BondPrimary</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify the primary interface for active-backup bond.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-BondMode</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Bonding mode. Enum: balance-rr,active-backup,balance-xor,broadcast,802.3ad,balance-tlb,balance-alb,balance-slb,lacp-balance-slb,lacp-balance-tcp</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-BondXmitHashPolicy</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes. Enum: layer2,layer2+3,layer3+4</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-BridgePorts</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify the interfaces you want to add to your bridge.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-BridgeVlanAware</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable bridge vlan support.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cidr</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IPv4 CIDR.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cidr6</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IPv6 CIDR.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comments</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Comments</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comments6</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Comments</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Gateway</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Default gateway address.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Gateway6</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Default ipv6 gateway address.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Iface</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network interface name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mtu</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>MTU.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Netmask</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network mask.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Netmask6</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network mask.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-OvsBonds</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify the interfaces used by the bonding device.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-OvsBridge</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The OVS bridge associated with a OVS port. This is required when you create an OVS port.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-OvsOptions</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>OVS interface options.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-OvsPorts</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify the interfaces you want to add to your bridge.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-OvsTag</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Slaves</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify the interfaces used by the bonding device.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network interface type Enum: bridge,bond,eth,alias,vlan,OVSBridge,OVSBond,OVSPort,OVSIntPort,unknown</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VlanId</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>vlan-id for a custom named vlan interface (ifupdown2 only).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VlanRawDevice</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify the raw interface for the vlan interface.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemu" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemu </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create or restore a virtual machine.</p>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-heading'>
|
|
<h3 class='panel-title'> Aliases </h3>
|
|
</div>
|
|
<div class='panel-body'>
|
|
<ul>
|
|
<li class='searchable'>New-PveQemu</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemu [[-PveTicket] <PveTicket>] [-Acpi] [[-Affinity] <String>] [[-Agent] <String>] [[-Arch] <String>] [[-Archive] <String>] [[-Args_] <String>] [[-Audio0] <String>] [-Autostart] [[-Balloon] <Int32>] [[-Bios] <String>] [[-Boot] <String>] [[-Bootdisk] <String>] [[-Bwlimit] <Int32>] [[-Cdrom] <String>] [[-Cicustom] <String>] [[-Cipassword] <SecureString>] [[-Citype] <String>] [-Ciupgrade] [[-Ciuser] <String>] [[-Cores] <Int32>] [[-Cpu] <String>] [[-Cpulimit] <Single>] [[-Cpuunits] <Int32>] [[-Description] <String>] [[-Efidisk0] <String>] [-Force] [-Freeze] [[-Hookscript] <String>] [[-HostpciN] <Hashtable>] [[-Hotplug] <String>] [[-Hugepages] <String>] [[-IdeN] <Hashtable>] [[-IpconfigN] <Hashtable>] [[-Ivshmem] <String>] [-Keephugepages] [[-Keyboard] <String>] [-Kvm] [-LiveRestore] [-Localtime] [[-Lock] <String>] [[-Machine] <String>] [[-Memory] <String>] [[-MigrateDowntime] <Single>] [[-MigrateSpeed] <Int32>] [[-Name] <String>] [[-Nameserver] <String>] [[-NetN] <Hashtable>] [-Node] <String> [-Numa] [[-NumaN] <Hashtable>] [-Onboot] [[-Ostype] <String>] [[-ParallelN] <Hashtable>] [[-Pool] <String>] [-Protection] [-Reboot] [[-Rng0] <String>] [[-SataN] <Hashtable>] [[-ScsiN] <Hashtable>] [[-Scsihw] <String>] [[-Searchdomain] <String>] [[-SerialN] <Hashtable>] [[-Shares] <Int32>] [[-Smbios1] <String>] [[-Smp] <Int32>] [[-Sockets] <Int32>] [[-SpiceEnhancements] <String>] [[-Sshkeys] <String>] [-Start] [[-Startdate] <String>] [[-Startup] <String>] [[-Storage] <String>] [-Tablet] [[-Tags] <String>] [-Tdf] [-Template] [[-Tpmstate0] <String>] [-Unique] [[-UnusedN] <Hashtable>] [[-UsbN] <Hashtable>] [[-Vcpus] <Int32>] [[-Vga] <String>] [[-VirtioN] <Hashtable>] [[-Vmgenid] <String>] [-Vmid] <Int32> [[-Vmstatestorage] <String>] [[-Watchdog] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Acpi</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable ACPI.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Affinity</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of host cores used to execute guest processes, for example':' 0,5,8-11</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Agent</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable communication with the QEMU Guest Agent and its properties.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Arch</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Virtual processor architecture. Defaults to the host. Enum: x86_64,aarch64</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Archive</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The backup archive. Either the file system path to a .tar or .vma file (use '-' to pipe data from stdin) or a proxmox storage backup volume identifier.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Args_</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Arbitrary arguments passed to kvm.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Audio0</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Configure a audio device, useful in combination with QXL/Spice.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Autostart</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Automatic restart after crash (currently ignored).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Balloon</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Amount of target RAM for the VM in MiB. Using zero disables the ballon driver.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Bios</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Select BIOS implementation. Enum: seabios,ovmf</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Boot</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Bootdisk</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable booting from specified disk. Deprecated':' Use 'boot':' order=foo;bar' instead.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Bwlimit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Override I/O bandwidth limit (in KiB/s).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cdrom</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>This is an alias for option -ide2</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cicustom</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>cloud-init':' Specify custom files to replace the automatically generated ones at start.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cipassword</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>cloud-init':' Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Citype</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. Enum: configdrive2,nocloud,opennebula</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ciupgrade</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>cloud-init':' do an automatic package upgrade after the first boot.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ciuser</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>cloud-init':' User name to change ssh keys and password for instead of the image's configured default user.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cores</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The number of cores per socket.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cpu</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Emulated CPU type.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cpulimit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Limit of CPU usage.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cpuunits</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>CPU weight for a VM, will be clamped to \[1, 10000] in cgroup v2.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Description</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Efidisk0</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Configure a disk for storing EFI vars. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Force</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Allow to overwrite existing VM.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Freeze</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Freeze CPU at startup (use 'c' monitor command to start execution).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Hookscript</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Script that will be executed during various steps in the vms lifetime.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-HostpciN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Map host PCI devices into guest.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Hotplug</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Selectively enable hotplug features. This is a comma separated list of hotplug features':' 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Hugepages</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable hugepages memory. Enum: any,2,1024</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-IdeN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-IpconfigN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>cloud-init':' Specify IP addresses and gateways for the corresponding interface.IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicitgateway should be provided.For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requirescloud-init 19.4 or newer.If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to usingdhcp on IPv4.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ivshmem</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Inter-VM shared memory. Useful for direct communication between VMs, or to the host.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Keephugepages</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Keyboard</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. Enum: de,de-ch,da,en-gb,en-us,es,fi,fr,fr-be,fr-ca,fr-ch,hu,is,it,ja,lt,mk,nl,no,pl,pt,pt-br,sv,sl,tr</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Kvm</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable KVM hardware virtualization.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-LiveRestore</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Start the VM immediately from the backup and restore in background. PBS only.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Localtime</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Lock</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Lock/unlock the VM. Enum: backup,clone,create,migrate,rollback,snapshot,snapshot-delete,suspending,suspended</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Machine</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specifies the QEMU machine type.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Memory</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Memory properties.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MigrateDowntime</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set maximum tolerated downtime (in seconds) for migrations.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MigrateSpeed</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set maximum speed (in MB/s) for migrations. Value 0 is no limit.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set a name for the VM. Only used on the configuration web interface.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nameserver</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>cloud-init':' Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-NetN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify network devices.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Numa</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable NUMA.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-NumaN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>NUMA topology.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Onboot</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specifies whether a VM will be started during system bootup.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ostype</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify guest operating system. Enum: other,wxp,w2k,w2k3,w2k8,wvista,win7,win8,win10,win11,l24,l26,solaris</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ParallelN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Map host parallel devices (n is 0 to 2).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pool</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Add the VM to the specified pool.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Protection</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Reboot</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Allow reboot. If set to '0' the VM exit on reboot.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Rng0</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Configure a VirtIO-based Random Number Generator.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-SataN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ScsiN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Scsihw</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>SCSI controller model Enum: lsi,lsi53c810,virtio-scsi-pci,virtio-scsi-single,megasas,pvscsi</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Searchdomain</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>cloud-init':' Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-SerialN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Create a serial device inside the VM (n is 0 to 3)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Shares</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Smbios1</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify SMBIOS type 1 fields.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Smp</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The number of CPUs. Please use option -sockets instead.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Sockets</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The number of CPU sockets.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-SpiceEnhancements</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Configure additional enhancements for SPICE.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Sshkeys</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>cloud-init':' Setup public SSH keys (one key per line, OpenSSH format).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Start</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Start VM after it was created successfully.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Startdate</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set the initial date of the real time clock. Valid format for date are':''now' or '2006-06-17T16':'01':'21' or '2006-06-17'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Startup</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Default storage.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tablet</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable the USB tablet device.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tags</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Tags of the VM. This is only meta information.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tdf</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable time drift fix.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Template</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable Template.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tpmstate0</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Unique</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Assign a unique random ethernet address.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-UnusedN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Reference to unused volumes. This is used internally, and should not be modified manually.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-UsbN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vcpus</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Number of hotplugged vcpus.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vga</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Configure the VGA hardware.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VirtioN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmgenid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmstatestorage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Default storage for VM state volumes/files.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Watchdog</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Create a virtual hardware watchdog device.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuAgent" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuAgent </h2>
|
|
<p></p>
|
|
<p class='searchable'>Execute QEMU Guest Agent commands.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuAgent [[-PveTicket] <PveTicket>] [-Command] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Command</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The QGA command. Enum: fsfreeze-freeze,fsfreeze-status,fsfreeze-thaw,fstrim,get-fsinfo,get-host-name,get-memory-block-info,get-memory-blocks,get-osinfo,get-time,get-timezone,get-users,get-vcpus,info,network-get-interfaces,ping,shutdown,suspend-disk,suspend-hybrid,suspend-ram</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuAgentExec" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuAgentExec </h2>
|
|
<p></p>
|
|
<p class='searchable'>Executes the given command in the vm via the guest-agent and returns an object with the pid.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuAgentExec [[-PveTicket] <PveTicket>] [-Command] <Array> [[-InputData] <String>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Command</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The command as a list of program + arguments.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-InputData</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Data to pass as 'input-data' to the guest. Usually treated as STDIN to 'command'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuAgentFileWrite" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuAgentFileWrite </h2>
|
|
<p></p>
|
|
<p class='searchable'>Writes the given file via guest agent.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuAgentFileWrite [[-PveTicket] <PveTicket>] [-Content] <String> [-Encode] [-File] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Content</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The content to write into the file.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Encode</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>If set, the content will be encoded as base64 (required by QEMU).Otherwise the content needs to be encoded beforehand - defaults to true.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-File</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The path to the file.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuAgentFsfreezeFreeze" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuAgentFsfreezeFreeze </h2>
|
|
<p></p>
|
|
<p class='searchable'>Execute fsfreeze-freeze.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuAgentFsfreezeFreeze [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuAgentFsfreezeStatus" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuAgentFsfreezeStatus </h2>
|
|
<p></p>
|
|
<p class='searchable'>Execute fsfreeze-status.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuAgentFsfreezeStatus [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuAgentFsfreezeThaw" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuAgentFsfreezeThaw </h2>
|
|
<p></p>
|
|
<p class='searchable'>Execute fsfreeze-thaw.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuAgentFsfreezeThaw [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuAgentFstrim" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuAgentFstrim </h2>
|
|
<p></p>
|
|
<p class='searchable'>Execute fstrim.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuAgentFstrim [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuAgentPing" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuAgentPing </h2>
|
|
<p></p>
|
|
<p class='searchable'>Execute ping.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuAgentPing [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuAgentSetUserPassword" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuAgentSetUserPassword </h2>
|
|
<p></p>
|
|
<p class='searchable'>Sets the password for the given user to the given password</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuAgentSetUserPassword [[-PveTicket] <PveTicket>] [-Crypted] [-Node] <String> [-Password] <SecureString> [-Username] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Crypted</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>set to 1 if the password has already been passed through crypt()</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Password</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The new password.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Username</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The user to set the password for.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuAgentShutdown" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuAgentShutdown </h2>
|
|
<p></p>
|
|
<p class='searchable'>Execute shutdown.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuAgentShutdown [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuAgentSuspendDisk" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuAgentSuspendDisk </h2>
|
|
<p></p>
|
|
<p class='searchable'>Execute suspend-disk.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuAgentSuspendDisk [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuAgentSuspendHybrid" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuAgentSuspendHybrid </h2>
|
|
<p></p>
|
|
<p class='searchable'>Execute suspend-hybrid.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuAgentSuspendHybrid [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuAgentSuspendRam" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuAgentSuspendRam </h2>
|
|
<p></p>
|
|
<p class='searchable'>Execute suspend-ram.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuAgentSuspendRam [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuClone" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuClone </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create a copy of virtual machine/template.</p>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-heading'>
|
|
<h3 class='panel-title'> Aliases </h3>
|
|
</div>
|
|
<div class='panel-body'>
|
|
<ul>
|
|
<li class='searchable'>Copy-PveQemu</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuClone [[-PveTicket] <PveTicket>] [[-Bwlimit] <Int32>] [[-Description] <String>] [[-Format] <String>] [-Full] [[-Name] <String>] [-Newid] <Int32> [-Node] <String> [[-Pool] <String>] [[-Snapname] <String>] [[-Storage] <String>] [[-Target] <String>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Bwlimit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Override I/O bandwidth limit (in KiB/s).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Description</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Description for the new VM.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Format</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Target format for file storage. Only valid for full clone. Enum: raw,qcow2,vmdk</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Full</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Create a full copy of all disks. This is always done when you clone a normal VM. For VM templates, we try to create a linked clone by default.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set a name for the new VM.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Newid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>VMID for the clone.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pool</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Add the new VM to the specified pool.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Snapname</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the snapshot.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Target storage for full clone.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Target</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Target node. Only allowed if the original VM is on shared storage.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuConfig" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuConfig </h2>
|
|
<p></p>
|
|
<p class='searchable'>Set virtual machine options (asynchrounous API).</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuConfig [[-PveTicket] <PveTicket>] [-Acpi] [[-Affinity] <String>] [[-Agent] <String>] [[-Arch] <String>] [[-Args_] <String>] [[-Audio0] <String>] [-Autostart] [[-BackgroundDelay] <Int32>] [[-Balloon] <Int32>] [[-Bios] <String>] [[-Boot] <String>] [[-Bootdisk] <String>] [[-Cdrom] <String>] [[-Cicustom] <String>] [[-Cipassword] <SecureString>] [[-Citype] <String>] [-Ciupgrade] [[-Ciuser] <String>] [[-Cores] <Int32>] [[-Cpu] <String>] [[-Cpulimit] <Single>] [[-Cpuunits] <Int32>] [[-Delete] <String>] [[-Description] <String>] [[-Digest] <String>] [[-Efidisk0] <String>] [-Force] [-Freeze] [[-Hookscript] <String>] [[-HostpciN] <Hashtable>] [[-Hotplug] <String>] [[-Hugepages] <String>] [[-IdeN] <Hashtable>] [[-IpconfigN] <Hashtable>] [[-Ivshmem] <String>] [-Keephugepages] [[-Keyboard] <String>] [-Kvm] [-Localtime] [[-Lock] <String>] [[-Machine] <String>] [[-Memory] <String>] [[-MigrateDowntime] <Single>] [[-MigrateSpeed] <Int32>] [[-Name] <String>] [[-Nameserver] <String>] [[-NetN] <Hashtable>] [-Node] <String> [-Numa] [[-NumaN] <Hashtable>] [-Onboot] [[-Ostype] <String>] [[-ParallelN] <Hashtable>] [-Protection] [-Reboot] [[-Revert] <String>] [[-Rng0] <String>] [[-SataN] <Hashtable>] [[-ScsiN] <Hashtable>] [[-Scsihw] <String>] [[-Searchdomain] <String>] [[-SerialN] <Hashtable>] [[-Shares] <Int32>] [-Skiplock] [[-Smbios1] <String>] [[-Smp] <Int32>] [[-Sockets] <Int32>] [[-SpiceEnhancements] <String>] [[-Sshkeys] <String>] [[-Startdate] <String>] [[-Startup] <String>] [-Tablet] [[-Tags] <String>] [-Tdf] [-Template] [[-Tpmstate0] <String>] [[-UnusedN] <Hashtable>] [[-UsbN] <Hashtable>] [[-Vcpus] <Int32>] [[-Vga] <String>] [[-VirtioN] <Hashtable>] [[-Vmgenid] <String>] [-Vmid] <Int32> [[-Vmstatestorage] <String>] [[-Watchdog] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Acpi</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable ACPI.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Affinity</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of host cores used to execute guest processes, for example':' 0,5,8-11</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Agent</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable communication with the QEMU Guest Agent and its properties.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Arch</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Virtual processor architecture. Defaults to the host. Enum: x86_64,aarch64</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Args_</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Arbitrary arguments passed to kvm.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Audio0</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Configure a audio device, useful in combination with QXL/Spice.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Autostart</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Automatic restart after crash (currently ignored).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-BackgroundDelay</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Time to wait for the task to finish. We return 'null' if the task finish within that time.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Balloon</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Amount of target RAM for the VM in MiB. Using zero disables the ballon driver.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Bios</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Select BIOS implementation. Enum: seabios,ovmf</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Boot</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Bootdisk</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable booting from specified disk. Deprecated':' Use 'boot':' order=foo;bar' instead.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cdrom</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>This is an alias for option -ide2</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cicustom</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>cloud-init':' Specify custom files to replace the automatically generated ones at start.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cipassword</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>cloud-init':' Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Citype</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. Enum: configdrive2,nocloud,opennebula</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ciupgrade</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>cloud-init':' do an automatic package upgrade after the first boot.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ciuser</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>cloud-init':' User name to change ssh keys and password for instead of the image's configured default user.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cores</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The number of cores per socket.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cpu</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Emulated CPU type.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cpulimit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Limit of CPU usage.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cpuunits</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>CPU weight for a VM, will be clamped to \[1, 10000] in cgroup v2.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Description</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Efidisk0</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Configure a disk for storing EFI vars. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Force</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused\[n]', which contains the volume ID. Unlink of unused\[n] always cause physical removal.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Freeze</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Freeze CPU at startup (use 'c' monitor command to start execution).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Hookscript</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Script that will be executed during various steps in the vms lifetime.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-HostpciN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Map host PCI devices into guest.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Hotplug</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Selectively enable hotplug features. This is a comma separated list of hotplug features':' 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Hugepages</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable hugepages memory. Enum: any,2,1024</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-IdeN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-IpconfigN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>cloud-init':' Specify IP addresses and gateways for the corresponding interface.IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicitgateway should be provided.For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requirescloud-init 19.4 or newer.If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to usingdhcp on IPv4.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ivshmem</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Inter-VM shared memory. Useful for direct communication between VMs, or to the host.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Keephugepages</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Keyboard</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. Enum: de,de-ch,da,en-gb,en-us,es,fi,fr,fr-be,fr-ca,fr-ch,hu,is,it,ja,lt,mk,nl,no,pl,pt,pt-br,sv,sl,tr</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Kvm</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable KVM hardware virtualization.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Localtime</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Lock</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Lock/unlock the VM. Enum: backup,clone,create,migrate,rollback,snapshot,snapshot-delete,suspending,suspended</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Machine</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specifies the QEMU machine type.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Memory</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Memory properties.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MigrateDowntime</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set maximum tolerated downtime (in seconds) for migrations.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MigrateSpeed</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set maximum speed (in MB/s) for migrations. Value 0 is no limit.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set a name for the VM. Only used on the configuration web interface.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nameserver</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>cloud-init':' Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-NetN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify network devices.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Numa</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable NUMA.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-NumaN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>NUMA topology.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Onboot</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specifies whether a VM will be started during system bootup.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ostype</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify guest operating system. Enum: other,wxp,w2k,w2k3,w2k8,wvista,win7,win8,win10,win11,l24,l26,solaris</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ParallelN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Map host parallel devices (n is 0 to 2).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Protection</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Reboot</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Allow reboot. If set to '0' the VM exit on reboot.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Revert</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Revert a pending change.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Rng0</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Configure a VirtIO-based Random Number Generator.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-SataN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ScsiN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Scsihw</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>SCSI controller model Enum: lsi,lsi53c810,virtio-scsi-pci,virtio-scsi-single,megasas,pvscsi</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Searchdomain</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>cloud-init':' Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-SerialN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Create a serial device inside the VM (n is 0 to 3)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Shares</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Skiplock</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ignore locks - only root is allowed to use this option.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Smbios1</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify SMBIOS type 1 fields.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Smp</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The number of CPUs. Please use option -sockets instead.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Sockets</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The number of CPU sockets.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-SpiceEnhancements</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Configure additional enhancements for SPICE.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Sshkeys</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>cloud-init':' Setup public SSH keys (one key per line, OpenSSH format).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Startdate</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set the initial date of the real time clock. Valid format for date are':''now' or '2006-06-17T16':'01':'21' or '2006-06-17'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Startup</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tablet</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable the USB tablet device.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tags</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Tags of the VM. This is only meta information.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tdf</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable time drift fix.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Template</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable Template.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tpmstate0</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-UnusedN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Reference to unused volumes. This is used internally, and should not be modified manually.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-UsbN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vcpus</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Number of hotplugged vcpus.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vga</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Configure the VGA hardware.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VirtioN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmgenid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmstatestorage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Default storage for VM state volumes/files.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Watchdog</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Create a virtual hardware watchdog device.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuFirewallAliases" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuFirewallAliases </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create IP or Network Alias.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cidr</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network/IP specification in CIDR format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Alias name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuFirewallIpset" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuFirewallIpset </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create new IPSet</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuFirewallIpset [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [[-Rename] <String>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP set name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Rename</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuFirewallIpsetIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuFirewallIpsetIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Add IP or Network to IPSet.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [-Name] <String> [-Node] <String> [-Nomatch] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cidr</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network/IP specification in CIDR format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP set name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nomatch</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuFirewallRules" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuFirewallRules </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create new rule.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuFirewallRules [[-PveTicket] <PveTicket>] [-Action] <String> [[-Comment] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [-Node] <String> [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [-Type] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Action</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Descriptive comment.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dport</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Enable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Flag to enable/disable a rule.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-IcmpType</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Iface</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Log</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Macro</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use predefined standard macro.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pos</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Update rule at position <pos>.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Proto</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Source</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Sport</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rule type. Enum: in,out,group</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuMigrate" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuMigrate </h2>
|
|
<p></p>
|
|
<p class='searchable'>Migrate virtual machine. Creates a new migration task.</p>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-heading'>
|
|
<h3 class='panel-title'> Aliases </h3>
|
|
</div>
|
|
<div class='panel-body'>
|
|
<ul>
|
|
<li class='searchable'>Move-PveQemu</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuMigrate [[-PveTicket] <PveTicket>] [[-Bwlimit] <Int32>] [-Force] [[-MigrationNetwork] <String>] [[-MigrationType] <String>] [-Node] <String> [-Online] [-Target] <String> [[-Targetstorage] <String>] [-Vmid] <Int32> [-WithLocalDisks] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Bwlimit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Override I/O bandwidth limit (in KiB/s).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Force</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Allow to migrate VMs which use local devices. Only root may use this option.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MigrationNetwork</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>CIDR of the (sub) network that is used for migration.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MigrationType</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. Enum: secure,insecure</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Online</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use online/live migration if VM is running. Ignored if VM is stopped.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Target</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Target node.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Targetstorage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-WithLocalDisks</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable live storage migration for local disk</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuMonitor" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuMonitor </h2>
|
|
<p></p>
|
|
<p class='searchable'>Execute QEMU monitor commands.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuMonitor [[-PveTicket] <PveTicket>] [-Command] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Command</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The monitor command.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuMoveDisk" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuMoveDisk </h2>
|
|
<p></p>
|
|
<p class='searchable'>Move volume to different storage or to a different VM.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuMoveDisk [[-PveTicket] <PveTicket>] [[-Bwlimit] <Int32>] [-Delete] [[-Digest] <String>] [-Disk] <String> [[-Format] <String>] [-Node] <String> [[-Storage] <String>] [[-TargetDigest] <String>] [[-TargetDisk] <String>] [[-TargetVmid] <Int32>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Bwlimit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Override I/O bandwidth limit (in KiB/s).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Delete the original disk after successful copy. By default the original disk is kept as unused disk.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has different SHA1" ." digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Disk</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The disk you want to move. Enum: ide0,ide1,ide2,ide3,scsi0,scsi1,scsi2,scsi3,scsi4,scsi5,scsi6,scsi7,scsi8,scsi9,scsi10,scsi11,scsi12,scsi13,scsi14,scsi15,scsi16,scsi17,scsi18,scsi19,scsi20,scsi21,scsi22,scsi23,scsi24,scsi25,scsi26,scsi27,scsi28,scsi29,scsi30,virtio0,virtio1,virtio2,virtio3,virtio4,virtio5,virtio6,virtio7,virtio8,virtio9,virtio10,virtio11,virtio12,virtio13,virtio14,virtio15,sata0,sata1,sata2,sata3,sata4,sata5,efidisk0,tpmstate0,unused0,unused1,unused2,unused3,unused4,unused5,unused6,unused7,unused8,unused9,unused10,unused11,unused12,unused13,unused14,unused15,unused16,unused17,unused18,unused19,unused20,unused21,unused22,unused23,unused24,unused25,unused26,unused27,unused28,unused29,unused30,unused31,unused32,unused33,unused34,unused35,unused36,unused37,unused38,unused39,unused40,unused41,unused42,unused43,unused44,unused45,unused46,unused47,unused48,unused49,unused50,unused51,unused52,unused53,unused54,unused55,unused56,unused57,unused58,unused59,unused60,unused61,unused62,unused63,unused64,unused65,unused66,unused67,unused68,unused69,unused70,unused71,unused72,unused73,unused74,unused75,unused76,unused77,unused78,unused79,unused80,unused81,unused82,unused83,unused84,unused85,unused86,unused87,unused88,unused89,unused90,unused91,unused92,unused93,unused94,unused95,unused96,unused97,unused98,unused99,unused100,unused101,unused102,unused103,unused104,unused105,unused106,unused107,unused108,unused109,unused110,unused111,unused112,unused113,unused114,unused115,unused116,unused117,unused118,unused119,unused120,unused121,unused122,unused123,unused124,unused125,unused126,unused127,unused128,unused129,unused130,unused131,unused132,unused133,unused134,unused135,unused136,unused137,unused138,unused139,unused140,unused141,unused142,unused143,unused144,unused145,unused146,unused147,unused148,unused149,unused150,unused151,unused152,unused153,unused154,unused155,unused156,unused157,unused158,unused159,unused160,unused161,unused162,unused163,unused164,unused165,unused166,unused167,unused168,unused169,unused170,unused171,unused172,unused173,unused174,unused175,unused176,unused177,unused178,unused179,unused180,unused181,unused182,unused183,unused184,unused185,unused186,unused187,unused188,unused189,unused190,unused191,unused192,unused193,unused194,unused195,unused196,unused197,unused198,unused199,unused200,unused201,unused202,unused203,unused204,unused205,unused206,unused207,unused208,unused209,unused210,unused211,unused212,unused213,unused214,unused215,unused216,unused217,unused218,unused219,unused220,unused221,unused222,unused223,unused224,unused225,unused226,unused227,unused228,unused229,unused230,unused231,unused232,unused233,unused234,unused235,unused236,unused237,unused238,unused239,unused240,unused241,unused242,unused243,unused244,unused245,unused246,unused247,unused248,unused249,unused250,unused251,unused252,unused253,unused254,unused255</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Format</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Target Format. Enum: raw,qcow2,vmdk</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Target storage.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-TargetDigest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if the current config file of the target VM has a" ." different SHA1 digest. This can be used to detect concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-TargetDisk</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The config key the disk will be moved to on the target VM (for example, ide0 or scsi1). Default is the source disk key. Enum: ide0,ide1,ide2,ide3,scsi0,scsi1,scsi2,scsi3,scsi4,scsi5,scsi6,scsi7,scsi8,scsi9,scsi10,scsi11,scsi12,scsi13,scsi14,scsi15,scsi16,scsi17,scsi18,scsi19,scsi20,scsi21,scsi22,scsi23,scsi24,scsi25,scsi26,scsi27,scsi28,scsi29,scsi30,virtio0,virtio1,virtio2,virtio3,virtio4,virtio5,virtio6,virtio7,virtio8,virtio9,virtio10,virtio11,virtio12,virtio13,virtio14,virtio15,sata0,sata1,sata2,sata3,sata4,sata5,efidisk0,tpmstate0,unused0,unused1,unused2,unused3,unused4,unused5,unused6,unused7,unused8,unused9,unused10,unused11,unused12,unused13,unused14,unused15,unused16,unused17,unused18,unused19,unused20,unused21,unused22,unused23,unused24,unused25,unused26,unused27,unused28,unused29,unused30,unused31,unused32,unused33,unused34,unused35,unused36,unused37,unused38,unused39,unused40,unused41,unused42,unused43,unused44,unused45,unused46,unused47,unused48,unused49,unused50,unused51,unused52,unused53,unused54,unused55,unused56,unused57,unused58,unused59,unused60,unused61,unused62,unused63,unused64,unused65,unused66,unused67,unused68,unused69,unused70,unused71,unused72,unused73,unused74,unused75,unused76,unused77,unused78,unused79,unused80,unused81,unused82,unused83,unused84,unused85,unused86,unused87,unused88,unused89,unused90,unused91,unused92,unused93,unused94,unused95,unused96,unused97,unused98,unused99,unused100,unused101,unused102,unused103,unused104,unused105,unused106,unused107,unused108,unused109,unused110,unused111,unused112,unused113,unused114,unused115,unused116,unused117,unused118,unused119,unused120,unused121,unused122,unused123,unused124,unused125,unused126,unused127,unused128,unused129,unused130,unused131,unused132,unused133,unused134,unused135,unused136,unused137,unused138,unused139,unused140,unused141,unused142,unused143,unused144,unused145,unused146,unused147,unused148,unused149,unused150,unused151,unused152,unused153,unused154,unused155,unused156,unused157,unused158,unused159,unused160,unused161,unused162,unused163,unused164,unused165,unused166,unused167,unused168,unused169,unused170,unused171,unused172,unused173,unused174,unused175,unused176,unused177,unused178,unused179,unused180,unused181,unused182,unused183,unused184,unused185,unused186,unused187,unused188,unused189,unused190,unused191,unused192,unused193,unused194,unused195,unused196,unused197,unused198,unused199,unused200,unused201,unused202,unused203,unused204,unused205,unused206,unused207,unused208,unused209,unused210,unused211,unused212,unused213,unused214,unused215,unused216,unused217,unused218,unused219,unused220,unused221,unused222,unused223,unused224,unused225,unused226,unused227,unused228,unused229,unused230,unused231,unused232,unused233,unused234,unused235,unused236,unused237,unused238,unused239,unused240,unused241,unused242,unused243,unused244,unused245,unused246,unused247,unused248,unused249,unused250,unused251,unused252,unused253,unused254,unused255</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-TargetVmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuMtunnel" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuMtunnel </h2>
|
|
<p></p>
|
|
<p class='searchable'>Migration tunnel endpoint - only for internal use by VM migration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuMtunnel [[-PveTicket] <PveTicket>] [[-Bridges] <String>] [-Node] <String> [[-Storages] <String>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Bridges</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of network bridges to check availability. Will be checked again for actually used bridges during migration.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storages</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of storages to check permission and availability. Will be checked again for all actually used storages during migration.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuRemoteMigrate" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuRemoteMigrate </h2>
|
|
<p></p>
|
|
<p class='searchable'>Migrate virtual machine to a remote cluster. Creates a new migration task. EXPERIMENTAL feature!</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuRemoteMigrate [[-PveTicket] <PveTicket>] [[-Bwlimit] <Int32>] [-Delete] [-Node] <String> [-Online] [-TargetBridge] <String> [-TargetEndpoint] <String> [-TargetStorage] <String> [[-TargetVmid] <Int32>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Bwlimit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Override I/O bandwidth limit (in KiB/s).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Delete the original VM and related data after successful migration. By default the original VM is kept on the source cluster in a stopped state.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Online</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use online/live migration if VM is running. Ignored if VM is stopped.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-TargetBridge</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Mapping from source to target bridges. Providing only a single bridge ID maps all source bridges to that bridge. Providing the special value '1' will map each source bridge to itself.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-TargetEndpoint</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Remote target endpoint</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-TargetStorage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-TargetVmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuSnapshot" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuSnapshot </h2>
|
|
<p></p>
|
|
<p class='searchable'>Snapshot a VM.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [-Vmstate] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Description</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A textual description or comment.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Snapname</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the snapshot.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmstate</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Save the vmstate</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuSnapshotRollback" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuSnapshotRollback </h2>
|
|
<p></p>
|
|
<p class='searchable'>Rollback VM state to specified snapshot.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuSnapshotRollback [[-PveTicket] <PveTicket>] [-Node] <String> [-Snapname] <String> [-Start] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Snapname</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the snapshot.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Start</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Whether the VM should get started after rolling back successfully. (Note':' VMs will be automatically started if the snapshot includes RAM.)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuSpiceproxy" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuSpiceproxy </h2>
|
|
<p></p>
|
|
<p class='searchable'>Returns a SPICE configuration to connect to the VM.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuSpiceproxy [[-PveTicket] <PveTicket>] [-Node] <String> [[-Proxy] <String>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Proxy</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuStatusReboot" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuStatusReboot </h2>
|
|
<p></p>
|
|
<p class='searchable'>Reboot the VM by shutting it down, and starting it again. Applies pending changes.</p>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-heading'>
|
|
<h3 class='panel-title'> Aliases </h3>
|
|
</div>
|
|
<div class='panel-body'>
|
|
<ul>
|
|
<li class='searchable'>Restart-PveQemu</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuStatusReboot [[-PveTicket] <PveTicket>] [-Node] <String> [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Timeout</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Wait maximal timeout seconds for the shutdown.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuStatusReset" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuStatusReset </h2>
|
|
<p></p>
|
|
<p class='searchable'>Reset virtual machine.</p>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-heading'>
|
|
<h3 class='panel-title'> Aliases </h3>
|
|
</div>
|
|
<div class='panel-body'>
|
|
<ul>
|
|
<li class='searchable'>Reset-PveQemu</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuStatusReset [[-PveTicket] <PveTicket>] [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Skiplock</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ignore locks - only root is allowed to use this option.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuStatusResume" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuStatusResume </h2>
|
|
<p></p>
|
|
<p class='searchable'>Resume virtual machine.</p>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-heading'>
|
|
<h3 class='panel-title'> Aliases </h3>
|
|
</div>
|
|
<div class='panel-body'>
|
|
<ul>
|
|
<li class='searchable'>Resume-PveQemu</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuStatusResume [[-PveTicket] <PveTicket>] [-Nocheck] [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nocheck</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Skiplock</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ignore locks - only root is allowed to use this option.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuStatusShutdown" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuStatusShutdown </h2>
|
|
<p></p>
|
|
<p class='searchable'>Shutdown virtual machine. This is similar to pressing the power button on a physical machine.This will send an ACPI event for the guest OS, which should then proceed to a clean shutdown.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuStatusShutdown [[-PveTicket] <PveTicket>] [-Forcestop] [-Keepactive] [-Node] <String> [-Skiplock] [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Forcestop</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Make sure the VM stops.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Keepactive</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Do not deactivate storage volumes.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Skiplock</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ignore locks - only root is allowed to use this option.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Timeout</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Wait maximal timeout seconds.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuStatusStart" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuStatusStart </h2>
|
|
<p></p>
|
|
<p class='searchable'>Start virtual machine.</p>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-heading'>
|
|
<h3 class='panel-title'> Aliases </h3>
|
|
</div>
|
|
<div class='panel-body'>
|
|
<ul>
|
|
<li class='searchable'>Start-PveQemu</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuStatusStart [[-PveTicket] <PveTicket>] [[-ForceCpu] <String>] [[-Machine] <String>] [[-Migratedfrom] <String>] [[-MigrationNetwork] <String>] [[-MigrationType] <String>] [-Node] <String> [-Skiplock] [[-Stateuri] <String>] [[-Targetstorage] <String>] [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ForceCpu</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Override QEMU's -cpu argument with the given string.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Machine</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specifies the QEMU machine type.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Migratedfrom</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MigrationNetwork</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>CIDR of the (sub) network that is used for migration.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MigrationType</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. Enum: secure,insecure</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Skiplock</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ignore locks - only root is allowed to use this option.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Stateuri</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Some command save/restore state from this location.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Targetstorage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Timeout</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Wait maximal timeout seconds.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuStatusStop" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuStatusStop </h2>
|
|
<p></p>
|
|
<p class='searchable'>Stop virtual machine. The qemu process will exit immediately. Thisis akin to pulling the power plug of a running computer and may damage the VM data</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuStatusStop [[-PveTicket] <PveTicket>] [-Keepactive] [[-Migratedfrom] <String>] [-Node] <String> [-Skiplock] [[-Timeout] <Int32>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Keepactive</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Do not deactivate storage volumes.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Migratedfrom</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Skiplock</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ignore locks - only root is allowed to use this option.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Timeout</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Wait maximal timeout seconds.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuStatusSuspend" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuStatusSuspend </h2>
|
|
<p></p>
|
|
<p class='searchable'>Suspend virtual machine.</p>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-heading'>
|
|
<h3 class='panel-title'> Aliases </h3>
|
|
</div>
|
|
<div class='panel-body'>
|
|
<ul>
|
|
<li class='searchable'>Suspend-PveQemu</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuStatusSuspend [[-PveTicket] <PveTicket>] [-Node] <String> [-Skiplock] [[-Statestorage] <String>] [-Todisk] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Skiplock</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ignore locks - only root is allowed to use this option.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Statestorage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage for the VM state</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Todisk</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>If set, suspends the VM to disk. Will be resumed on next VM start.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuTemplate" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuTemplate </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create a Template.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuTemplate [[-PveTicket] <PveTicket>] [[-Disk] <String>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Disk</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>If you want to convert only 1 disk to base image. Enum: ide0,ide1,ide2,ide3,scsi0,scsi1,scsi2,scsi3,scsi4,scsi5,scsi6,scsi7,scsi8,scsi9,scsi10,scsi11,scsi12,scsi13,scsi14,scsi15,scsi16,scsi17,scsi18,scsi19,scsi20,scsi21,scsi22,scsi23,scsi24,scsi25,scsi26,scsi27,scsi28,scsi29,scsi30,virtio0,virtio1,virtio2,virtio3,virtio4,virtio5,virtio6,virtio7,virtio8,virtio9,virtio10,virtio11,virtio12,virtio13,virtio14,virtio15,sata0,sata1,sata2,sata3,sata4,sata5,efidisk0,tpmstate0</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuTermproxy" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuTermproxy </h2>
|
|
<p></p>
|
|
<p class='searchable'>Creates a TCP proxy connections.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuTermproxy [[-PveTicket] <PveTicket>] [-Node] <String> [[-Serial] <String>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Serial</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>opens a serial terminal (defaults to display) Enum: serial0,serial1,serial2,serial3</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesQemuVncproxy" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesQemuVncproxy </h2>
|
|
<p></p>
|
|
<p class='searchable'>Creates a TCP VNC proxy connections.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesQemuVncproxy [[-PveTicket] <PveTicket>] [-GeneratePassword] [-Node] <String> [-Vmid] <Int32> [-Websocket] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-GeneratePassword</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Generates a random password to be used as ticket instead of the API ticket.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Websocket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prepare for websocket upgrade (only required when using serial terminal, otherwise upgrade is always possible).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesReplicationScheduleNow" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesReplicationScheduleNow </h2>
|
|
<p></p>
|
|
<p class='searchable'>Schedule replication job to start as soon as possible.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesReplicationScheduleNow [[-PveTicket] <PveTicket>] [-Id] <String> [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesServicesReload" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesServicesReload </h2>
|
|
<p></p>
|
|
<p class='searchable'>Reload service. Falls back to restart if service cannot be reloaded.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesServicesReload [[-PveTicket] <PveTicket>] [-Node] <String> [-Service] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Service</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Service ID Enum: chrony,corosync,cron,ksmtuned,postfix,pve-cluster,pve-firewall,pve-ha-crm,pve-ha-lrm,pvedaemon,pvefw-logger,pveproxy,pvescheduler,pvestatd,spiceproxy,sshd,syslog,systemd-journald,systemd-timesyncd</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesServicesRestart" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesServicesRestart </h2>
|
|
<p></p>
|
|
<p class='searchable'>Hard restart service. Use reload if you want to reduce interruptions.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesServicesRestart [[-PveTicket] <PveTicket>] [-Node] <String> [-Service] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Service</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Service ID Enum: chrony,corosync,cron,ksmtuned,postfix,pve-cluster,pve-firewall,pve-ha-crm,pve-ha-lrm,pvedaemon,pvefw-logger,pveproxy,pvescheduler,pvestatd,spiceproxy,sshd,syslog,systemd-journald,systemd-timesyncd</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesServicesStart" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesServicesStart </h2>
|
|
<p></p>
|
|
<p class='searchable'>Start service.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesServicesStart [[-PveTicket] <PveTicket>] [-Node] <String> [-Service] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Service</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Service ID Enum: chrony,corosync,cron,ksmtuned,postfix,pve-cluster,pve-firewall,pve-ha-crm,pve-ha-lrm,pvedaemon,pvefw-logger,pveproxy,pvescheduler,pvestatd,spiceproxy,sshd,syslog,systemd-journald,systemd-timesyncd</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesServicesStop" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesServicesStop </h2>
|
|
<p></p>
|
|
<p class='searchable'>Stop service.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesServicesStop [[-PveTicket] <PveTicket>] [-Node] <String> [-Service] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Service</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Service ID Enum: chrony,corosync,cron,ksmtuned,postfix,pve-cluster,pve-firewall,pve-ha-crm,pve-ha-lrm,pvedaemon,pvefw-logger,pveproxy,pvescheduler,pvestatd,spiceproxy,sshd,syslog,systemd-journald,systemd-timesyncd</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesSpiceshell" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesSpiceshell </h2>
|
|
<p></p>
|
|
<p class='searchable'>Creates a SPICE shell.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesSpiceshell [[-PveTicket] <PveTicket>] [[-Cmd] <String>] [[-CmdOpts] <String>] [-Node] <String> [[-Proxy] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cmd</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Run specific command or default to login (requires 'root@pam') Enum: ceph_install,login,upgrade</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-CmdOpts</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Add parameters to a command. Encoded as null terminated strings.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Proxy</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesStartall" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesStartall </h2>
|
|
<p></p>
|
|
<p class='searchable'>Start all VMs and containers located on this node (by default only those with onboot=1).</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesStartall [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [[-Vms] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Force</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Issue start command even if virtual guest have 'onboot' not set or set to off.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vms</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only consider guests from this comma separated list of VMIDs.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesStatus" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesStatus </h2>
|
|
<p></p>
|
|
<p class='searchable'>Reboot or shutdown a node.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesStatus [[-PveTicket] <PveTicket>] [-Command] <String> [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Command</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify the command. Enum: reboot,shutdown</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesStopall" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesStopall </h2>
|
|
<p></p>
|
|
<p class='searchable'>Stop all VMs and Containers.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesStopall [[-PveTicket] <PveTicket>] [-ForceStop] [-Node] <String> [[-Timeout] <Int32>] [[-Vms] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ForceStop</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Force a hard-stop after the timeout.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Timeout</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Timeout for each guest shutdown task. Depending on `force-stop`, the shutdown gets then simply aborted or a hard-stop is forced.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vms</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only consider Guests with these IDs.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesStorageContent" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesStorageContent </h2>
|
|
<p></p>
|
|
<p class='searchable'>Allocate disk images.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesStorageContent [[-PveTicket] <PveTicket>] [-Filename] <String> [[-Format] <String>] [-Node] <String> [-Size] <String> [-Storage] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Filename</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the file to create.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Format</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>-- Enum: raw,qcow2,subvol</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Size</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M)</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify owner VM</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesStorageContentIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesStorageContentIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Copy a volume. This is experimental code - do not use.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesStorageContentIdx [[-PveTicket] <PveTicket>] [-Node] <String> [[-Storage] <String>] [-Target] <String> [[-TargetNode] <String>] [-Volume] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Target</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Target volume identifier</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-TargetNode</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Target node. Default is local node.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Volume</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Source volume identifier</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesStorageDownloadUrl" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesStorageDownloadUrl </h2>
|
|
<p></p>
|
|
<p class='searchable'>Download templates and ISO images by using an URL.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesStorageDownloadUrl [[-PveTicket] <PveTicket>] [[-Checksum] <String>] [[-ChecksumAlgorithm] <String>] [[-Compression] <String>] [-Content] <String> [-Filename] <String> [-Node] <String> [-Storage] <String> [-Url] <String> [-VerifyCertificates] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Checksum</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The expected checksum of the file.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ChecksumAlgorithm</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The algorithm to calculate the checksum of the file. Enum: md5,sha1,sha224,sha256,sha384,sha512</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Compression</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Decompress the downloaded file using the specified compression algorithm.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Content</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Content type. Enum: iso,vztmpl</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Filename</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the file to create. Caution':' This will be normalized!</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Url</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The URL to download the file from.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VerifyCertificates</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>If false, no SSL/TLS certificates will be verified.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesStorageUpload" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesStorageUpload </h2>
|
|
<p></p>
|
|
<p class='searchable'>Upload templates and ISO images.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesStorageUpload [[-PveTicket] <PveTicket>] [[-Checksum] <String>] [[-ChecksumAlgorithm] <String>] [-Content] <String> [-Filename] <String> [-Node] <String> [-Storage] <String> [[-Tmpfilename] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Checksum</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The expected checksum of the file.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ChecksumAlgorithm</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The algorithm to calculate the checksum of the file. Enum: md5,sha1,sha224,sha256,sha384,sha512</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Content</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Content type. Enum: iso,vztmpl</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Filename</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the file to create. Caution':' This will be normalized!</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tmpfilename</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The source file name. This parameter is usually set by the REST handler. You can only overwrite it when connecting to the trusted port on localhost.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesSubscription" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesSubscription </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update subscription info.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesSubscription [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Force</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Always connect to server, even if local cache is still valid.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesSuspendall" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesSuspendall </h2>
|
|
<p></p>
|
|
<p class='searchable'>Suspend all VMs.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesSuspendall [[-PveTicket] <PveTicket>] [-Node] <String> [[-Vms] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vms</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only consider Guests with these IDs.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesTermproxy" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesTermproxy </h2>
|
|
<p></p>
|
|
<p class='searchable'>Creates a VNC Shell proxy.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesTermproxy [[-PveTicket] <PveTicket>] [[-Cmd] <String>] [[-CmdOpts] <String>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cmd</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Run specific command or default to login (requires 'root@pam') Enum: ceph_install,login,upgrade</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-CmdOpts</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Add parameters to a command. Encoded as null terminated strings.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesVncshell" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesVncshell </h2>
|
|
<p></p>
|
|
<p class='searchable'>Creates a VNC Shell proxy.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesVncshell [[-PveTicket] <PveTicket>] [[-Cmd] <String>] [[-CmdOpts] <String>] [[-Height] <Int32>] [-Node] <String> [-Websocket] [[-Width] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cmd</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Run specific command or default to login (requires 'root@pam') Enum: ceph_install,login,upgrade</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-CmdOpts</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Add parameters to a command. Encoded as null terminated strings.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Height</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>sets the height of the console in pixels.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Websocket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>use websocket instead of standard vnc.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Width</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>sets the width of the console in pixels.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesVzdump" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesVzdump </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create backup.</p>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-heading'>
|
|
<h3 class='panel-title'> Aliases </h3>
|
|
</div>
|
|
<div class='panel-body'>
|
|
<ul>
|
|
<li class='searchable'>Backup-PveVzdump</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesVzdump [[-PveTicket] <PveTicket>] [-All] [[-Bwlimit] <Int32>] [[-Compress] <String>] [[-Dumpdir] <String>] [[-Exclude] <String>] [[-ExcludePath] <Array>] [[-Ionice] <Int32>] [[-Lockwait] <Int32>] [[-Mailnotification] <String>] [[-Mailto] <String>] [[-Maxfiles] <Int32>] [[-Mode] <String>] [[-Node] <String>] [[-NotesTemplate] <String>] [[-NotificationPolicy] <String>] [[-NotificationTarget] <String>] [[-Performance] <String>] [[-Pigz] <Int32>] [[-Pool] <String>] [-Protected] [[-PruneBackups] <String>] [-Quiet] [-Remove] [[-Script] <String>] [-Stdexcludes] [-Stdout] [-Stop] [[-Stopwait] <Int32>] [[-Storage] <String>] [[-Tmpdir] <String>] [[-Vmid] <String>] [[-Zstd] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-All</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Backup all known guest systems on this host.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Bwlimit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Limit I/O bandwidth (in KiB/s).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Compress</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Compress dump file. Enum: 0,1,gzip,lzo,zstd</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dumpdir</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Store resulting files to specified directory.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Exclude</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Exclude specified guest systems (assumes --all)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ExcludePath</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ionice</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Lockwait</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Maximal time to wait for the global lock (minutes).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mailnotification</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Deprecated':' use 'notification-policy' instead. Enum: always,failure</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mailto</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Comma-separated list of email addresses or users that should receive email notifications. Has no effect if the 'notification-target' option is set at the same time.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Maxfiles</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Deprecated':' use 'prune-backups' instead. Maximal number of backup files per guest system.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mode</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Backup mode. Enum: snapshot,suspend,stop</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only run if executed on this node.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-NotesTemplate</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-NotificationPolicy</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify when to send a notification Enum: always,failure,never</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-NotificationTarget</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Determine the target to which notifications should be sent. Can either be a notification endpoint or a notification group. This option takes precedence over 'mailto', meaning that if both are set, the 'mailto' option will be ignored.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Performance</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Other performance-related settings.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pigz</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pool</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Backup all known guest systems included in the specified pool.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Protected</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>If true, mark backup(s) as protected.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PruneBackups</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use these retention options instead of those from the storage configuration.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Quiet</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Be quiet.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Remove</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prune older backups according to 'prune-backups'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Script</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use specified hook script.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Stdexcludes</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Exclude temporary files and logs.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Stdout</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Write tar to stdout, not to a file.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Stop</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Stop running backup jobs on this host.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Stopwait</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Maximal time to wait until a guest system is stopped (minutes).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Store resulting file to this storage.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tmpdir</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Store temporary files to specified directory.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The ID of the guest system you want to backup.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Zstd</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Zstd threads. N=0 uses half of the available cores, N>0 uses N as thread count.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveNodesWakeonlan" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveNodesWakeonlan </h2>
|
|
<p></p>
|
|
<p class='searchable'>Try to wake a node via 'wake on LAN' network packet.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveNodesWakeonlan [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>target node for wake on LAN packet</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PvePools" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PvePools </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create new pool.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PvePools [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-Poolid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Poolid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveStorage" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveStorage </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create a new storage.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveStorage [[-PveTicket] <PveTicket>] [[-Authsupported] <String>] [[-Base] <String>] [[-Blocksize] <String>] [[-Bwlimit] <String>] [[-ComstarHg] <String>] [[-ComstarTg] <String>] [[-Content] <String>] [[-ContentDirs] <String>] [-CreateBasePath] [-CreateSubdirs] [[-DataPool] <String>] [[-Datastore] <String>] [-Disable] [[-Domain] <String>] [[-EncryptionKey] <String>] [[-Export] <String>] [[-Fingerprint] <String>] [[-Format] <String>] [[-FsName] <String>] [-Fuse] [[-IsMountpoint] <String>] [[-Iscsiprovider] <String>] [[-Keyring] <String>] [-Krbd] [[-LioTpg] <String>] [[-MasterPubkey] <String>] [[-MaxProtectedBackups] <Int32>] [[-Maxfiles] <Int32>] [-Mkdir] [[-Monhost] <String>] [[-Mountpoint] <String>] [[-Namespace] <String>] [-Nocow] [[-Nodes] <String>] [-Nowritecache] [[-Options] <String>] [[-Password] <SecureString>] [[-Path] <String>] [[-Pool] <String>] [[-Port] <Int32>] [[-Portal] <String>] [[-Preallocation] <String>] [[-PruneBackups] <String>] [-Saferemove] [[-SaferemoveThroughput] <String>] [[-Server] <String>] [[-Server2] <String>] [[-Share] <String>] [-Shared] [[-Smbversion] <String>] [-Sparse] [-Storage] <String> [[-Subdir] <String>] [-TaggedOnly] [[-Target] <String>] [[-Thinpool] <String>] [[-Transport] <String>] [-Type] <String> [[-Username] <String>] [[-Vgname] <String>] [[-Volume] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Authsupported</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Authsupported.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Base</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Base volume. This volume is automatically activated.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Blocksize</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>block size</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Bwlimit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set I/O bandwidth limit for various operations (in KiB/s).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ComstarHg</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>host group for comstar views</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ComstarTg</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>target group for comstar views</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Content</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Allowed content types.NOTE':' the value 'rootdir' is used for Containers, and value 'images' for VMs.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ContentDirs</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Overrides for default content type directories.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-CreateBasePath</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Create the base directory if it doesn't exist.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-CreateSubdirs</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Populate the directory with the default structure.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-DataPool</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Data Pool (for erasure coding only)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Datastore</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Proxmox Backup Server datastore name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Disable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Flag to disable the storage.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Domain</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>CIFS domain.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-EncryptionKey</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Encryption key. Use 'autogen' to generate one automatically without passphrase.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Export</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>NFS export path.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Fingerprint</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Certificate SHA 256 fingerprint.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Format</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Default image format.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-FsName</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The Ceph filesystem name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Fuse</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Mount CephFS through FUSE.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-IsMountpoint</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Iscsiprovider</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>iscsi provider</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Keyring</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Client keyring contents (for external clusters).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Krbd</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Always access rbd through krbd kernel module.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-LioTpg</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>target portal group for Linux LIO targets</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MasterPubkey</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MaxProtectedBackups</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Maximal number of protected backups per guest. Use '-1' for unlimited.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Maxfiles</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Deprecated':' use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mkdir</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Create the directory if it doesn't exist and populate it with default sub-dirs. NOTE':' Deprecated, use the 'create-base-path' and 'create-subdirs' options instead.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Monhost</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP addresses of monitors (for external clusters).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mountpoint</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>mount point</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Namespace</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Namespace.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nocow</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set the NOCOW flag on files. Disables data checksumming and causes data errors to be unrecoverable from while allowing direct I/O. Only use this if data does not need to be any more safe than on a single ext4 formatted disk with no underlying raid system.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nodes</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of cluster node names.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nowritecache</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>disable write caching on the target</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Options</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs')</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Password</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Password for accessing the share/datastore.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Path</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>File system path.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pool</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Pool.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Port</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>For non default port.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Portal</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>iSCSI portal (IP or DNS name with optional port).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Preallocation</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off. Enum: off,metadata,falloc,full</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PruneBackups</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Saferemove</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Zero-out data when removing LVs.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-SaferemoveThroughput</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Wipe throughput (cstream -t parameter value).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Server</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Server IP or DNS name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Server2</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Backup volfile server IP or DNS name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Share</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>CIFS share.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Shared</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Mark storage as shared.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Smbversion</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>SMB protocol version. 'default' if not set, negotiates the highest SMB2+ version supported by both the client and server. Enum: default,2.0,2.1,3,3.0,3.11</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Sparse</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>use sparse volumes</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Subdir</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Subdir to mount.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-TaggedOnly</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only use logical volumes tagged with 'pve-vm-ID'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Target</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>iSCSI target.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Thinpool</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>LVM thin pool LV name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Transport</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Gluster transport':' tcp or rdma Enum: tcp,rdma,unix</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Storage type. Enum: btrfs,cephfs,cifs,dir,glusterfs,iscsi,iscsidirect,lvm,lvmthin,nfs,pbs,rbd,zfs,zfspool</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Username</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>RBD Id.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vgname</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Volume group name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Volume</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Glusterfs Volume.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="New-PveVmSnapshot" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> New-PveVmSnapshot </h2>
|
|
<p></p>
|
|
<p class='searchable'>Create snapshot VM.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>New-PveVmSnapshot [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [[-Description] <String>] [-Snapname] <String> [-Vmstate] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VmIdOrName</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID or Name of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Description</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A textual description or comment.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Snapname</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the snapshot.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmstate</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Save the vmstate</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveAccessDomains" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveAccessDomains </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete an authentication server.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveAccessDomains [[-PveTicket] <PveTicket>] [-Realm] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Realm</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Authentication domain ID</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveAccessGroups" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveAccessGroups </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete group.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveAccessGroups [[-PveTicket] <PveTicket>] [-Groupid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Groupid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveAccessRoles" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveAccessRoles </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete role.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveAccessRoles [[-PveTicket] <PveTicket>] [-Roleid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Roleid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveAccessTfa" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveAccessTfa </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete a TFA entry by ID.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveAccessTfa [[-PveTicket] <PveTicket>] [-Id] <String> [[-Password] <SecureString>] [-Userid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A TFA entry id.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Password</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The current password.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Userid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Full User ID, in the `name@realm` format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveAccessUsers" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveAccessUsers </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete user.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveAccessUsers [[-PveTicket] <PveTicket>] [-Userid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Userid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Full User ID, in the `name@realm` format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveAccessUsersToken" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveAccessUsersToken </h2>
|
|
<p></p>
|
|
<p class='searchable'>Remove API token for a specific user.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveAccessUsersToken [[-PveTicket] <PveTicket>] [-Tokenid] <String> [-Userid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tokenid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>User-specific token identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Userid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Full User ID, in the `name@realm` format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveClusterAcmeAccount" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveClusterAcmeAccount </h2>
|
|
<p></p>
|
|
<p class='searchable'>Deactivate existing ACME account at CA.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveClusterAcmeAccount [[-PveTicket] <PveTicket>] [[-Name] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>ACME account config file name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveClusterAcmePlugins" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveClusterAcmePlugins </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete ACME plugin configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveClusterAcmePlugins [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Unique identifier for ACME plugin instance.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveClusterBackup" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveClusterBackup </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete vzdump backup job definition.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveClusterBackup [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The job ID.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveClusterConfigNodes" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveClusterConfigNodes </h2>
|
|
<p></p>
|
|
<p class='searchable'>Removes a node from the cluster configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveClusterConfigNodes [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveClusterFirewallAliases" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveClusterFirewallAliases </h2>
|
|
<p></p>
|
|
<p class='searchable'>Remove IP or Network alias.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveClusterFirewallAliases [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Name] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Alias name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveClusterFirewallGroups" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveClusterFirewallGroups </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete security group.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveClusterFirewallGroups [[-PveTicket] <PveTicket>] [-Group] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Group</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Security Group name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveClusterFirewallGroupsIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveClusterFirewallGroupsIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete rule.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveClusterFirewallGroupsIdx [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Group] <String> [[-Pos] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Group</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Security Group name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pos</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Update rule at position <pos>.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveClusterFirewallIpset" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveClusterFirewallIpset </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete IPSet</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveClusterFirewallIpset [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Force</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Delete all members of the IPSet, if there are any.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP set name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveClusterFirewallIpsetIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveClusterFirewallIpsetIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Remove IP or Network from IPSet.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveClusterFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Digest] <String>] [-Name] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cidr</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network/IP specification in CIDR format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP set name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveClusterFirewallRules" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveClusterFirewallRules </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete rule.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveClusterFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [[-Pos] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pos</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Update rule at position <pos>.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveClusterHaGroups" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveClusterHaGroups </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete ha group configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveClusterHaGroups [[-PveTicket] <PveTicket>] [-Group] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Group</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The HA group identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveClusterHaResources" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveClusterHaResources </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete resource configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveClusterHaResources [[-PveTicket] <PveTicket>] [-Sid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Sid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example':' vm':'100 / ct':'100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example':' 100).</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveClusterJobsRealmSync" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveClusterJobsRealmSync </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete realm-sync job definition.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveClusterJobsRealmSync [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveClusterMappingPci" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveClusterMappingPci </h2>
|
|
<p></p>
|
|
<p class='searchable'>Remove Hardware Mapping.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveClusterMappingPci [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveClusterMappingUsb" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveClusterMappingUsb </h2>
|
|
<p></p>
|
|
<p class='searchable'>Remove Hardware Mapping.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveClusterMappingUsb [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveClusterMetricsServer" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveClusterMetricsServer </h2>
|
|
<p></p>
|
|
<p class='searchable'>Remove Metric server.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveClusterMetricsServer [[-PveTicket] <PveTicket>] [-Id] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveClusterNotificationsEndpointsGotify" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveClusterNotificationsEndpointsGotify </h2>
|
|
<p></p>
|
|
<p class='searchable'>Remove gotify endpoint</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveClusterNotificationsEndpointsGotify [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveClusterNotificationsEndpointsSendmail" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveClusterNotificationsEndpointsSendmail </h2>
|
|
<p></p>
|
|
<p class='searchable'>Remove sendmail endpoint</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveClusterNotificationsEndpointsSendmail [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveClusterNotificationsEndpointsSmtp" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveClusterNotificationsEndpointsSmtp </h2>
|
|
<p></p>
|
|
<p class='searchable'>Remove smtp endpoint</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveClusterNotificationsEndpointsSmtp [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveClusterNotificationsMatchers" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveClusterNotificationsMatchers </h2>
|
|
<p></p>
|
|
<p class='searchable'>Remove matcher</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveClusterNotificationsMatchers [[-PveTicket] <PveTicket>] [-Name] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveClusterReplication" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveClusterReplication </h2>
|
|
<p></p>
|
|
<p class='searchable'>Mark replication job for removal.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveClusterReplication [[-PveTicket] <PveTicket>] [-Force] [-Id] <String> [-Keep] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Force</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Will remove the jobconfig entry, but will not cleanup.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Keep</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Keep replicated data at target (do not remove).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveClusterSdnControllers" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveClusterSdnControllers </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete sdn controller object configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveClusterSdnControllers [[-PveTicket] <PveTicket>] [-Controller] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Controller</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN controller object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveClusterSdnDns" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveClusterSdnDns </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete sdn dns object configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveClusterSdnDns [[-PveTicket] <PveTicket>] [-Dns] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dns</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN dns object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveClusterSdnIpams" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveClusterSdnIpams </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete sdn ipam object configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveClusterSdnIpams [[-PveTicket] <PveTicket>] [-Ipam] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ipam</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN ipam object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveClusterSdnVnets" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveClusterSdnVnets </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete sdn vnet object configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveClusterSdnVnets [[-PveTicket] <PveTicket>] [-Vnet] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vnet</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN vnet object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveClusterSdnVnetsIps" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveClusterSdnVnetsIps </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete IP Mappings in a VNet</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveClusterSdnVnetsIps [[-PveTicket] <PveTicket>] [-Ip] <String> [[-Mac] <String>] [-Vnet] <String> [-Zone] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ip</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The IP address to delete</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mac</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Unicast MAC address.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vnet</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN vnet object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Zone</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN zone object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveClusterSdnVnetsSubnets" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveClusterSdnVnetsSubnets </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete sdn subnet object configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveClusterSdnVnetsSubnets [[-PveTicket] <PveTicket>] [-Subnet] <String> [-Vnet] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Subnet</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN subnet object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vnet</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN vnet object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveClusterSdnZones" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveClusterSdnZones </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete sdn zone object configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveClusterSdnZones [[-PveTicket] <PveTicket>] [-Zone] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Zone</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN zone object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesCephMds" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesCephMds </h2>
|
|
<p></p>
|
|
<p class='searchable'>Destroy Ceph Metadata Server</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesCephMds [[-PveTicket] <PveTicket>] [-Name] <String> [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name (ID) of the mds</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesCephMgr" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesCephMgr </h2>
|
|
<p></p>
|
|
<p class='searchable'>Destroy Ceph Manager.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesCephMgr [[-PveTicket] <PveTicket>] [-Id] <String> [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The ID of the manager</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesCephMon" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesCephMon </h2>
|
|
<p></p>
|
|
<p class='searchable'>Destroy Ceph Monitor and Manager.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesCephMon [[-PveTicket] <PveTicket>] [-Monid] <String> [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Monid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Monitor ID</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesCephOsd" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesCephOsd </h2>
|
|
<p></p>
|
|
<p class='searchable'>Destroy OSD</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesCephOsd [[-PveTicket] <PveTicket>] [-Cleanup] [-Node] <String> [-Osdid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cleanup</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>If set, we remove partition table entries.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Osdid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>OSD ID</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesCephPool" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesCephPool </h2>
|
|
<p></p>
|
|
<p class='searchable'>Destroy pool</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesCephPool [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [-Node] <String> [-RemoveEcprofile] [-RemoveStorages] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Force</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>If true, destroys pool even if in use</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the pool. It must be unique.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-RemoveEcprofile</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Remove the erasure code profile. Defaults to true, if applicable.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-RemoveStorages</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Remove all pveceph-managed storages configured for this pool</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesCertificatesAcmeCertificate" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesCertificatesAcmeCertificate </h2>
|
|
<p></p>
|
|
<p class='searchable'>Revoke existing certificate from CA.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesCertificatesAcmeCertificate [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesCertificatesCustom" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesCertificatesCustom </h2>
|
|
<p></p>
|
|
<p class='searchable'>DELETE custom certificate chain and key.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesCertificatesCustom [[-PveTicket] <PveTicket>] [-Node] <String> [-Restart] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Restart</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restart pveproxy.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesDisksDirectory" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesDisksDirectory </h2>
|
|
<p></p>
|
|
<p class='searchable'>Unmounts the storage and removes the mount unit.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesDisksDirectory [[-PveTicket] <PveTicket>] [-CleanupConfig] [-CleanupDisks] [-Name] <String> [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-CleanupConfig</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-CleanupDisks</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Also wipe disk so it can be repurposed afterwards.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesDisksLvm" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesDisksLvm </h2>
|
|
<p></p>
|
|
<p class='searchable'>Remove an LVM Volume Group.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesDisksLvm [[-PveTicket] <PveTicket>] [-CleanupConfig] [-CleanupDisks] [-Name] <String> [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-CleanupConfig</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-CleanupDisks</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Also wipe disks so they can be repurposed afterwards.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesDisksLvmthin" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesDisksLvmthin </h2>
|
|
<p></p>
|
|
<p class='searchable'>Remove an LVM thin pool.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesDisksLvmthin [[-PveTicket] <PveTicket>] [-CleanupConfig] [-CleanupDisks] [-Name] <String> [-Node] <String> [-VolumeGroup] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-CleanupConfig</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-CleanupDisks</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Also wipe disks so they can be repurposed afterwards.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VolumeGroup</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesDisksZfs" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesDisksZfs </h2>
|
|
<p></p>
|
|
<p class='searchable'>Destroy a ZFS pool.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesDisksZfs [[-PveTicket] <PveTicket>] [-CleanupConfig] [-CleanupDisks] [-Name] <String> [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-CleanupConfig</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-CleanupDisks</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Also wipe disks so they can be repurposed afterwards.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesFirewallRules" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesFirewallRules </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete rule.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Node] <String> [[-Pos] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pos</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Update rule at position <pos>.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesLxc" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesLxc </h2>
|
|
<p></p>
|
|
<p class='searchable'>Destroy the container (also delete all uses files).</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesLxc [[-PveTicket] <PveTicket>] [-DestroyUnreferencedDisks] [-Force] [-Node] <String> [-Purge] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-DestroyUnreferencedDisks</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>If set, destroy additionally all disks with the VMID from all enabled storages which are not referenced in the config.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Force</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Force destroy, even if running.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Purge</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Remove container from all related configurations. For example, backup jobs, replication jobs or HA. Related ACLs and Firewall entries will *always* be removed.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesLxcFirewallAliases" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesLxcFirewallAliases </h2>
|
|
<p></p>
|
|
<p class='searchable'>Remove IP or Network alias.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesLxcFirewallAliases [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Alias name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesLxcFirewallIpset" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesLxcFirewallIpset </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete IPSet</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesLxcFirewallIpset [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Force</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Delete all members of the IPSet, if there are any.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP set name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesLxcFirewallIpsetIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesLxcFirewallIpsetIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Remove IP or Network from IPSet.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesLxcFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cidr</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network/IP specification in CIDR format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP set name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesLxcFirewallRules" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesLxcFirewallRules </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete rule.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesLxcFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Node] <String> [[-Pos] <Int32>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pos</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Update rule at position <pos>.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesLxcSnapshot" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesLxcSnapshot </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete a LXC snapshot.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesLxcSnapshot [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Force</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>For removal from config file, even if removing disk snapshots fails.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Snapname</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the snapshot.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesNetwork" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesNetwork </h2>
|
|
<p></p>
|
|
<p class='searchable'>Revert network configuration changes.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesNetwork [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesNetworkIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesNetworkIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete network device configuration</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesNetworkIdx [[-PveTicket] <PveTicket>] [-Iface] <String> [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Iface</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network interface name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesQemu" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesQemu </h2>
|
|
<p></p>
|
|
<p class='searchable'>Destroy the VM and all used/owned volumes. Removes any VM specific permissions and firewall rules</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesQemu [[-PveTicket] <PveTicket>] [-DestroyUnreferencedDisks] [-Node] <String> [-Purge] [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-DestroyUnreferencedDisks</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>If set, destroy additionally all disks not referenced in the config but with a matching VMID from all enabled storages.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Purge</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Remove VMID from configurations, like backup & replication jobs and HA.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Skiplock</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ignore locks - only root is allowed to use this option.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesQemuFirewallAliases" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesQemuFirewallAliases </h2>
|
|
<p></p>
|
|
<p class='searchable'>Remove IP or Network alias.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesQemuFirewallAliases [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Alias name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesQemuFirewallIpset" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesQemuFirewallIpset </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete IPSet</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesQemuFirewallIpset [[-PveTicket] <PveTicket>] [-Force] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Force</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Delete all members of the IPSet, if there are any.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP set name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesQemuFirewallIpsetIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesQemuFirewallIpsetIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Remove IP or Network from IPSet.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesQemuFirewallIpsetIdx [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cidr</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network/IP specification in CIDR format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP set name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesQemuFirewallRules" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesQemuFirewallRules </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete rule.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesQemuFirewallRules [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Node] <String> [[-Pos] <Int32>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pos</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Update rule at position <pos>.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesQemuSnapshot" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesQemuSnapshot </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete a VM snapshot.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesQemuSnapshot [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Force</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>For removal from config file, even if removing disk snapshots fails.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Snapname</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the snapshot.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesStorageContent" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesStorageContent </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete volume</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesStorageContent [[-PveTicket] <PveTicket>] [[-Delay] <Int32>] [-Node] <String> [[-Storage] <String>] [-Volume] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delay</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Time to wait for the task to finish. We return 'null' if the task finish within that time.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Volume</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Volume identifier</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesStoragePrunebackups" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesStoragePrunebackups </h2>
|
|
<p></p>
|
|
<p class='searchable'>Prune backups. Only those using the standard naming scheme are considered.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesStoragePrunebackups [[-PveTicket] <PveTicket>] [-Node] <String> [[-PruneBackups] <String>] [-Storage] <String> [[-Type] <String>] [[-Vmid] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PruneBackups</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use these retention options instead of those from the storage configuration.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Either 'qemu' or 'lxc'. Only consider backups for guests of this type. Enum: qemu,lxc</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only prune backups for this VM.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesSubscription" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesSubscription </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete subscription key of this node.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesSubscription [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveNodesTasks" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveNodesTasks </h2>
|
|
<p></p>
|
|
<p class='searchable'>Stop a task.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveNodesTasks [[-PveTicket] <PveTicket>] [-Node] <String> [-Upid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Upid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PvePools" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PvePools </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete pool.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PvePools [[-PveTicket] <PveTicket>] [-Poolid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Poolid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PvePoolsIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PvePoolsIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete pool (deprecated, no support for nested pools, use 'DELETE /pools/?poolid={poolid}').</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PvePoolsIdx [[-PveTicket] <PveTicket>] [-Poolid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Poolid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveStorage" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveStorage </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete storage configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveStorage [[-PveTicket] <PveTicket>] [-Storage] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Remove-PveVmSnapshot" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Remove-PveVmSnapshot </h2>
|
|
<p></p>
|
|
<p class='searchable'>Delete a VM snapshot.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Remove-PveVmSnapshot [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [-Snapname] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VmIdOrName</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID or Name of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Snapname</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the snapshot.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Reset-PveVm" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Reset-PveVm </h2>
|
|
<p></p>
|
|
<p class='searchable'>Reset VM.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Reset-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VmIdOrName</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID or Name of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Resume-PveVm" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Resume-PveVm </h2>
|
|
<p></p>
|
|
<p class='searchable'>Resume VM.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Resume-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VmIdOrName</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID or Name of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveAccessAcl" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveAccessAcl </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update Access Control List (add or remove permissions).</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveAccessAcl [[-PveTicket] <PveTicket>] [-Delete] [[-Groups] <String>] [-Path] <String> [-Propagate] [-Roles] <String> [[-Tokens] <String>] [[-Users] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Remove permissions (instead of adding it).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Groups</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of groups.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Path</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Access control path</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Propagate</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Allow to propagate (inherit) permissions.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Roles</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of roles.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tokens</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of API tokens.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Users</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of users.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveAccessDomains" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveAccessDomains </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update authentication server settings.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveAccessDomains [[-PveTicket] <PveTicket>] [[-AcrValues] <String>] [-Autocreate] [[-BaseDn] <String>] [[-BindDn] <String>] [[-Capath] <String>] [-CaseSensitive] [[-Cert] <String>] [[-Certkey] <String>] [-CheckConnection] [[-ClientId] <String>] [[-ClientKey] <String>] [[-Comment] <String>] [-Default] [[-Delete] <String>] [[-Digest] <String>] [[-Domain] <String>] [[-Filter] <String>] [[-GroupClasses] <String>] [[-GroupDn] <String>] [[-GroupFilter] <String>] [[-GroupNameAttr] <String>] [[-IssuerUrl] <String>] [[-Mode] <String>] [[-Password] <SecureString>] [[-Port] <Int32>] [[-Prompt] <String>] [-Realm] <String> [[-Scopes] <String>] [-Secure] [[-Server1] <String>] [[-Server2] <String>] [[-Sslversion] <String>] [[-SyncDefaultsOptions] <String>] [[-SyncAttributes] <String>] [[-Tfa] <String>] [[-UserAttr] <String>] [[-UserClasses] <String>] [-Verify] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-AcrValues</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Autocreate</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Automatically create users if they do not exist.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-BaseDn</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>LDAP base domain name</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-BindDn</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>LDAP bind domain name</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Capath</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Path to the CA certificate store</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-CaseSensitive</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>username is case-sensitive</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cert</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Path to the client certificate</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Certkey</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Path to the client certificate key</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-CheckConnection</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Check bind connection to the server.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ClientId</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>OpenID Client ID</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ClientKey</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>OpenID Client Key</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Description.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Default</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use this as default realm</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Domain</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>AD domain name</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Filter</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>LDAP filter for user sync.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-GroupClasses</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The objectclasses for groups.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-GroupDn</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>LDAP base domain name for group sync. If not set, the base_dn will be used.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-GroupFilter</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>LDAP filter for group sync.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-GroupNameAttr</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>LDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-IssuerUrl</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>OpenID Issuer Url</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mode</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>LDAP protocol mode. Enum: ldap,ldaps,ldap+starttls</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Password</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>LDAP bind password. Will be stored in '/etc/pve/priv/realm/<REALM>.pw'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Port</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Server port.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Prompt</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specifies whether the Authorization Server prompts the End-User for reauthentication and consent.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Realm</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Authentication domain ID</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Scopes</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Secure</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use secure LDAPS protocol. DEPRECATED':' use 'mode' instead.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Server1</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Server IP address (or DNS name)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Server2</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Fallback Server IP address (or DNS name)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Sslversion</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>LDAPS TLS/SSL version. It's not recommended to use version older than 1.2! Enum: tlsv1,tlsv1_1,tlsv1_2,tlsv1_3</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-SyncDefaultsOptions</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The default options for behavior of synchronizations.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-SyncAttributes</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Comma separated list of key=value pairs for specifying which LDAP attributes map to which PVE user field. For example, to map the LDAP attribute 'mail' to PVEs 'email', write 'email=mail'. By default, each PVE user field is represented by an LDAP attribute of the same name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tfa</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use Two-factor authentication.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-UserAttr</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>LDAP user attribute name</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-UserClasses</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The objectclasses for users.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Verify</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Verify the server's SSL certificate</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveAccessGroups" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveAccessGroups </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update group data.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveAccessGroups [[-PveTicket] <PveTicket>] [[-Comment] <String>] [-Groupid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Groupid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveAccessPassword" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveAccessPassword </h2>
|
|
<p></p>
|
|
<p class='searchable'>Change user password.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveAccessPassword [[-PveTicket] <PveTicket>] [-Password] <SecureString> [-Userid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Password</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The new password.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Userid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Full User ID, in the `name@realm` format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveAccessRoles" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveAccessRoles </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update an existing role.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveAccessRoles [[-PveTicket] <PveTicket>] [-Append] [[-Privs] <String>] [-Roleid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Append</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Privs</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Roleid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveAccessTfa" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveAccessTfa </h2>
|
|
<p></p>
|
|
<p class='searchable'>Add a TFA entry for a user.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveAccessTfa [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Enable] [-Id] <String> [[-Password] <SecureString>] [-Userid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Description</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A description to distinguish multiple entries from one another</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Enable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Whether the entry should be enabled for login.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A TFA entry id.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Password</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The current password.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Userid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Full User ID, in the `name@realm` format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveAccessUsers" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveAccessUsers </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update user configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveAccessUsers [[-PveTicket] <PveTicket>] [-Append] [[-Comment] <String>] [[-Email] <String>] [-Enable] [[-Expire] <Int32>] [[-Firstname] <String>] [[-Groups] <String>] [[-Keys] <String>] [[-Lastname] <String>] [-Userid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Append</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Email</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Enable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable the account (default). You can set this to '0' to disable the account</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Expire</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Account expiration date (seconds since epoch). '0' means no expiration date.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Firstname</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Groups</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Keys</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Keys for two factor auth (yubico).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Lastname</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Userid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Full User ID, in the `name@realm` format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveAccessUsersToken" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveAccessUsersToken </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update API token for a specific user.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveAccessUsersToken [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Expire] <Int32>] [-Privsep] [-Tokenid] <String> [-Userid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Expire</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>API token expiration date (seconds since epoch). '0' means no expiration date.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Privsep</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tokenid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>User-specific token identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Userid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Full User ID, in the `name@realm` format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveAccessUsersUnlockTfa" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveAccessUsersUnlockTfa </h2>
|
|
<p></p>
|
|
<p class='searchable'>Unlock a user's TFA authentication.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveAccessUsersUnlockTfa [[-PveTicket] <PveTicket>] [-Userid] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Userid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Full User ID, in the `name@realm` format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterAcmeAccount" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterAcmeAccount </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update existing ACME account information with CA. Note':' not specifying any new account information triggers a refresh.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterAcmeAccount [[-PveTicket] <PveTicket>] [[-Contact] <String>] [[-Name] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Contact</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Contact email addresses.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>ACME account config file name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterAcmePlugins" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterAcmePlugins </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update ACME plugin configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterAcmePlugins [[-PveTicket] <PveTicket>] [[-Api] <String>] [[-Data] <String>] [[-Delete] <String>] [[-Digest] <String>] [-Disable] [-Id] <String> [[-Nodes] <String>] [[-ValidationDelay] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Api</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>API plugin name Enum: 1984hosting,acmedns,acmeproxy,active24,ad,ali,anx,artfiles,arvan,aurora,autodns,aws,azion,azure,bookmyname,bunny,cf,clouddns,cloudns,cn,conoha,constellix,cpanel,curanet,cyon,da,ddnss,desec,df,dgon,dnsexit,dnshome,dnsimple,dnsservices,do,doapi,domeneshop,dp,dpi,dreamhost,duckdns,durabledns,dyn,dynu,dynv6,easydns,edgedns,euserv,exoscale,fornex,freedns,gandi_livedns,gcloud,gcore,gd,geoscaling,googledomains,he,hetzner,hexonet,hostingde,huaweicloud,infoblox,infomaniak,internetbs,inwx,ionos,ipv64,ispconfig,jd,joker,kappernet,kas,kinghost,knot,la,leaseweb,lexicon,linode,linode_v4,loopia,lua,maradns,me,miab,misaka,myapi,mydevil,mydnsjp,mythic_beasts,namecheap,namecom,namesilo,nanelo,nederhost,neodigit,netcup,netlify,nic,njalla,nm,nsd,nsone,nsupdate,nw,oci,one,online,openprovider,openstack,opnsense,ovh,pdns,pleskxml,pointhq,porkbun,rackcorp,rackspace,rage4,rcode0,regru,scaleway,schlundtech,selectel,selfhost,servercow,simply,tele3,tencent,transip,udr,ultra,unoeuro,variomedia,veesp,vercel,vscale,vultr,websupport,world4you,yandex,yc,zilore,zone,zonomi</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Data</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>DNS plugin data. (base64 encoded)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Disable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Flag to disable the config.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>ACME Plugin ID name</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nodes</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of cluster node names.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ValidationDelay</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterBackup" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterBackup </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update vzdump backup job definition.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterBackup [[-PveTicket] <PveTicket>] [-All] [[-Bwlimit] <Int32>] [[-Comment] <String>] [[-Compress] <String>] [[-Delete] <String>] [[-Dow] <String>] [[-Dumpdir] <String>] [-Enabled] [[-Exclude] <String>] [[-ExcludePath] <Array>] [-Id] <String> [[-Ionice] <Int32>] [[-Lockwait] <Int32>] [[-Mailnotification] <String>] [[-Mailto] <String>] [[-Maxfiles] <Int32>] [[-Mode] <String>] [[-Node] <String>] [[-NotesTemplate] <String>] [[-NotificationPolicy] <String>] [[-NotificationTarget] <String>] [[-Performance] <String>] [[-Pigz] <Int32>] [[-Pool] <String>] [-Protected] [[-PruneBackups] <String>] [-Quiet] [-Remove] [-RepeatMissed] [[-Schedule] <String>] [[-Script] <String>] [[-Starttime] <String>] [-Stdexcludes] [-Stop] [[-Stopwait] <Int32>] [[-Storage] <String>] [[-Tmpdir] <String>] [[-Vmid] <String>] [[-Zstd] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-All</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Backup all known guest systems on this host.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Bwlimit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Limit I/O bandwidth (in KiB/s).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Description for the Job.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Compress</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Compress dump file. Enum: 0,1,gzip,lzo,zstd</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dow</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Day of week selection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dumpdir</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Store resulting files to specified directory.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Enabled</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable or disable the job.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Exclude</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Exclude specified guest systems (assumes --all)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ExcludePath</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The job ID.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ionice</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Lockwait</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Maximal time to wait for the global lock (minutes).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mailnotification</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Deprecated':' use 'notification-policy' instead. Enum: always,failure</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mailto</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Comma-separated list of email addresses or users that should receive email notifications. Has no effect if the 'notification-target' option is set at the same time.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Maxfiles</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Deprecated':' use 'prune-backups' instead. Maximal number of backup files per guest system.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mode</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Backup mode. Enum: snapshot,suspend,stop</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only run if executed on this node.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-NotesTemplate</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\\' respectively.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-NotificationPolicy</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify when to send a notification Enum: always,failure,never</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-NotificationTarget</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Determine the target to which notifications should be sent. Can either be a notification endpoint or a notification group. This option takes precedence over 'mailto', meaning that if both are set, the 'mailto' option will be ignored.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Performance</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Other performance-related settings.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pigz</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pool</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Backup all known guest systems included in the specified pool.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Protected</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>If true, mark backup(s) as protected.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PruneBackups</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use these retention options instead of those from the storage configuration.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Quiet</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Be quiet.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Remove</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prune older backups according to 'prune-backups'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-RepeatMissed</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>If true, the job will be run as soon as possible if it was missed while the scheduler was not running.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Schedule</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Backup schedule. The format is a subset of `systemd` calendar events.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Script</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use specified hook script.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Starttime</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Job Start time.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Stdexcludes</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Exclude temporary files and logs.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Stop</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Stop running backup jobs on this host.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Stopwait</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Maximal time to wait until a guest system is stopped (minutes).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Store resulting file to this storage.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tmpdir</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Store temporary files to specified directory.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The ID of the guest system you want to backup.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Zstd</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Zstd threads. N=0 uses half of the available cores, N>0 uses N as thread count.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterCephFlags" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterCephFlags </h2>
|
|
<p></p>
|
|
<p class='searchable'>Set/Unset multiple ceph flags at once.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterCephFlags [[-PveTicket] <PveTicket>] [-Nobackfill] [-NodeepScrub] [-Nodown] [-Noin] [-Noout] [-Norebalance] [-Norecover] [-Noscrub] [-Notieragent] [-Noup] [-Pause] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nobackfill</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Backfilling of PGs is suspended.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-NodeepScrub</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Deep Scrubbing is disabled.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nodown</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>OSD failure reports are being ignored, such that the monitors will not mark OSDs down.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Noin</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>OSDs that were previously marked out will not be marked back in when they start.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Noout</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>OSDs will not automatically be marked out after the configured interval.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Norebalance</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rebalancing of PGs is suspended.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Norecover</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Recovery of PGs is suspended.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Noscrub</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Scrubbing is disabled.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Notieragent</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Cache tiering activity is suspended.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Noup</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>OSDs are not allowed to start.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pause</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Pauses read and writes.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterCephFlagsIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterCephFlagsIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Set or clear (unset) a specific ceph flag</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterCephFlagsIdx [[-PveTicket] <PveTicket>] [-Flag] <String> -Value [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Flag</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The ceph flag to update Enum: nobackfill,nodeep-scrub,nodown,noin,noout,norebalance,norecover,noscrub,notieragent,noup,pause</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Value</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The new value of the flag</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterFirewallAliases" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterFirewallAliases </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update IP or Network alias.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [[-Rename] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cidr</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network/IP specification in CIDR format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Alias name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Rename</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rename an existing alias.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterFirewallGroups" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterFirewallGroups </h2>
|
|
<p></p>
|
|
<p class='searchable'>Modify rule data.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterFirewallGroups [[-PveTicket] <PveTicket>] [[-Action] <String>] [[-Comment] <String>] [[-Delete] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [-Group] <String> [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Moveto] <Int32>] [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [[-Type] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Action</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Descriptive comment.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dport</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Enable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Flag to enable/disable a rule.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Group</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Security Group name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-IcmpType</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Iface</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Log</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Macro</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use predefined standard macro.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Moveto</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Move rule to new position <moveto>. Other arguments are ignored.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pos</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Update rule at position <pos>.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Proto</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Source</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Sport</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rule type. Enum: in,out,group</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterFirewallIpset" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterFirewallIpset </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update IP or Network settings</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterFirewallIpset [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Nomatch] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cidr</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network/IP specification in CIDR format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP set name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nomatch</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterFirewallOptions" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterFirewallOptions </h2>
|
|
<p></p>
|
|
<p class='searchable'>Set Firewall options.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterFirewallOptions [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Digest] <String>] [-Ebtables] [[-Enable] <Int32>] [[-LogRatelimit] <String>] [[-PolicyIn] <String>] [[-PolicyOut] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ebtables</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable ebtables rules cluster wide.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Enable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable or disable the firewall cluster wide.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-LogRatelimit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Log ratelimiting settings</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PolicyIn</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Input policy. Enum: ACCEPT,REJECT,DROP</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PolicyOut</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Output policy. Enum: ACCEPT,REJECT,DROP</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterFirewallRules" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterFirewallRules </h2>
|
|
<p></p>
|
|
<p class='searchable'>Modify rule data.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterFirewallRules [[-PveTicket] <PveTicket>] [[-Action] <String>] [[-Comment] <String>] [[-Delete] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Moveto] <Int32>] [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [[-Type] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Action</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Descriptive comment.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dport</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Enable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Flag to enable/disable a rule.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-IcmpType</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Iface</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Log</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Macro</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use predefined standard macro.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Moveto</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Move rule to new position <moveto>. Other arguments are ignored.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pos</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Update rule at position <pos>.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Proto</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Source</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Sport</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rule type. Enum: in,out,group</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterHaGroups" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterHaGroups </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update ha group configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterHaGroups [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <String>] [[-Digest] <String>] [-Group] <String> [[-Nodes] <String>] [-Nofailback] [-Restricted] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Description.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Group</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The HA group identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nodes</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of cluster node names with optional priority.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nofailback</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Restricted</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Resources bound to restricted groups may only run on nodes defined by the group.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterHaResources" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterHaResources </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update resource configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterHaResources [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <String>] [[-Digest] <String>] [[-Group] <String>] [[-MaxRelocate] <Int32>] [[-MaxRestart] <Int32>] [-Sid] <String> [[-State] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Description.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Group</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The HA group identifier.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MaxRelocate</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Maximal number of service relocate tries when a service failes to start.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MaxRestart</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Maximal number of tries to restart the service on a node after its start failed.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Sid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example':' vm':'100 / ct':'100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example':' 100).</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-State</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Requested resource state. Enum: started,stopped,enabled,disabled,ignored</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterJobsRealmSync" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterJobsRealmSync </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update realm-sync job definition.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterJobsRealmSync [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <String>] [-EnableNew] [-Enabled] [-Id] <String> [[-RemoveVanished] <String>] [-Schedule] <String> [[-Scope] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Description for the Job.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-EnableNew</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable newly synced users immediately.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Enabled</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Determines if the job is enabled.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The ID of the job.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-RemoveVanished</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A semicolon-seperated list of things to remove when they or the user vanishes during a sync. The following values are possible':' 'entry' removes the user/group when not returned from the sync. 'properties' removes the set properties on existing user/group that do not appear in the source (even custom ones). 'acl' removes acls when the user/group is not returned from the sync. Instead of a list it also can be 'none' (the default).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Schedule</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Backup schedule. The format is a subset of `systemd` calendar events.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Scope</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Select what to sync. Enum: users,groups,both</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterMappingPci" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterMappingPci </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update a hardware mapping.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterMappingPci [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Description] <String>] [[-Digest] <String>] [-Id] <String> [[-Map] <Array>] [-Mdev] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Description</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Description of the logical PCI device.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The ID of the logical PCI mapping.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Map</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of maps for the cluster nodes.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mdev</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterMappingUsb" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterMappingUsb </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update a hardware mapping.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterMappingUsb [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Description] <String>] [[-Digest] <String>] [-Id] <String> [-Map] <Array> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Description</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Description of the logical USB device.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The ID of the logical USB mapping.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Map</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of maps for the cluster nodes.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterMetricsServer" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterMetricsServer </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update metric server configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterMetricsServer [[-PveTicket] <PveTicket>] [[-ApiPathPrefix] <String>] [[-Bucket] <String>] [[-Delete] <String>] [[-Digest] <String>] [-Disable] [-Id] <String> [[-Influxdbproto] <String>] [[-MaxBodySize] <Int32>] [[-Mtu] <Int32>] [[-Organization] <String>] [[-Path] <String>] [-Port] <Int32> [[-Proto] <String>] [-Server] <String> [[-Timeout] <Int32>] [[-Token] <String>] [-VerifyCertificate] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ApiPathPrefix</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>An API path prefix inserted between '<host>':'<port>/' and '/api2/'. Can be useful if the InfluxDB service runs behind a reverse proxy.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Bucket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The InfluxDB bucket/db. Only necessary when using the http v2 api.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Disable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Flag to disable the plugin.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The ID of the entry.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Influxdbproto</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>-- Enum: udp,http,https</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MaxBodySize</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>InfluxDB max-body-size in bytes. Requests are batched up to this size.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mtu</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>MTU for metrics transmission over UDP</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Organization</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The InfluxDB organization. Only necessary when using the http v2 api. Has no meaning when using v2 compatibility api.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Path</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>root graphite path (ex':' proxmox.mycluster.mykey)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Port</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>server network port</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Proto</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Protocol to send graphite data. TCP or UDP (default) Enum: udp,tcp</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Server</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>server dns name or IP address</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Timeout</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>graphite TCP socket timeout (default=1)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Token</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The InfluxDB access token. Only necessary when using the http v2 api. If the v2 compatibility api is used, use 'user':'password' instead.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VerifyCertificate</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set to 0 to disable certificate verification for https endpoints.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterNotificationsEndpointsGotify" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterNotificationsEndpointsGotify </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update existing gotify endpoint</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterNotificationsEndpointsGotify [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <Array>] [[-Digest] <String>] [-Disable] [-Name] <String> [[-Server] <String>] [[-Token] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Comment</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Disable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Disable this target</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the endpoint.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Server</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Server URL</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Token</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Secret token</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterNotificationsEndpointsSendmail" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterNotificationsEndpointsSendmail </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update existing sendmail endpoint</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterNotificationsEndpointsSendmail [[-PveTicket] <PveTicket>] [[-Author] <String>] [[-Comment] <String>] [[-Delete] <Array>] [[-Digest] <String>] [-Disable] [[-FromAddress] <String>] [[-Mailto] <Array>] [[-MailtoUser] <Array>] [-Name] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Author</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Author of the mail</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Comment</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Disable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Disable this target</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-FromAddress</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>`From` address for the mail</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mailto</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of email recipients</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MailtoUser</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of users</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the endpoint.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterNotificationsEndpointsSmtp" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterNotificationsEndpointsSmtp </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update existing smtp endpoint</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterNotificationsEndpointsSmtp [[-PveTicket] <PveTicket>] [[-Author] <String>] [[-Comment] <String>] [[-Delete] <Array>] [[-Digest] <String>] [-Disable] [[-FromAddress] <String>] [[-Mailto] <Array>] [[-MailtoUser] <Array>] [[-Mode] <String>] [-Name] <String> [[-Password] <SecureString>] [[-Port] <Int32>] [[-Server] <String>] [[-Username] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Author</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Author of the mail. Defaults to 'Proxmox VE'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Comment</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Disable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Disable this target</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-FromAddress</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>`From` address for the mail</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mailto</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of email recipients</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MailtoUser</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of users</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mode</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Determine which encryption method shall be used for the connection. Enum: insecure,starttls,tls</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the endpoint.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Password</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Password for SMTP authentication</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Port</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The port to be used. Defaults to 465 for TLS based connections, 587 for STARTTLS based connections and port 25 for insecure plain-text connections.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Server</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The address of the SMTP server.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Username</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Username for SMTP authentication</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterNotificationsMatchers" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterNotificationsMatchers </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update existing matcher</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterNotificationsMatchers [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <Array>] [[-Digest] <String>] [-Disable] [-InvertMatch] [[-MatchCalendar] <Array>] [[-MatchField] <Array>] [[-MatchSeverity] <Array>] [[-Mode] <String>] [-Name] <String> [[-Target] <Array>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Comment</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Disable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Disable this matcher</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-InvertMatch</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Invert match of the whole matcher</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MatchCalendar</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Match notification timestamp</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MatchField</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Metadata fields to match (regex or exact match). Must be in the form (regex|exact)':'<field>=<value></td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MatchSeverity</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Notification severities to match</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mode</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Choose between 'all' and 'any' for when multiple properties are specified Enum: all,any</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Name of the matcher.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Target</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Targets to notify on match</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterOptions" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterOptions </h2>
|
|
<p></p>
|
|
<p class='searchable'>Set datacenter options.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterOptions [[-PveTicket] <PveTicket>] [[-Bwlimit] <String>] [[-Console] <String>] [[-Crs] <String>] [[-Delete] <String>] [[-Description] <String>] [[-EmailFrom] <String>] [[-Fencing] <String>] [[-Ha] <String>] [[-HttpProxy] <String>] [[-Keyboard] <String>] [[-Language] <String>] [[-MacPrefix] <String>] [[-MaxWorkers] <Int32>] [[-Migration] <String>] [-MigrationUnsecure] [[-NextId] <String>] [[-Notify] <String>] [[-RegisteredTags] <String>] [[-TagStyle] <String>] [[-U2f] <String>] [[-UserTagAccess] <String>] [[-Webauthn] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Bwlimit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set I/O bandwidth limit for various operations (in KiB/s).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Console</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Select the default Console viewer. You can either use the builtin java applet (VNC; deprecated and maps to html5), an external virt-viewer comtatible application (SPICE), an HTML5 based vnc viewer (noVNC), or an HTML5 based console client (xtermjs). If the selected viewer is not available (e.g. SPICE not activated for the VM), the fallback is noVNC. Enum: applet,vv,html5,xtermjs</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Crs</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Cluster resource scheduling settings.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Description</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Datacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-EmailFrom</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify email address to send notification from (default is root@$hostname)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Fencing</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set the fencing mode of the HA cluster. Hardware mode needs a valid configuration of fence devices in /etc/pve/ha/fence.cfg. With both all two modes are used.WARNING':' 'hardware' and 'both' are EXPERIMENTAL & WIP Enum: watchdog,hardware,both</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ha</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Cluster wide HA settings.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-HttpProxy</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify external http proxy which is used for downloads (example':' 'http':'//username':'password@host':'port/')</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Keyboard</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Default keybord layout for vnc server. Enum: de,de-ch,da,en-gb,en-us,es,fi,fr,fr-be,fr-ca,fr-ch,hu,is,it,ja,lt,mk,nl,no,pl,pt,pt-br,sv,sl,tr</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Language</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Default GUI language. Enum: ar,ca,da,de,en,es,eu,fa,fr,hr,he,it,ja,ka,kr,nb,nl,nn,pl,pt_BR,ru,sl,sv,tr,ukr,zh_CN,zh_TW</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MacPrefix</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prefix for the auto-generated MAC addresses of virtual guests. The default 'BC':'24':'11' is the OUI assigned by the IEEE to Proxmox Server Solutions GmbH for a 24-bit large MAC block. You're allowed to use this in local networks, i.e., those not directly reachable by the public (e.g., in a LAN or behind NAT).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MaxWorkers</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Migration</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>For cluster wide migration settings.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MigrationUnsecure</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Migration is secure using SSH tunnel by default. For secure private networks you can disable it to speed up migration. Deprecated, use the 'migration' property instead!</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-NextId</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Control the range for the free VMID auto-selection pool.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Notify</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Cluster-wide notification settings.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-RegisteredTags</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of tags that require a `Sys.Modify` on '/' to set and delete. Tags set here that are also in 'user-tag-access' also require `Sys.Modify`.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-TagStyle</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Tag style options.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-U2f</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>u2f</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-UserTagAccess</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Privilege options for user-settable tags</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Webauthn</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>webauthn configuration</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterReplication" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterReplication </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update replication job configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterReplication [[-PveTicket] <PveTicket>] [[-Comment] <String>] [[-Delete] <String>] [[-Digest] <String>] [-Disable] [-Id] <String> [[-Rate] <Single>] [[-RemoveJob] <String>] [[-Schedule] <String>] [[-Source] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Description.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Disable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Flag to disable/deactivate the entry.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Id</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '<GUEST>-<JOBNUM>'.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Rate</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rate limit in mbps (megabytes per second) as floating point number.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-RemoveJob</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Mark the replication job for removal. The job will remove all local replication snapshots. When set to 'full', it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file. Enum: local,full</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Schedule</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Storage replication schedule. The format is a subset of `systemd` calendar events.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Source</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>For internal use, to detect if the guest was stolen.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterSdn" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterSdn </h2>
|
|
<p></p>
|
|
<p class='searchable'>Apply sdn controller changes && reload.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterSdn [[-PveTicket] <PveTicket>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterSdnControllers" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterSdnControllers </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update sdn controller object configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterSdnControllers [[-PveTicket] <PveTicket>] [[-Asn] <Int32>] [-BgpMultipathAsPathRelax] [-Controller] <String> [[-Delete] <String>] [[-Digest] <String>] [-Ebgp] [[-EbgpMultihop] <Int32>] [[-IsisDomain] <String>] [[-IsisIfaces] <String>] [[-IsisNet] <String>] [[-Loopback] <String>] [[-Node] <String>] [[-Peers] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Asn</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>autonomous system number</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-BgpMultipathAsPathRelax</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Controller</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN controller object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ebgp</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable ebgp. (remote-as external)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-EbgpMultihop</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-IsisDomain</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>ISIS domain.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-IsisIfaces</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>ISIS interface.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-IsisNet</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>ISIS network entity title.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Loopback</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>source loopback interface.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Peers</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>peers address list.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterSdnDns" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterSdnDns </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update sdn dns object configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterSdnDns [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Digest] <String>] [-Dns] <String> [[-Key] <String>] [[-Reversemaskv6] <Int32>] [[-Ttl] <Int32>] [[-Url] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dns</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN dns object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Key</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Reversemaskv6</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ttl</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Url</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterSdnIpams" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterSdnIpams </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update sdn ipam object configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterSdnIpams [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Digest] <String>] [-Ipam] <String> [[-Section] <Int32>] [[-Token] <String>] [[-Url] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ipam</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN ipam object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Section</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Token</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Url</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterSdnVnets" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterSdnVnets </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update sdn vnet object configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterSdnVnets [[-PveTicket] <PveTicket>] [[-Alias] <String>] [[-Delete] <String>] [[-Digest] <String>] [[-Tag] <Int32>] [-Vlanaware] [-Vnet] <String> [[-Zone] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Alias</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>alias name of the vnet</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tag</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>vlan or vxlan id</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vlanaware</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Allow vm VLANs to pass through this vnet.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vnet</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN vnet object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Zone</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>zone id</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterSdnVnetsIps" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterSdnVnetsIps </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update IP Mapping in a VNet</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterSdnVnetsIps [[-PveTicket] <PveTicket>] [-Ip] <String> [[-Mac] <String>] [[-Vmid] <Int32>] [-Vnet] <String> [-Zone] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ip</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The IP address to associate with the given MAC address</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mac</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Unicast MAC address.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vnet</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN vnet object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Zone</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN zone object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterSdnVnetsSubnets" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterSdnVnetsSubnets </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update sdn subnet object configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterSdnVnetsSubnets [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-DhcpDnsServer] <String>] [[-DhcpRange] <Array>] [[-Digest] <String>] [[-Dnszoneprefix] <String>] [[-Gateway] <String>] [-Snat] [-Subnet] <String> [[-Vnet] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-DhcpDnsServer</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP address for the DNS server</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-DhcpRange</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of DHCP ranges for this subnet</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dnszoneprefix</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>dns domain zone prefix ex':' 'adm' -> <hostname>.adm.mydomain.com</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Gateway</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Subnet Gateway':' Will be assign on vnet for layer3 zones</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Snat</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>enable masquerade for this subnet if pve-firewall</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Subnet</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN subnet object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vnet</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>associated vnet</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveClusterSdnZones" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveClusterSdnZones </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update sdn zone object configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveClusterSdnZones [[-PveTicket] <PveTicket>] [-AdvertiseSubnets] [[-Bridge] <String>] [-BridgeDisableMacLearning] [[-Controller] <String>] [[-Delete] <String>] [[-Dhcp] <String>] [[-Digest] <String>] [-DisableArpNdSuppression] [[-Dns] <String>] [[-Dnszone] <String>] [[-DpId] <Int32>] [[-Exitnodes] <String>] [-ExitnodesLocalRouting] [[-ExitnodesPrimary] <String>] [[-Ipam] <String>] [[-Mac] <String>] [[-Mtu] <Int32>] [[-Nodes] <String>] [[-Peers] <String>] [[-Reversedns] <String>] [[-RtImport] <String>] [[-Tag] <Int32>] [[-VlanProtocol] <String>] [[-VrfVxlan] <Int32>] [[-VxlanPort] <Int32>] [-Zone] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-AdvertiseSubnets</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Advertise evpn subnets if you have silent hosts</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Bridge</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-BridgeDisableMacLearning</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Disable auto mac learning.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Controller</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Frr router name</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dhcp</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Type of the DHCP backend for this zone Enum: dnsmasq</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-DisableArpNdSuppression</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Disable ipv4 arp && ipv6 neighbour discovery suppression</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dns</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>dns api server</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dnszone</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>dns domain zone ex':' mydomain.com</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-DpId</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Faucet dataplane id</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Exitnodes</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of cluster node names.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ExitnodesLocalRouting</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Allow exitnodes to connect to evpn guests</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ExitnodesPrimary</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Force traffic to this exitnode first.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ipam</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>use a specific ipam</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mac</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Anycast logical router mac address</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mtu</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>MTU</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nodes</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of cluster node names.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Peers</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>peers address list.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Reversedns</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>reverse dns api server</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-RtImport</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Route-Target import</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tag</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Service-VLAN Tag</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VlanProtocol</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>-- Enum: 802.1q,802.1ad</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VrfVxlan</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>l3vni.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VxlanPort</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Vxlan tunnel udp port (default 4789).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Zone</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The SDN zone object identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesAptRepositories" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesAptRepositories </h2>
|
|
<p></p>
|
|
<p class='searchable'>Add a standard repository to the configuration</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesAptRepositories [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Handle] <String> [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Digest to detect modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Handle</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Handle that identifies a repository.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesCephPool" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesCephPool </h2>
|
|
<p></p>
|
|
<p class='searchable'>Change POOL settings</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesCephPool [[-PveTicket] <PveTicket>] [[-Application] <String>] [[-CrushRule] <String>] [[-MinSize] <Int32>] [-Name] <String> [-Node] <String> [[-PgAutoscaleMode] <String>] [[-PgNum] <Int32>] [[-PgNumMin] <Int32>] [[-Size] <Int32>] [[-TargetSize] <String>] [[-TargetSizeRatio] <Single>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Application</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The application of the pool. Enum: rbd,cephfs,rgw</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-CrushRule</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The rule to use for mapping object placement in the cluster.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MinSize</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Minimum number of replicas per object</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the pool. It must be unique.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PgAutoscaleMode</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The automatic PG scaling mode of the pool. Enum: on,off,warn</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PgNum</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Number of placement groups.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PgNumMin</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Minimal number of placement groups.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Size</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Number of replicas per object</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-TargetSize</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The estimated target size of the pool for the PG autoscaler.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-TargetSizeRatio</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The estimated target ratio of the pool for the PG autoscaler.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesCertificatesAcmeCertificate" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesCertificatesAcmeCertificate </h2>
|
|
<p></p>
|
|
<p class='searchable'>Renew existing certificate from CA.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesCertificatesAcmeCertificate [[-PveTicket] <PveTicket>] [-Force] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Force</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Force renewal even if expiry is more than 30 days away.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesConfig" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesConfig </h2>
|
|
<p></p>
|
|
<p class='searchable'>Set node configuration options.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesConfig [[-PveTicket] <PveTicket>] [[-Acme] <String>] [[-AcmedomainN] <Hashtable>] [[-Delete] <String>] [[-Description] <String>] [[-Digest] <String>] [-Node] <String> [[-StartallOnbootDelay] <Int32>] [[-Wakeonlan] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Acme</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Node specific ACME settings.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-AcmedomainN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>ACME domain and validation plugin</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Description</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Description for the Node. Shown in the web-interface node notes panel. This is saved as comment inside the configuration file.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-StartallOnbootDelay</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Initial delay in seconds, before starting all the Virtual Guests with on-boot enabled.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Wakeonlan</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>MAC address for wake on LAN</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesDisksWipedisk" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesDisksWipedisk </h2>
|
|
<p></p>
|
|
<p class='searchable'>Wipe a disk or partition.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesDisksWipedisk [[-PveTicket] <PveTicket>] [-Disk] <String> [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Disk</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Block device name</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesDns" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesDns </h2>
|
|
<p></p>
|
|
<p class='searchable'>Write DNS settings.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesDns [[-PveTicket] <PveTicket>] [[-Dns1] <String>] [[-Dns2] <String>] [[-Dns3] <String>] [-Node] <String> [-Search] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dns1</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>First name server IP address.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dns2</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Second name server IP address.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dns3</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Third name server IP address.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Search</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Search domain for host-name lookup.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesFirewallOptions" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesFirewallOptions </h2>
|
|
<p></p>
|
|
<p class='searchable'>Set Firewall options.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesFirewallOptions [[-PveTicket] <PveTicket>] [[-Delete] <String>] [[-Digest] <String>] [-Enable] [[-LogLevelIn] <String>] [[-LogLevelOut] <String>] [-LogNfConntrack] [-Ndp] [-NfConntrackAllowInvalid] [[-NfConntrackHelpers] <String>] [[-NfConntrackMax] <Int32>] [[-NfConntrackTcpTimeoutEstablished] <Int32>] [[-NfConntrackTcpTimeoutSynRecv] <Int32>] [-Node] <String> [-Nosmurfs] [-ProtectionSynflood] [[-ProtectionSynfloodBurst] <Int32>] [[-ProtectionSynfloodRate] <Int32>] [[-SmurfLogLevel] <String>] [[-TcpFlagsLogLevel] <String>] [-Tcpflags] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Enable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable host firewall rules.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-LogLevelIn</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Log level for incoming traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-LogLevelOut</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Log level for outgoing traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-LogNfConntrack</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable logging of conntrack information.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ndp</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable NDP (Neighbor Discovery Protocol).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-NfConntrackAllowInvalid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Allow invalid packets on connection tracking.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-NfConntrackHelpers</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable conntrack helpers for specific protocols. Supported protocols':' amanda, ftp, irc, netbios-ns, pptp, sane, sip, snmp, tftp</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-NfConntrackMax</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Maximum number of tracked connections.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-NfConntrackTcpTimeoutEstablished</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Conntrack established timeout.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-NfConntrackTcpTimeoutSynRecv</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Conntrack syn recv timeout.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nosmurfs</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable SMURFS filter.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ProtectionSynflood</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable synflood protection</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ProtectionSynfloodBurst</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Synflood protection rate burst by ip src.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ProtectionSynfloodRate</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Synflood protection rate syn/sec by ip src.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-SmurfLogLevel</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Log level for SMURFS filter. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-TcpFlagsLogLevel</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Log level for illegal tcp flags filter. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tcpflags</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Filter illegal combinations of TCP flags.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesFirewallRules" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesFirewallRules </h2>
|
|
<p></p>
|
|
<p class='searchable'>Modify rule data.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesFirewallRules [[-PveTicket] <PveTicket>] [[-Action] <String>] [[-Comment] <String>] [[-Delete] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Moveto] <Int32>] [-Node] <String> [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [[-Type] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Action</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Descriptive comment.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dport</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Enable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Flag to enable/disable a rule.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-IcmpType</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Iface</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Log</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Macro</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use predefined standard macro.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Moveto</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Move rule to new position <moveto>. Other arguments are ignored.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pos</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Update rule at position <pos>.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Proto</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Source</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Sport</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rule type. Enum: in,out,group</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesLxcConfig" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesLxcConfig </h2>
|
|
<p></p>
|
|
<p class='searchable'>Set container options.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesLxcConfig [[-PveTicket] <PveTicket>] [[-Arch] <String>] [[-Cmode] <String>] [-Console] [[-Cores] <Int32>] [[-Cpulimit] <Single>] [[-Cpuunits] <Int32>] [-Debug_] [[-Delete] <String>] [[-Description] <String>] [[-DevN] <Hashtable>] [[-Digest] <String>] [[-Features] <String>] [[-Hookscript] <String>] [[-Hostname] <String>] [[-Lock] <String>] [[-Memory] <Int32>] [[-MpN] <Hashtable>] [[-Nameserver] <String>] [[-NetN] <Hashtable>] [-Node] <String> [-Onboot] [[-Ostype] <String>] [-Protection] [[-Revert] <String>] [[-Rootfs] <String>] [[-Searchdomain] <String>] [[-Startup] <String>] [[-Swap] <Int32>] [[-Tags] <String>] [-Template] [[-Timezone] <String>] [[-Tty] <Int32>] [-Unprivileged] [[-UnusedN] <Hashtable>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Arch</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>OS architecture type. Enum: amd64,i386,arm64,armhf,riscv32,riscv64</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cmode</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login). Enum: shell,console,tty</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Console</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Attach a console device (/dev/console) to the container.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cores</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The number of cores assigned to the container. A container can use all available cores by default.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cpulimit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Limit of CPU usage.NOTE':' If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cpuunits</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>CPU weight for a container, will be clamped to \[1, 10000] in cgroup v2.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Debug_</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Try to be more verbose. For now this only enables debug log-level on start.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Description</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-DevN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Device to pass through to the container</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Features</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Allow containers access to advanced features.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Hookscript</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Script that will be exectued during various steps in the containers lifetime.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Hostname</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set a host name for the container.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Lock</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Lock/unlock the container. Enum: backup,create,destroyed,disk,fstrim,migrate,mounted,rollback,snapshot,snapshot-delete</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Memory</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Amount of RAM for the container in MB.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MpN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use volume as container mount point. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nameserver</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-NetN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specifies network interfaces for the container.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Onboot</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specifies whether a container will be started during system bootup.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ostype</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. Enum: debian,devuan,ubuntu,centos,fedora,opensuse,archlinux,alpine,gentoo,nixos,unmanaged</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Protection</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Revert</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Revert a pending change.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Rootfs</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use volume as container root.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Searchdomain</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Startup</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Swap</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Amount of SWAP for the container in MB.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tags</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Tags of the Container. This is only meta information.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Template</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable Template.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Timezone</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tty</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify the number of tty available to the container</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Unprivileged</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Makes the container run as unprivileged user. (Should not be modified manually.)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-UnusedN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Reference to unused volumes. This is used internally, and should not be modified manually.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesLxcFirewallAliases" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesLxcFirewallAliases </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update IP or Network alias.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesLxcFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [[-Rename] <String>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cidr</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network/IP specification in CIDR format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Alias name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Rename</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rename an existing alias.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesLxcFirewallIpset" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesLxcFirewallIpset </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update IP or Network settings</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesLxcFirewallIpset [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Nomatch] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cidr</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network/IP specification in CIDR format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP set name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nomatch</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesLxcFirewallOptions" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesLxcFirewallOptions </h2>
|
|
<p></p>
|
|
<p class='searchable'>Set Firewall options.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesLxcFirewallOptions [[-PveTicket] <PveTicket>] [[-Delete] <String>] [-Dhcp] [[-Digest] <String>] [-Enable] [-Ipfilter] [[-LogLevelIn] <String>] [[-LogLevelOut] <String>] [-Macfilter] [-Ndp] [-Node] <String> [[-PolicyIn] <String>] [[-PolicyOut] <String>] [-Radv] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dhcp</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable DHCP.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Enable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable firewall rules.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ipfilter</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable default IP filters. This is equivalent to adding an empty ipfilter-net<id> ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-LogLevelIn</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Log level for incoming traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-LogLevelOut</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Log level for outgoing traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Macfilter</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable MAC address filter.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ndp</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable NDP (Neighbor Discovery Protocol).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PolicyIn</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Input policy. Enum: ACCEPT,REJECT,DROP</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PolicyOut</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Output policy. Enum: ACCEPT,REJECT,DROP</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Radv</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Allow sending Router Advertisement.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesLxcFirewallRules" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesLxcFirewallRules </h2>
|
|
<p></p>
|
|
<p class='searchable'>Modify rule data.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesLxcFirewallRules [[-PveTicket] <PveTicket>] [[-Action] <String>] [[-Comment] <String>] [[-Delete] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Moveto] <Int32>] [-Node] <String> [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [[-Type] <String>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Action</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Descriptive comment.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dport</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Enable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Flag to enable/disable a rule.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-IcmpType</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Iface</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Log</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Macro</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use predefined standard macro.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Moveto</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Move rule to new position <moveto>. Other arguments are ignored.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pos</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Update rule at position <pos>.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Proto</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Source</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Sport</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rule type. Enum: in,out,group</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesLxcResize" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesLxcResize </h2>
|
|
<p></p>
|
|
<p class='searchable'>Resize a container mount point.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesLxcResize [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Disk] <String> [-Node] <String> [-Size] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Disk</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The disk you want to resize. Enum: rootfs,mp0,mp1,mp2,mp3,mp4,mp5,mp6,mp7,mp8,mp9,mp10,mp11,mp12,mp13,mp14,mp15,mp16,mp17,mp18,mp19,mp20,mp21,mp22,mp23,mp24,mp25,mp26,mp27,mp28,mp29,mp30,mp31,mp32,mp33,mp34,mp35,mp36,mp37,mp38,mp39,mp40,mp41,mp42,mp43,mp44,mp45,mp46,mp47,mp48,mp49,mp50,mp51,mp52,mp53,mp54,mp55,mp56,mp57,mp58,mp59,mp60,mp61,mp62,mp63,mp64,mp65,mp66,mp67,mp68,mp69,mp70,mp71,mp72,mp73,mp74,mp75,mp76,mp77,mp78,mp79,mp80,mp81,mp82,mp83,mp84,mp85,mp86,mp87,mp88,mp89,mp90,mp91,mp92,mp93,mp94,mp95,mp96,mp97,mp98,mp99,mp100,mp101,mp102,mp103,mp104,mp105,mp106,mp107,mp108,mp109,mp110,mp111,mp112,mp113,mp114,mp115,mp116,mp117,mp118,mp119,mp120,mp121,mp122,mp123,mp124,mp125,mp126,mp127,mp128,mp129,mp130,mp131,mp132,mp133,mp134,mp135,mp136,mp137,mp138,mp139,mp140,mp141,mp142,mp143,mp144,mp145,mp146,mp147,mp148,mp149,mp150,mp151,mp152,mp153,mp154,mp155,mp156,mp157,mp158,mp159,mp160,mp161,mp162,mp163,mp164,mp165,mp166,mp167,mp168,mp169,mp170,mp171,mp172,mp173,mp174,mp175,mp176,mp177,mp178,mp179,mp180,mp181,mp182,mp183,mp184,mp185,mp186,mp187,mp188,mp189,mp190,mp191,mp192,mp193,mp194,mp195,mp196,mp197,mp198,mp199,mp200,mp201,mp202,mp203,mp204,mp205,mp206,mp207,mp208,mp209,mp210,mp211,mp212,mp213,mp214,mp215,mp216,mp217,mp218,mp219,mp220,mp221,mp222,mp223,mp224,mp225,mp226,mp227,mp228,mp229,mp230,mp231,mp232,mp233,mp234,mp235,mp236,mp237,mp238,mp239,mp240,mp241,mp242,mp243,mp244,mp245,mp246,mp247,mp248,mp249,mp250,mp251,mp252,mp253,mp254,mp255</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Size</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The new size. With the '+' sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesLxcSnapshotConfig" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesLxcSnapshotConfig </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update snapshot metadata.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesLxcSnapshotConfig [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Description</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A textual description or comment.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Snapname</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the snapshot.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesNetwork" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesNetwork </h2>
|
|
<p></p>
|
|
<p class='searchable'>Reload network configuration</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesNetwork [[-PveTicket] <PveTicket>] [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesNetworkIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesNetworkIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update network device configuration</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesNetworkIdx [[-PveTicket] <PveTicket>] [[-Address] <String>] [[-Address6] <String>] [-Autostart] [[-BondPrimary] <String>] [[-BondMode] <String>] [[-BondXmitHashPolicy] <String>] [[-BridgePorts] <String>] [-BridgeVlanAware] [[-Cidr] <String>] [[-Cidr6] <String>] [[-Comments] <String>] [[-Comments6] <String>] [[-Delete] <String>] [[-Gateway] <String>] [[-Gateway6] <String>] [-Iface] <String> [[-Mtu] <Int32>] [[-Netmask] <String>] [[-Netmask6] <Int32>] [-Node] <String> [[-OvsBonds] <String>] [[-OvsBridge] <String>] [[-OvsOptions] <String>] [[-OvsPorts] <String>] [[-OvsTag] <Int32>] [[-Slaves] <String>] [-Type] <String> [[-VlanId] <Int32>] [[-VlanRawDevice] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Address</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP address.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Address6</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP address.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Autostart</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Automatically start interface on boot.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-BondPrimary</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify the primary interface for active-backup bond.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-BondMode</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Bonding mode. Enum: balance-rr,active-backup,balance-xor,broadcast,802.3ad,balance-tlb,balance-alb,balance-slb,lacp-balance-slb,lacp-balance-tcp</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-BondXmitHashPolicy</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes. Enum: layer2,layer2+3,layer3+4</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-BridgePorts</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify the interfaces you want to add to your bridge.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-BridgeVlanAware</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable bridge vlan support.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cidr</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IPv4 CIDR.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cidr6</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IPv6 CIDR.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comments</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Comments</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comments6</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Comments</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Gateway</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Default gateway address.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Gateway6</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Default ipv6 gateway address.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Iface</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network interface name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mtu</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>MTU.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Netmask</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network mask.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Netmask6</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network mask.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-OvsBonds</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify the interfaces used by the bonding device.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-OvsBridge</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The OVS bridge associated with a OVS port. This is required when you create an OVS port.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-OvsOptions</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>OVS interface options.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-OvsPorts</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify the interfaces you want to add to your bridge.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-OvsTag</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Slaves</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify the interfaces used by the bonding device.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network interface type Enum: bridge,bond,eth,alias,vlan,OVSBridge,OVSBond,OVSPort,OVSIntPort,unknown</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VlanId</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>vlan-id for a custom named vlan interface (ifupdown2 only).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VlanRawDevice</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify the raw interface for the vlan interface.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesQemuCloudinit" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesQemuCloudinit </h2>
|
|
<p></p>
|
|
<p class='searchable'>Regenerate and change cloudinit config drive.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesQemuCloudinit [[-PveTicket] <PveTicket>] [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesQemuConfig" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesQemuConfig </h2>
|
|
<p></p>
|
|
<p class='searchable'>Set virtual machine options (synchrounous API) - You should consider using the POST method instead for any actions involving hotplug or storage allocation.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesQemuConfig [[-PveTicket] <PveTicket>] [-Acpi] [[-Affinity] <String>] [[-Agent] <String>] [[-Arch] <String>] [[-Args_] <String>] [[-Audio0] <String>] [-Autostart] [[-Balloon] <Int32>] [[-Bios] <String>] [[-Boot] <String>] [[-Bootdisk] <String>] [[-Cdrom] <String>] [[-Cicustom] <String>] [[-Cipassword] <SecureString>] [[-Citype] <String>] [-Ciupgrade] [[-Ciuser] <String>] [[-Cores] <Int32>] [[-Cpu] <String>] [[-Cpulimit] <Single>] [[-Cpuunits] <Int32>] [[-Delete] <String>] [[-Description] <String>] [[-Digest] <String>] [[-Efidisk0] <String>] [-Force] [-Freeze] [[-Hookscript] <String>] [[-HostpciN] <Hashtable>] [[-Hotplug] <String>] [[-Hugepages] <String>] [[-IdeN] <Hashtable>] [[-IpconfigN] <Hashtable>] [[-Ivshmem] <String>] [-Keephugepages] [[-Keyboard] <String>] [-Kvm] [-Localtime] [[-Lock] <String>] [[-Machine] <String>] [[-Memory] <String>] [[-MigrateDowntime] <Single>] [[-MigrateSpeed] <Int32>] [[-Name] <String>] [[-Nameserver] <String>] [[-NetN] <Hashtable>] [-Node] <String> [-Numa] [[-NumaN] <Hashtable>] [-Onboot] [[-Ostype] <String>] [[-ParallelN] <Hashtable>] [-Protection] [-Reboot] [[-Revert] <String>] [[-Rng0] <String>] [[-SataN] <Hashtable>] [[-ScsiN] <Hashtable>] [[-Scsihw] <String>] [[-Searchdomain] <String>] [[-SerialN] <Hashtable>] [[-Shares] <Int32>] [-Skiplock] [[-Smbios1] <String>] [[-Smp] <Int32>] [[-Sockets] <Int32>] [[-SpiceEnhancements] <String>] [[-Sshkeys] <String>] [[-Startdate] <String>] [[-Startup] <String>] [-Tablet] [[-Tags] <String>] [-Tdf] [-Template] [[-Tpmstate0] <String>] [[-UnusedN] <Hashtable>] [[-UsbN] <Hashtable>] [[-Vcpus] <Int32>] [[-Vga] <String>] [[-VirtioN] <Hashtable>] [[-Vmgenid] <String>] [-Vmid] <Int32> [[-Vmstatestorage] <String>] [[-Watchdog] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Acpi</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable ACPI.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Affinity</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of host cores used to execute guest processes, for example':' 0,5,8-11</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Agent</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable communication with the QEMU Guest Agent and its properties.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Arch</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Virtual processor architecture. Defaults to the host. Enum: x86_64,aarch64</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Args_</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Arbitrary arguments passed to kvm.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Audio0</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Configure a audio device, useful in combination with QXL/Spice.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Autostart</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Automatic restart after crash (currently ignored).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Balloon</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Amount of target RAM for the VM in MiB. Using zero disables the ballon driver.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Bios</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Select BIOS implementation. Enum: seabios,ovmf</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Boot</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Bootdisk</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable booting from specified disk. Deprecated':' Use 'boot':' order=foo;bar' instead.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cdrom</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>This is an alias for option -ide2</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cicustom</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>cloud-init':' Specify custom files to replace the automatically generated ones at start.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cipassword</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>cloud-init':' Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Citype</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specifies the cloud-init configuration format. The default depends on the configured operating system type (`ostype`. We use the `nocloud` format for Linux, and `configdrive2` for windows. Enum: configdrive2,nocloud,opennebula</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ciupgrade</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>cloud-init':' do an automatic package upgrade after the first boot.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ciuser</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>cloud-init':' User name to change ssh keys and password for instead of the image's configured default user.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cores</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The number of cores per socket.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cpu</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Emulated CPU type.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cpulimit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Limit of CPU usage.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cpuunits</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>CPU weight for a VM, will be clamped to \[1, 10000] in cgroup v2.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Description</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Efidisk0</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Configure a disk for storing EFI vars. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Force</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused\[n]', which contains the volume ID. Unlink of unused\[n] always cause physical removal.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Freeze</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Freeze CPU at startup (use 'c' monitor command to start execution).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Hookscript</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Script that will be executed during various steps in the vms lifetime.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-HostpciN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Map host PCI devices into guest.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Hotplug</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Selectively enable hotplug features. This is a comma separated list of hotplug features':' 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default `network,disk,usb`. USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Hugepages</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable hugepages memory. Enum: any,2,1024</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-IdeN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-IpconfigN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>cloud-init':' Specify IP addresses and gateways for the corresponding interface.IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified.The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicitgateway should be provided.For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requirescloud-init 19.4 or newer.If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to usingdhcp on IPv4.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ivshmem</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Inter-VM shared memory. Useful for direct communication between VMs, or to the host.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Keephugepages</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Keyboard</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. Enum: de,de-ch,da,en-gb,en-us,es,fi,fr,fr-be,fr-ca,fr-ch,hu,is,it,ja,lt,mk,nl,no,pl,pt,pt-br,sv,sl,tr</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Kvm</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable KVM hardware virtualization.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Localtime</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Lock</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Lock/unlock the VM. Enum: backup,clone,create,migrate,rollback,snapshot,snapshot-delete,suspending,suspended</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Machine</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specifies the QEMU machine type.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Memory</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Memory properties.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MigrateDowntime</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set maximum tolerated downtime (in seconds) for migrations.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MigrateSpeed</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set maximum speed (in MB/s) for migrations. Value 0 is no limit.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set a name for the VM. Only used on the configuration web interface.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nameserver</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>cloud-init':' Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-NetN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify network devices.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Numa</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable NUMA.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-NumaN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>NUMA topology.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Onboot</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specifies whether a VM will be started during system bootup.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ostype</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify guest operating system. Enum: other,wxp,w2k,w2k3,w2k8,wvista,win7,win8,win10,win11,l24,l26,solaris</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ParallelN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Map host parallel devices (n is 0 to 2).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Protection</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Sets the protection flag of the VM. This will disable the remove VM and remove disk operations.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Reboot</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Allow reboot. If set to '0' the VM exit on reboot.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Revert</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Revert a pending change.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Rng0</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Configure a VirtIO-based Random Number Generator.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-SataN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ScsiN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Scsihw</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>SCSI controller model Enum: lsi,lsi53c810,virtio-scsi-pci,virtio-scsi-single,megasas,pvscsi</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Searchdomain</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>cloud-init':' Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-SerialN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Create a serial device inside the VM (n is 0 to 3)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Shares</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Skiplock</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ignore locks - only root is allowed to use this option.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Smbios1</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify SMBIOS type 1 fields.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Smp</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The number of CPUs. Please use option -sockets instead.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Sockets</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The number of CPU sockets.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-SpiceEnhancements</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Configure additional enhancements for SPICE.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Sshkeys</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>cloud-init':' Setup public SSH keys (one key per line, OpenSSH format).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Startdate</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set the initial date of the real time clock. Valid format for date are':''now' or '2006-06-17T16':'01':'21' or '2006-06-17'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Startup</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tablet</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable the USB tablet device.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tags</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Tags of the VM. This is only meta information.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tdf</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable time drift fix.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Template</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable Template.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Tpmstate0</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-UnusedN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Reference to unused volumes. This is used internally, and should not be modified manually.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-UsbN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vcpus</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Number of hotplugged vcpus.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vga</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Configure the VGA hardware.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VirtioN</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID':'SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID':'0 and the 'import-from' parameter to import from an existing volume.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmgenid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmstatestorage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Default storage for VM state volumes/files.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Watchdog</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Create a virtual hardware watchdog device.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesQemuFirewallAliases" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesQemuFirewallAliases </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update IP or Network alias.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesQemuFirewallAliases [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [[-Rename] <String>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cidr</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network/IP specification in CIDR format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Alias name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Rename</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rename an existing alias.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesQemuFirewallIpset" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesQemuFirewallIpset </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update IP or Network settings</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesQemuFirewallIpset [[-PveTicket] <PveTicket>] [-Cidr] <String> [[-Comment] <String>] [[-Digest] <String>] [-Name] <String> [-Node] <String> [-Nomatch] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Cidr</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network/IP specification in CIDR format.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Name</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP set name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nomatch</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesQemuFirewallOptions" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesQemuFirewallOptions </h2>
|
|
<p></p>
|
|
<p class='searchable'>Set Firewall options.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesQemuFirewallOptions [[-PveTicket] <PveTicket>] [[-Delete] <String>] [-Dhcp] [[-Digest] <String>] [-Enable] [-Ipfilter] [[-LogLevelIn] <String>] [[-LogLevelOut] <String>] [-Macfilter] [-Ndp] [-Node] <String> [[-PolicyIn] <String>] [[-PolicyOut] <String>] [-Radv] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dhcp</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable DHCP.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Enable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable firewall rules.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ipfilter</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable default IP filters. This is equivalent to adding an empty ipfilter-net<id> ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-LogLevelIn</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Log level for incoming traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-LogLevelOut</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Log level for outgoing traffic. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Macfilter</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable/disable MAC address filter.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Ndp</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Enable NDP (Neighbor Discovery Protocol).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PolicyIn</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Input policy. Enum: ACCEPT,REJECT,DROP</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PolicyOut</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Output policy. Enum: ACCEPT,REJECT,DROP</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Radv</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Allow sending Router Advertisement.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesQemuFirewallRules" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesQemuFirewallRules </h2>
|
|
<p></p>
|
|
<p class='searchable'>Modify rule data.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesQemuFirewallRules [[-PveTicket] <PveTicket>] [[-Action] <String>] [[-Comment] <String>] [[-Delete] <String>] [[-Dest] <String>] [[-Digest] <String>] [[-Dport] <String>] [[-Enable] <Int32>] [[-IcmpType] <String>] [[-Iface] <String>] [[-Log] <String>] [[-Macro] <String>] [[-Moveto] <Int32>] [-Node] <String> [[-Pos] <Int32>] [[-Proto] <String>] [[-Source] <String>] [[-Sport] <String>] [[-Type] <String>] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Action</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Descriptive comment.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Dport</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Enable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Flag to enable/disable a rule.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-IcmpType</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Iface</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Log</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Log level for firewall rule. Enum: emerg,alert,crit,err,warning,notice,info,debug,nolog</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Macro</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Use predefined standard macro.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Moveto</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Move rule to new position <moveto>. Other arguments are ignored.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pos</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Update rule at position <pos>.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Proto</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Source</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Sport</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+':'\d+', for example '80':'85', and you can use comma separated list to match several ports or ranges.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Type</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Rule type. Enum: in,out,group</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesQemuResize" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesQemuResize </h2>
|
|
<p></p>
|
|
<p class='searchable'>Extend volume size.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesQemuResize [[-PveTicket] <PveTicket>] [[-Digest] <String>] [-Disk] <String> [-Node] <String> [-Size] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Disk</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The disk you want to resize. Enum: ide0,ide1,ide2,ide3,scsi0,scsi1,scsi2,scsi3,scsi4,scsi5,scsi6,scsi7,scsi8,scsi9,scsi10,scsi11,scsi12,scsi13,scsi14,scsi15,scsi16,scsi17,scsi18,scsi19,scsi20,scsi21,scsi22,scsi23,scsi24,scsi25,scsi26,scsi27,scsi28,scsi29,scsi30,virtio0,virtio1,virtio2,virtio3,virtio4,virtio5,virtio6,virtio7,virtio8,virtio9,virtio10,virtio11,virtio12,virtio13,virtio14,virtio15,sata0,sata1,sata2,sata3,sata4,sata5,efidisk0,tpmstate0</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Size</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The new size. With the `+` sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Skiplock</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ignore locks - only root is allowed to use this option.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesQemuSendkey" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesQemuSendkey </h2>
|
|
<p></p>
|
|
<p class='searchable'>Send key event to virtual machine.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesQemuSendkey [[-PveTicket] <PveTicket>] [-Key] <String> [-Node] <String> [-Skiplock] [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Key</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The key (qemu monitor encoding).</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Skiplock</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ignore locks - only root is allowed to use this option.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesQemuSnapshotConfig" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesQemuSnapshotConfig </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update snapshot metadata.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesQemuSnapshotConfig [[-PveTicket] <PveTicket>] [[-Description] <String>] [-Node] <String> [-Snapname] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Description</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A textual description or comment.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Snapname</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the snapshot.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesQemuUnlink" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesQemuUnlink </h2>
|
|
<p></p>
|
|
<p class='searchable'>Unlink/delete disk images.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesQemuUnlink [[-PveTicket] <PveTicket>] [-Force] [-Idlist] <String> [-Node] <String> [-Vmid] <Int32> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Force</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused\[n]', which contains the volume ID. Unlink of unused\[n] always cause physical removal.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Idlist</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of disk IDs you want to delete.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vmid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesStorageContent" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesStorageContent </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update volume attributes</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesStorageContent [[-PveTicket] <PveTicket>] [-Node] <String> [[-Notes] <String>] [-Protected] [[-Storage] <String>] [-Volume] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Notes</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The new notes.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Protected</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Protection status. Currently only supported for backups.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Volume</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Volume identifier</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesSubscription" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesSubscription </h2>
|
|
<p></p>
|
|
<p class='searchable'>Set subscription key.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesSubscription [[-PveTicket] <PveTicket>] [-Key] <String> [-Node] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Key</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Proxmox VE subscription key</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveNodesTime" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveNodesTime </h2>
|
|
<p></p>
|
|
<p class='searchable'>Set time zone.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveNodesTime [[-PveTicket] <PveTicket>] [-Node] <String> [-Timezone] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Node</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The cluster node name.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Timezone</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Time zone. The file '/usr/share/zoneinfo/zone.tab' contains the list of valid names.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PvePools" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PvePools </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update pool.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PvePools [[-PveTicket] <PveTicket>] [-AllowMove] [[-Comment] <String>] [-Delete] [-Poolid] <String> [[-Storage] <String>] [[-Vms] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-AllowMove</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Allow adding a guest even if already in another pool. The guest will be removed from its current pool and added to this one.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Remove the passed VMIDs and/or storage IDs instead of adding them.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Poolid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of storage IDs to add or remove from this pool.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vms</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of guest VMIDs to add or remove from this pool.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PvePoolsIdx" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PvePoolsIdx </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update pool data (deprecated, no support for nested pools - use 'PUT /pools/?poolid={poolid}' instead).</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PvePoolsIdx [[-PveTicket] <PveTicket>] [-AllowMove] [[-Comment] <String>] [-Delete] [-Poolid] <String> [[-Storage] <String>] [[-Vms] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-AllowMove</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Allow adding a guest even if already in another pool. The guest will be removed from its current pool and added to this one.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Comment</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Remove the passed VMIDs and/or storage IDs instead of adding them.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Poolid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>--</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of storage IDs to add or remove from this pool.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vms</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of guest VMIDs to add or remove from this pool.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Set-PveStorage" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Set-PveStorage </h2>
|
|
<p></p>
|
|
<p class='searchable'>Update storage configuration.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Set-PveStorage [[-PveTicket] <PveTicket>] [[-Blocksize] <String>] [[-Bwlimit] <String>] [[-ComstarHg] <String>] [[-ComstarTg] <String>] [[-Content] <String>] [[-ContentDirs] <String>] [-CreateBasePath] [-CreateSubdirs] [[-DataPool] <String>] [[-Delete] <String>] [[-Digest] <String>] [-Disable] [[-Domain] <String>] [[-EncryptionKey] <String>] [[-Fingerprint] <String>] [[-Format] <String>] [[-FsName] <String>] [-Fuse] [[-IsMountpoint] <String>] [[-Keyring] <String>] [-Krbd] [[-LioTpg] <String>] [[-MasterPubkey] <String>] [[-MaxProtectedBackups] <Int32>] [[-Maxfiles] <Int32>] [-Mkdir] [[-Monhost] <String>] [[-Mountpoint] <String>] [[-Namespace] <String>] [-Nocow] [[-Nodes] <String>] [-Nowritecache] [[-Options] <String>] [[-Password] <SecureString>] [[-Pool] <String>] [[-Port] <Int32>] [[-Preallocation] <String>] [[-PruneBackups] <String>] [-Saferemove] [[-SaferemoveThroughput] <String>] [[-Server] <String>] [[-Server2] <String>] [-Shared] [[-Smbversion] <String>] [-Sparse] [-Storage] <String> [[-Subdir] <String>] [-TaggedOnly] [[-Transport] <String>] [[-Username] <String>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Blocksize</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>block size</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Bwlimit</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set I/O bandwidth limit for various operations (in KiB/s).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ComstarHg</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>host group for comstar views</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ComstarTg</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>target group for comstar views</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Content</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Allowed content types.NOTE':' the value 'rootdir' is used for Containers, and value 'images' for VMs.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-ContentDirs</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Overrides for default content type directories.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-CreateBasePath</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Create the base directory if it doesn't exist.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-CreateSubdirs</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Populate the directory with the default structure.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-DataPool</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Data Pool (for erasure coding only)</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Delete</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>A list of settings you want to delete.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Digest</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Prevent changes if current configuration file has a different digest. This can be used to prevent concurrent modifications.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Disable</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Flag to disable the storage.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Domain</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>CIFS domain.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-EncryptionKey</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Encryption key. Use 'autogen' to generate one automatically without passphrase.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Fingerprint</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Certificate SHA 256 fingerprint.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Format</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Default image format.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-FsName</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The Ceph filesystem name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Fuse</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Mount CephFS through FUSE.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-IsMountpoint</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Keyring</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Client keyring contents (for external clusters).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Krbd</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Always access rbd through krbd kernel module.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-LioTpg</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>target portal group for Linux LIO targets</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MasterPubkey</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-MaxProtectedBackups</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Maximal number of protected backups per guest. Use '-1' for unlimited.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Maxfiles</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Deprecated':' use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mkdir</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Create the directory if it doesn't exist and populate it with default sub-dirs. NOTE':' Deprecated, use the 'create-base-path' and 'create-subdirs' options instead.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Monhost</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>IP addresses of monitors (for external clusters).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Mountpoint</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>mount point</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Namespace</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Namespace.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nocow</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Set the NOCOW flag on files. Disables data checksumming and causes data errors to be unrecoverable from while allowing direct I/O. Only use this if data does not need to be any more safe than on a single ext4 formatted disk with no underlying raid system.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nodes</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>List of cluster node names.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Nowritecache</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>disable write caching on the target</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Options</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs')</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Password</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Password for accessing the share/datastore.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Pool</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Pool.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Port</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>For non default port.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>0</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Preallocation</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off. Enum: off,metadata,falloc,full</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PruneBackups</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Saferemove</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Zero-out data when removing LVs.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-SaferemoveThroughput</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Wipe throughput (cstream -t parameter value).</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Server</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Server IP or DNS name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Server2</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Backup volfile server IP or DNS name.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Shared</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Mark storage as shared.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Smbversion</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>SMB protocol version. 'default' if not set, negotiates the highest SMB2+ version supported by both the client and server. Enum: default,2.0,2.1,3,3.0,3.11</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Sparse</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>use sparse volumes</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Storage</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The storage identifier.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Subdir</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Subdir to mount.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-TaggedOnly</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Only use logical volumes tagged with 'pve-vm-ID'.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'>False</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Transport</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Gluster transport':' tcp or rdma Enum: tcp,rdma,unix</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Username</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>RBD Id.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Start-PveVm" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Start-PveVm </h2>
|
|
<p></p>
|
|
<p class='searchable'>Start VM.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Start-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VmIdOrName</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID or Name of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Stop-PveVm" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Stop-PveVm </h2>
|
|
<p></p>
|
|
<p class='searchable'>Stop VM.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Stop-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VmIdOrName</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID or Name of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Suspend-PveVm" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Suspend-PveVm </h2>
|
|
<p></p>
|
|
<p class='searchable'>Suspend VM.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Suspend-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VmIdOrName</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID or Name of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Undo-PveVmSnapshot" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Undo-PveVmSnapshot </h2>
|
|
<p></p>
|
|
<p class='searchable'>Rollback VM state to specified snapshot.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Undo-PveVmSnapshot [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [-Snapname] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VmIdOrName</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID or Name of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Snapname</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The name of the snapshot.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="Unlock-PveVm" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Unlock-PveVm </h2>
|
|
<p></p>
|
|
<p class='searchable'>Unlock VM.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Unlock-PveVm [[-PveTicket] <PveTicket>] [-VmIdOrName] <String> [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VmIdOrName</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>The (unique) ID or Name of the VM.</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>PveResponse. Return response.</li></ul>
|
|
</div>
|
|
</div>
|
|
<div id="VmCheckIdOrName" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> VmCheckIdOrName </h2>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Vm</nobr></td>
|
|
<td class='visible-lg visible-md searchable'>None</td>
|
|
<td class='searchable'></td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>false</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-VmIdOrName</nobr></td>
|
|
<td class='visible-lg visible-md searchable'>None</td>
|
|
<td class='searchable'></td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>false</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div id="Wait-PveTaskIsFinish" class="toggle_container">
|
|
<div class="page-header">
|
|
<h2> Wait-PveTaskIsFinish </h2>
|
|
<p></p>
|
|
<p class='searchable'>Get task is running.</p>
|
|
</div>
|
|
<div>
|
|
<h3> Syntax </h3>
|
|
</div>
|
|
<div class='panel panel-default'>
|
|
<div class='panel-body'>
|
|
<code class='powershell'>Wait-PveTaskIsFinish [[-PveTicket] <PveTicket>] [-Upid] <String> [[-Wait] <Int32>] [[-Timeout] <Int32>] [<CommonParameters>]</code>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h3> Parameters </h3>
|
|
<table class="table table-striped table-bordered table-condensed visible-on">
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th class="visible-lg visible-md">Alias</th>
|
|
<th>Description</th>
|
|
<th class="visible-lg visible-md">Required?</th>
|
|
<th class="visible-lg">Pipeline Input</th>
|
|
<th class="visible-lg">Default Value</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td class='searchable'><nobr>-PveTicket</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Ticket data connection.</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Upid</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Upid task e.g UPID:pve1:00004A1A:0964214C:5EECEF11:vzdump:134:root@pam:</td>
|
|
<td class='visible-lg visible-md'>true</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'></td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Wait</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Millisecond wait next check</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'>500</td>
|
|
</tr>
|
|
<tr>
|
|
<td class='searchable'><nobr>-Timeout</nobr></td>
|
|
<td class='visible-lg visible-md searchable'></td>
|
|
<td class='searchable'>Millisecond timeout</td>
|
|
<td class='visible-lg visible-md'>false</td>
|
|
<td class='visible-lg'>true (ByValue, ByPropertyName)</td>
|
|
<td class='visible-lg'>10000</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div>
|
|
<h3> Outputs </h3>
|
|
<p>The output type is the type of the objects that the cmdlet emits.</p>
|
|
<ul><li>Bool. Return tas is running.</li></ul>
|
|
</div>
|
|
</div>
|
|
</main>
|
|
</div>
|
|
|
|
<div class='fixed-bottom text-white bg-dark'>
|
|
<a href='https://github.com/Corsinvest/cv4pve-api-powershell' target='_blank'>cv4pve-api-powershell</a> - Proxmox VE Client API PowerShell Module by Corsinvest Srl <br>
|
|
This is a part of suite <a href='https://www.corsinvest.it/cv4pve' target='_blank'>cv4pve</a>
|
|
- Version 8.1.2
|
|
</div>
|
|
</div>
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/bootstrap@5.2.3/dist/js/bootstrap.min.js"
|
|
integrity="sha384-cuYeSxntonz0PPNlHhBs68uyIAVpIIOZZ5JqeqvYYIcEL727kskC66kF92t6Xl2V"
|
|
crossorigin="anonymous"></script>
|
|
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/languages/powershell.min.js"></script>
|
|
|
|
<script src="https://code.jquery.com/jquery-3.7.0.slim.min.js"
|
|
integrity="sha256-tG5mcZUtJsZvyKAxYLVXrmjKBVLd6VpVccqz/r4ypFE="
|
|
crossorigin="anonymous"></script>
|
|
|
|
<script>
|
|
document.addEventListener('DOMContentLoaded', (event) => {
|
|
hljs.highlightAll();
|
|
|
|
$('.toggle_container').hide();
|
|
$('#GettingStarted').toggle('fast');
|
|
$('#main-data').removeClass('main-data-hidden');
|
|
});
|
|
|
|
$(document).ready(function () {
|
|
$('#navSearch').on('keyup', function () {
|
|
var value = $(this).val().toLowerCase();
|
|
$('#lstNav li').filter(function () {
|
|
$(this).toggle(value.length == 0
|
|
? true
|
|
: $(this).text().toLowerCase().indexOf(value) > -1)
|
|
});
|
|
|
|
if ($('#searchAll:checked').val() == 'on') {
|
|
$('.searchable').filter(function () {
|
|
if(value.length > 0) {
|
|
if ($(this).text().toLowerCase().indexOf(value) > -1) {
|
|
var id = $(this).parents().closest(".toggle_container")[0].id;
|
|
$($($('a[href="#' + id + '"]')[0]).parent()[0]).toggle(true)
|
|
}
|
|
}
|
|
});
|
|
}
|
|
});
|
|
|
|
$('.nav-item a').click(function () {
|
|
$('.toggle_container').hide();
|
|
var elem = $(this).prop('hash');
|
|
$(elem).toggle('fast');
|
|
window.scrollTo(0, 0);
|
|
});
|
|
});
|
|
</script>
|
|
</body>
|
|
</html>
|