Parallels RAS PowerShell API
  • Parallels RAS PowerShell
  • Getting Started
  • Parallels RAS Powershell Admin Module
    • Commands
      • Add-RASAppPackageAssigned
      • Add-RASAutoUpgradeMessage
      • Add-RASAVDHostPoolAssignment
      • Add-RASClientPolicyConnection
      • Add-RASCriteriaDevice
      • Add-RASCriteriaGatewayIP
      • Add-RASCriteriaHardwareID
      • Add-RASCriteriaIP
      • Add-RASCriteriaSecurityPrincipal
      • Add-RASCriteriaTheme
      • Add-RASExcludeADGroup
      • Add-RASFSLogixCCDLocation
      • Add-RASFSLogixFolder
      • Add-RASFSLogixUser
      • Add-RASFSLogixVHDLocation
      • Add-RASHALBDevice
      • Add-RASImageOptimizationRegistry
      • Add-RASImageOptimizationWindowsComponent
      • Add-RASImageOptimizationWindowsScheduledTask
      • Add-RASImageOptimizationWindowsService
      • Add-RASMFARadiusAttr
      • Add-RASMFARadiusAuto
      • Add-RASMFAUsers
      • Add-RASPrintingAutoInstallFont
      • Add-RASProviderAdminCredentials
      • Add-RASProviderRemotePCStatic
      • Add-RASPubAppFileExt
      • Add-RASPubItemPreferredRoute
      • Add-RASPubRDSAppServerAttr
      • Add-RASRule
      • Add-RASScheduleMessage
      • Add-RASScheduleTarget
      • Add-RASTemplateLicenseKey
      • Add-RASThemeCustomImage
      • Add-RASThemeFooterURL
      • Add-RASThemeGroupFilter
      • Add-RASURLRedirectionEntry
      • Add-RASVDIHostPoolMember
      • Add-RASWinDeviceGroupInboundPort
      • Copy-RASPubItem
      • Find-RASMFAUsers
      • Get-RASADIntegrationSettings
      • Get-RASAdminAccount
      • Get-RASAdminSession
      • Get-RASAgent
      • Get-RASAgentDiagnostic
      • Get-RASAllowedDevicesSetting
      • Get-RASAppPackage
      • Get-RASAppPackageAssigned
      • Get-RASAppPackageAvailVersions
      • Get-RASAppPackageSettings
      • Get-RASAuthSettings
      • Get-RASAutoUpgrade
      • Get-RASAutoUpgradeMessage
      • Get-RASAVDCustomHost
      • Get-RASAVDDefaultSettings
      • Get-RASAVDGallery
      • Get-RASAVDGalleryImage
      • Get-RASAVDHost
      • Get-RASAVDHostPool
      • Get-RASAVDHostPoolAssignment
      • Get-RASAVDHostPoolStatus
      • Get-RASAVDHostStatus
      • Get-RASAVDLocation
      • Get-RASAVDOffer
      • Get-RASAVDPredefinedImages
      • Get-RASAVDPublisher
      • Get-RASAVDResourceGroup
      • Get-RASAVDSettings
      • Get-RASAVDSKU
      • Get-RASAVDVersion
      • Get-RASAVDVirtualNetwork
      • Get-RASAVDVMSize
      • Get-RASAVDWorkspace
      • Get-RASAVDWorkspaceStatus
      • Get-RASBroker
      • Get-RASBrokerAutoPromotionSettings
      • Get-RASBrokerStatus
      • Get-RASCertificate
      • Get-RASClientPolicy
      • Get-RASClientPolicyAssignment
      • Get-RASClientPolicyConnection
      • Get-RASClientSettings
      • Get-RASCPUOptimizationSettings
      • Get-RASCriteria
      • Get-RASCriteriaDevice
      • Get-RASCriteriaGatewayIP
      • Get-RASCriteriaHardwareID
      • Get-RASCriteriaIP
      • Get-RASCriteriaOS
      • Get-RASCriteriaSecurityPrincipal
      • Get-RASCriteriaTheme
      • Get-RASCurrentAdminPermissions
      • Get-RASCustomPermission
      • Get-RASCustomRoute
      • Get-RASDayPlan
      • Get-RASEnrollmentServer
      • Get-RASEnrollmentServerStatus
      • Get-RASExcludeADGroup
      • Get-RASFarmSettings
      • Get-RASFSLogix
      • Get-RASFSLogixCCDLocation
      • Get-RASFSLogixFolder
      • Get-RASFSLogixSettings
      • Get-RASFSLogixUser
      • Get-RASFSLogixVHDLocation
      • Get-RASGateway
      • Get-RASGatewayDefaultSettings
      • Get-RASGatewayStatus
      • Get-RASHALB
      • Get-RASHALBDevice
      • Get-RASHALBStatus
      • Get-RASHelpdeskEmailSettings
      • Get-RASImageOptimization
      • Get-RASImageOptimizationPredefined
      • Get-RASImageOptimizationRegistry
      • Get-RASImageOptimizationWindowsComponent
      • Get-RASImageOptimizationWindowsScheduledTask
      • Get-RASImageOptimizationWindowsService
      • Get-RASInvitationEmailSettings
      • Get-RASJoinedBrokerStatus
      • Get-RASLBSettings
      • Get-RASLetsEncryptEULA
      • Get-RASLetsEncryptSettings
      • Get-RASLicenseDetails
      • Get-RASLogonHours
      • Get-RASMailboxSettings
      • Get-RASMFA
      • Get-RASMFACriteria
      • Get-RASMFADefaultSettings
      • Get-RASMFARadiusAttr
      • Get-RASMFARadiusAuto
      • Get-RASMSIXImageDetails
      • Get-RASNotification
      • Get-RASNotificationEvent
      • Get-RASNotificationResource
      • Get-RASNotificationScript
      • Get-RASOverwriteSupportActions
      • Get-RASPerformanceMonitorSettings
      • Get-RASPowerPermission
      • Get-RASPrintingAutoInstallFont
      • Get-RASPrintingSettings
      • Get-RASProvider
      • Get-RASProviderAdminCredentials
      • Get-RASProviderRemotePCStatic
      • Get-RASProviderStatus
      • Get-RASProxySettings
      • Get-RASPubAppFileExt
      • Get-RASPubAVDApp
      • Get-RASPubAVDDesktop
      • Get-RASPubDefaultSettings
      • Get-RASPubFolder
      • Get-RASPubItem
      • Get-RASPubItemFilter
      • Get-RASPubItemIcon
      • Get-RASPubItemPreferredRoute
      • Get-RASPubItemStatus
      • Get-RASPubRDSApp
      • Get-RASPubRDSAppServerAttr
      • Get-RASPubRDSDesktop
      • Get-RASPubVDIApp
      • Get-RASPubVDIDesktop
      • Get-RASRDSDefaultSettings
      • Get-RASRDSession
      • Get-RASRDSHost
      • Get-RASRDSHostPool
      • Get-RASRDSHostPoolMember
      • Get-RASRDSHostPoolStatus
      • Get-RASRDSHostStatus
      • Get-RASReportingSettings
      • Get-RASRule
      • Get-RASSAMLIDP
      • Get-RASScanningSettings
      • Get-RASSchedule
      • Get-RASScheduleMessage
      • Get-RASScheduleTarget
      • Get-RASSessionSetting
      • Get-RASSite
      • Get-RASSiteStatus
      • Get-RASSystemSettings
      • Get-RASTemplate
      • Get-RASTemplateLicenseKey
      • Get-RASTemplateStatus
      • Get-RASTemplateVersion
      • Get-RASTemplateVersionStatus
      • Get-RASTenant
      • Get-RASTenantBrokerSettings
      • Get-RASTheme
      • Get-RASThemeCustomImage
      • Get-RASThemeFooterURL
      • Get-RASThemeGroupFilter
      • Get-RASThemeImage
      • Get-RASTrustedDomain
      • Get-RASURLRedirectionEntry
      • Get-RASURLRedirectionSettings
      • Get-RASVDIDefaultSettings
      • Get-RASVDIHost
      • Get-RASVDIHostPool
      • Get-RASVDIHostPoolMember
      • Get-RASVDIHostPoolStatus
      • Get-RASVDIHostStatus
      • Get-RASVDIPersistentHost
      • Get-RASVersion
      • Get-RASVM
      • Get-RASWinDeviceGroup
      • Get-RASWinDeviceGroupInboundPort
      • Parallels RAS PowerShell
      • Invoke-RASADIntegrationSettings
      • Invoke-RASAdminSessionCmd
      • Invoke-RASApply
      • Invoke-RASAppPackageAssigned
      • Invoke-RASAVDHost
      • Invoke-RASBrokerPromoteToPrimary
      • Invoke-RASCertificateCmd
      • Invoke-RASCheckForUpdate
      • Invoke-RASClearAgentLogs
      • Invoke-RASClearSessionsIDCache
      • Invoke-RASClientPolicy
      • Invoke-RASExportCertificate
      • Invoke-RASExportSettings
      • Invoke-RASHostPool
      • Invoke-RASImportProviderRemotePCStatic
      • Invoke-RASImportSettings
      • Invoke-RASLicenseActivate
      • Invoke-RASLicenseDeactivate
      • Invoke-RASMFA
      • Invoke-RASPerformanceMonitor
      • Invoke-RASProviderCheckCredentials
      • Invoke-RASPubItemCmd
      • Invoke-RASRDSHostCmd
      • Invoke-RASRDSHostPoolCmd
      • Invoke-RASRDSHostProcessCmd
      • Invoke-RASRDSHostSessionCmd
      • Invoke-RASRepair
      • Invoke-RASRetrieveAgentLogs
      • Invoke-RASRetryLastAction
      • Invoke-RASSAMLIDP
      • Invoke-RASSitePromoteToLicensing
      • Invoke-RASStopOptimization
      • Invoke-RASTemplate
      • Invoke-RASTenant
      • Invoke-RASTenantBroker
      • Invoke-RASTenantBrokerSettings
      • Invoke-RASTestDetectClientIP
      • Invoke-RASVDIHost
      • Invoke-RASVDIProcessCmd
      • Invoke-RASVDISessionCmd
      • Move-RASPubItem
      • Move-RASRDSHostPoolMember
      • New-RASAdminAccount
      • New-RASAppPackage
      • New-RASAVDHost
      • New-RASAVDHostPool
      • New-RASAVDResourceGroup
      • New-RASAVDWorkspace
      • New-RASBroker
      • New-RASCertificate
      • New-RASClientPolicy
      • New-RASCustomRoute
      • New-RASEnrollmentServer
      • New-RASFarm
      • New-RASGateway
      • New-RASHALB
      • New-RASLogonHours
      • New-RASMFA
      • New-RASNotificationEvent
      • New-RASNotificationResource
      • New-RASNotificationScript
      • New-RASProvider
      • New-RASPubAVDApp
      • New-RASPubAVDDesktop
      • New-RASPubFolder
      • New-RASPubRDSApp
      • New-RASPubRDSDesktop
      • New-RASPubVDIApp
      • New-RASPubVDIDesktop
      • New-RASRDSHost
      • New-RASRDSHostPool
      • New-RASSAMLIDP
      • New-RASSchedule
      • New-RASSession
      • New-RASSite
      • New-RASTemplate
      • New-RASTenant
      • New-RASTheme
      • New-RASVDIHostPool
      • New-RASWinDeviceGroup
      • Remove-RASAdminAccount
      • Remove-RASAgent
      • Remove-RASAppPackage
      • Remove-RASAppPackageAssigned
      • Remove-RASAutoUpgradeMessage
      • Remove-RASAVDHost
      • Remove-RASAVDHostPool
      • Remove-RASAVDHostPoolAssignment
      • Remove-RASAVDWorkspace
      • Remove-RASBroker
      • Remove-RASCertificate
      • Remove-RASClientPolicy
      • Remove-RASClientPolicyConnection
      • Remove-RASCriteriaDevice
      • Remove-RASCriteriaGatewayIP
      • Remove-RASCriteriaHardwareID
      • Remove-RASCriteriaIP
      • Remove-RASCriteriaSecurityPrincipal
      • Remove-RASCriteriaTheme
      • Remove-RASCustomRoute
      • Remove-RASEnrollmentServer
      • Remove-RASExcludeADGroup
      • Remove-RASFarm
      • Remove-RASFSLogixCCDLocation
      • Remove-RASFSLogixFolder
      • Remove-RASFSLogixUser
      • Remove-RASFSLogixVHDLocation
      • Remove-RASGateway
      • Remove-RASHALB
      • Remove-RASHALBDevice
      • Remove-RASImageOptimizationRegistry
      • Remove-RASImageOptimizationWindowsComponent
      • Remove-RASImageOptimizationWindowsScheduledTask
      • Remove-RASImageOptimizationWindowsService
      • Remove-RASLogonHours
      • Remove-RASMFA
      • Remove-RASMFARadiusAttr
      • Remove-RASMFARadiusAuto
      • Remove-RASNotification
      • Remove-RASNotificationEvent
      • Remove-RASNotificationResource
      • Remove-RASNotificationScript
      • Remove-RASPrintingAutoInstallFont
      • Remove-RASProvider
      • Remove-RASProviderAdminCredentials
      • Remove-RASProviderRemotePCStatic
      • Remove-RASPubAppFileExt
      • Remove-RASPubAVDApp
      • Remove-RASPubAVDDesktop
      • Remove-RASPubFolder
      • Remove-RASPubItem
      • Remove-RASPubItemPreferredRoute
      • Remove-RASPubRDSApp
      • Remove-RASPubRDSAppServerAttr
      • Remove-RASPubRDSDesktop
      • Remove-RASPubVDIApp
      • Remove-RASPubVDIDesktop
      • Remove-RASRDSHost
      • Remove-RASRDSHostPool
      • Remove-RASRule
      • Remove-RASSAMLIDP
      • Remove-RASSchedule
      • Remove-RASScheduleMessage
      • Remove-RASScheduleTarget
      • Remove-RASSession
      • Remove-RASSite
      • Remove-RASTemplate
      • Remove-RASTemplateLicenseKey
      • Remove-RASTemplateVersion
      • Remove-RASTenant
      • Remove-RASTheme
      • Remove-RASThemeCustomImage
      • Remove-RASThemeFooterURL
      • Remove-RASThemeGroupFilter
      • Remove-RASURLRedirectionEntry
      • Remove-RASVDIHost
      • Remove-RASVDIHostPool
      • Remove-RASVDIHostPoolMember
      • Remove-RASVDIPersistentHost
      • Remove-RASWinDeviceGroup
      • Remove-RASWinDeviceGroupInboundPort
      • Reset-RASMFAUsers
      • Reset-RASVM
      • Restart-RASVM
      • Send-RASInvitationEmail
      • Send-RASSupportRequest
      • Send-RASTestEmail
      • Set-RASADIntegrationSettings
      • Set-RASAdminAccount
      • Set-RASAgentLogLevel
      • Set-RASAllowedDevicesSetting
      • Set-RASAppPackage
      • Set-RASAppPackageAssigned
      • Set-RASAppPackageSettings
      • Set-RASAppPackageSettingsTags
      • Set-RASAuthSettings
      • Set-RASAutoUpgrade
      • Set-RASAutoUpgradeMessage
      • Set-RASAVDDefaultSettings
      • Set-RASAVDHostPool
      • Set-RASAVDSettings
      • Set-RASAVDWorkspace
      • Set-RASBroker
      • Set-RASBrokerAutoPromotionSettings
      • Set-RASBrokerPriority
      • Set-RASCertificate
      • Set-RASClientPolicy
      • Set-RASClientPolicyAssignment
      • Set-RASClientPolicyOrder
      • Set-RASClientSettings
      • Set-RASCPUOptimizationSettings
      • Set-RASCriteria
      • Set-RASCriteriaOS
      • Set-RASCustomPermission
      • Set-RASCustomRoute
      • Set-RASDayPlan
      • Set-RASEnrollmentServer
      • Set-RASFarmSettings
      • Set-RASFSLogix
      • Set-RASFSLogixFolderExclusion
      • Set-RASFSLogixSettings
      • Set-RASGateway
      • Set-RASGatewayDefaultSettings
      • Set-RASHALB
      • Set-RASHALBDevicePriority
      • Set-RASHelpdeskEmailSettings
      • Set-RASImageOptimization
      • Set-RASInvitationEmailSettings
      • Set-RASLBSettings
      • Set-RASLetsEncryptSettings
      • Set-RASLogonHours
      • Set-RASLogonHoursOrder
      • Set-RASMailboxSettings
      • Set-RASMFA
      • Set-RASMFARadiusAuto
      • Set-RASNotificationEvent
      • Set-RASNotificationResource
      • Set-RASNotificationScript
      • Set-RASOverwriteSupportActions
      • Set-RASPerformanceMonitorSettings
      • Set-RASPowerPermission
      • Set-RASPrintingSettings
      • Set-RASProvider
      • Set-RASProviderAdminCredentials
      • Set-RASProviderRemotePCStatic
      • Set-RASProxySettings
      • Set-RASPubAppFileExt
      • Set-RASPubAVDApp
      • Set-RASPubAVDDesktop
      • Set-RASPubDefaultSettings
      • Set-RASPubFolder
      • Set-RASPubItem
      • Set-RASPubItemFilter
      • Set-RASPubItemPreferredRoute
      • Set-RASPubRDSApp
      • Set-RASPubRDSAppServerAttr
      • Set-RASPubRDSDesktop
      • Set-RASPubVDIApp
      • Set-RASPubVDIDesktop
      • Set-RASRDSDefaultSettings
      • Set-RASRDSHost
      • Set-RASRDSHostPool
      • Set-RASReportingSettings
      • Set-RASRule
      • Set-RASSAMLIDP
      • Set-RASScanningSettings
      • Set-RASSchedule
      • Set-RASScheduleMessage
      • Set-RASSessionSetting
      • Set-RASSite
      • Set-RASSystemSettings
      • Set-RASTemplate
      • Set-RASTemplateVersion
      • Set-RASTenant
      • Set-RASTenantBrokerSettings
      • Set-RASTheme
      • Set-RASThemeCustomImage
      • Set-RASURLRedirectionEntry
      • Set-RASURLRedirectionSettings
      • Set-RASVDIDefaultSettings
      • Set-RASVDIHostPool
      • Set-RASVDIPersistentHost
      • Set-RASWinDeviceGroup
      • Start-RASVM
      • Stop-RASVM
      • Suspend-RASVM
      • Update-RASAgent
    • Classes and enumerations
      • AccelerationMode
      • AcceptedSSLVersion
      • AccessType
      • AcmeCommand
      • AcmeRevokeReason
      • ActionSettings
      • ActionType
      • ADIntegrationSettings
      • AdminAccount
      • AdminCredential
      • AdminNotify
      • AdminSession
      • AdminType
      • ADType
      • AdvancedSettings
      • AgentSettings
      • AgentState
      • AllocationType
      • AllowClientMode
      • AllowedIPsCriteria
      • AllowedOperatingSystems
      • AllowMultiMonitor
      • AllowURLAndMailRedirection
      • Appearance
      • AppPackage
      • AppPackageAssigned
      • AppPackageAssignedObjType
      • AppPackageCertificate
      • AppPackageRegistrationStatus
      • AppPackagesAssigned
      • AppPackageSettings
      • AppPackageStatus
      • AppPackageVersion
      • AppServicesSettings
      • AppVersionTag
      • Assignment
      • AssignmentType
      • AttributeType
      • Audio
      • AudioMode
      • AudioQuality
      • AuthenticationTypes
      • AuthType
      • AutoScale
      • AutoUpgradeSettings
      • AVDBrokenReason
      • AVDCommand
      • AVDCustomHost
      • AVDDefaultSettings
      • AVDDefObjType
      • AVDFeaturesSettings
      • AVDGallery
      • AVDGalleryImage
      • AVDHost
      • AVDHostPool
      • AVDHostPoolStatus
      • AVDHostSysInfo
      • AVDHostSysSessionApp
      • AVDLicenseType
      • AVDLocation
      • AVDMarketplaceVersion
      • AVDMultimediaRedirection
      • AVDOffer
      • AVDPredefinedVMImage
      • AVDProvider
      • AVDProvisioningSettings
      • AVDPublisher
      • AVDResourceGroup
      • AVDSessionApp
      • AVDSKU
      • AVDSubnet
      • AVDVersion
      • AVDVirtualNetwork
      • AVDVMSize
      • AVDWorkspace
      • AVDWorkspaceStatus
      • AWSEC2Provider
      • AWSEC2Version
      • AzureProvider
      • AzureVersion
      • BaseProvisioningSettings
      • BinaryChoice
      • Broker
      • BrokerAgentDiagnostic
      • BrokerAutoPromotion
      • BrokerDiagnosticState
      • BrokerSysInfo
      • Browser
      • Certificate
      • CertificateKeySize
      • CertificateStatus
      • CertificateType
      • CertificateUsages
      • CheckForUpdate
      • CipherStrength
      • ClientDeviceCriteriaEntry
      • ClientFeatureSetType
      • ClientOptions
      • ClientOptionsAdvancedSettings
      • ClientOptionsPrinting
      • ClientPolicy
      • ClientPolicyAllowedOperatingSystems
      • ClientPolicyAssignment
      • ClientPolicyCriteria
      • ClientPolicyInputMethod
      • ClientPolicyRule
      • ClientPrinterPreference
      • ClientRules
      • Clipboard
      • ClipboardDirections
      • CloneMethod
      • CloudCacheGeneralSettings
      • CloudCacheSettings
      • ColorDepth
      • Colors
      • Compression
      • CompressionType
      • ComputerName
      • Configuration
      • Connection
      • ConnectionAdvancedSettings
      • ConnectionBannerType
      • ConnectionBar
      • ConnectionMode
      • Connections
      • ConnMode
      • ContainerAdvancedSettings
      • ContainerSettings
      • ControlSettings
      • CPUOptimizationSettings
      • Credentials
      • CriteriaDefObjType
      • CriteriaObjType
      • CurrentAdminPermissions
      • CustomerExperienceProgram
      • CustomMenu
      • CustomPermission
      • CustomRoute
      • CustomScript
      • CustomWorkAreaImageFit
      • CustomWorkAreaImageType
      • DayPlanObjType
      • DeepnetAuthMode
      • DefaultAssignmentType
      • DefaultPowerState
      • DefaultPrintingSettings
      • DesktopOptions
      • DesktopSize
      • DetailsType
      • DetectClientMode
      • Devices
      • DevicesCriteria
      • DiagnosticState
      • DiskCleanup
      • DiskDrives
      • DiskType
      • DisplayConfig
      • DistributionState
      • DragAndDropModeValue
      • DriveCacheMode
      • DummyVersion
      • EC2LocationType
      • EmailSupportRequest
      • EnableState
      • EnrollmentServer
      • EnrollmentServerAgentDiagnostic
      • EnrollmentServerStatus
      • ExcludeADGroupEntry
      • ExcludeADGroupsSettings
      • ExcludeCommonFolders
      • ExcludeFolderCopy
      • ExternalEmailStorage
      • FarmMode
      • FileTransfer
      • FileTransferControlMode
      • FIPSMode
      • FIPSModeSett
      • FolderExclusion
      • FooterURL
      • FSLogixFeaturesSettings
      • FSLogixGeneralSettings
      • FSLogixListType
      • FSLogixLogEnabled
      • FSLogixLoggingSettings
      • FSLogixLogLevel
      • FSLogixReasonCode
      • FSLogixServerObjType
      • FSLogixSettings
      • FSLogixStatusCode
      • Gateway
      • GatewayAgentDiagnostic
      • GatewayCriteriaEntry
      • GatewayDefaultSiteSettings
      • GatewayMode
      • GatewayRuleType
      • GatewaysCriteria
      • GatewaySecurityMode
      • GatewaySysInfo
      • GlobalPermission
      • GlobalPermissions
      • GlobalPolicy
      • GroupFilter
      • GuestAgentDiagnostic
      • GuestAgentInfo
      • HALBClientManagerConfigSettings
      • HALBDevice
      • HALBDeviceAgentDiagnostic
      • HALBDeviceStatus
      • HALBGatewayConfigSettings
      • HALBSettings
      • HALBSSLConfigSettings
      • HALBVirtualServerStatus
      • HAMode
      • HardwareIDCriteriaEntry
      • HardwareIDsCriteria
      • HeaderOptions
      • HighAvailabilityState
      • HiveType
      • HostAssignmentType
      • HostPoolAgentSettings
      • HostPoolCmd
      • HostPoolObjType
      • HostPowerState
      • HostSessionType
      • HourPlan
      • HyperVClusterProvider
      • HyperVFailoverClusterVersion
      • HyperVProvider
      • HyperVVersion
      • IconFormat
      • IconSizes
      • IfAuthenticationFail
      • IgnoreNonAVD
      • ImageFormatType
      • ImageOptimization
      • ImageOptimizationWindowsScheduledTask
      • ImagePrepTool
      • ImageType
      • ImportExport
      • Parallels RAS PowerShell
      • InputPrompt
      • InstallType
      • InvitationEmailSettings
      • InviteAuthType
      • InviteConnMode
      • InviteTargetDev
      • IP4Range
      • IP6Range
      • IPsCriteria
      • IPv4CriteriaEntry
      • IPv6CriteriaEntry
      • IPVersion
      • IRemoteSettings
      • JoinedBrokerStatus
      • JoinStatus
      • Keyboard
      • KeyboardLayout
      • KeyboardType
      • Language
      • LanguageBar
      • LanguageInputPrompt
      • Languages
      • LanguageType
      • LaunchMethod
      • LaunchSession
      • LBMethod
      • LBSettings
      • LegalPolicies
      • LetsEncryptSettings
      • License
      • LicenseKeyType
      • LicenseType
      • LimitClipboardToTextOnlyMode
      • LimitNotify
      • LoadBalancerType
      • LoadBalancingAlgorithm
      • LoadBalancingSSLMode
      • LocalProxyAddress
      • LocationType
      • Logging
      • LogLevelsType
      • LogonHours
      • LogonHoursCriteria
      • LogonStatus
      • LogSpecificComponents
      • MACAddressManagement
      • MACRuleType
      • MailboxTLS
      • MainAuthenticationMode
      • MaintenanceMessages
      • ManageRDPTransportProtocol
      • MatchingModeType
      • MembersSettings
      • MFA
      • MFACriteria
      • MFADeepnet
      • MFADefaultSiteSettings
      • MFAEmailOTP
      • MFARadius
      • MFARadiusAttr
      • MFARadiusAutoInfo
      • MFASafenet
      • MFATOTP
      • MFAType
      • MFAUsersType
      • MirrorLocalOSTToVHD
      • Mode
      • MoveDirection
      • MultiFactorAuthentication
      • MultiMonitor
      • Network
      • NetworkPerformance
      • NetworkType
      • Notification
      • NotificationEvent
      • NotificationEventCriteria
      • NotificationResource
      • NotificationScript
      • NotificationType
      • NutanixProvider
      • NutanixVersion
      • ObjectPermission
      • OfficeContainerAdvancedSettings
      • OfficeContainerSettings
      • OpenApplicationsIn
      • OptimizationFileType
      • OptimizationServerObjType
      • OptimizationTypeEnum
      • Options
      • OSsCriteria
      • OverlayIconType
      • OverwriteSupportActions
      • PackagedApp
      • PackageDetails
      • PasswordEncoding
      • PCKeyboard
      • PendingScheduleType
      • PerformAction
      • Performance
      • PerformanceMonitorSettings
      • Permission
      • PermissionFlags
      • PermissionObjectType
      • PermissionType
      • PermittedHourPlan
      • PoolType
      • Ports
      • PowerState
      • PredefinedComponent
      • PredefinedScheduledTask
      • PredefinedServerObjType
      • PredefinedService
      • PrimaryConnection
      • PrintingDataFormat
      • PrintingOptions
      • PrintingSettings
      • PrintingTechnologyUse
      • PrnDriverAllowMode
      • PrnNameFormat
      • Profile
      • ProfileContainerAdvancedSettings
      • ProfileContainerSettings
      • ProfileDiskFormat
      • ProfileType
      • Protocol
      • Provider
      • ProviderAgentDiagnostic
      • ProviderDiagnosticState
      • ProviderHost
      • ProviderHostApp
      • ProviderMajorType
      • ProviderSubType
      • ProviderSubTypeAll
      • ProviderSysInfo
      • ProviderSysInfoHost
      • ProviderSysInfoHostApp
      • ProviderType
      • ProvisioningSettings
      • ProvisioningType
      • ProxyMode
      • ProxyType
      • PubAppAttr
      • PubAVDApp
      • PubAVDDesktop
      • PubDefaultSettings
      • PubFileExtSettings
      • PubFolder
      • PubItem
      • PubItemCmd
      • PubItemCriteria
      • PubItemFilter
      • PubItemRule
      • PubItemStatus
      • PublishedApplications
      • PublishFrom
      • PublishingType
      • PubPCApp
      • PubPreferredRoute
      • PubRDSApp
      • PubRDSDesktop
      • PubResourceEnabledMode
      • PubVDIApp
      • PubVDIDesktop
      • QualityLevel
      • RadiusAttrType
      • RadiusType
      • RASAdminSessionProcessCmd
      • RASAgentDiagnosticType
      • RASAgentInfo
      • RASAllowedDevicesSetting
      • RASAuthSettings
      • RASClientSettings
      • RASFarmSettings
      • RASFiles
      • RASHelpdeskEmailSettings
      • RASListObj
      • RASLogLevel
      • RASLogSrvType
      • RASMailboxSettings
      • RASNotificationEventType
      • RASNotificationResourceType
      • RASPowerPermission
      • RASProxySettings
      • RASPubObject
      • RASSerilazableObj
      • RASServerType
      • RASSessionSetting
      • RASSystemSettings
      • RDPPrinterSettings
      • RDPSession
      • RDSAgentDiagnostic
      • RDSCmd
      • RDSDefaultSettings
      • RDSDefaultSiteSettings
      • RDSession
      • RDSessionSource
      • RDSHost
      • RDSHostPool
      • RDSHostPoolCmd
      • RDSHostPoolStatus
      • RDSHostSessionApp
      • RDSHostSysInfo
      • RDSHostSysInfoSession
      • RDSHostSysInfoSessionApp
      • RDSProcessCmd
      • RDSSessionCmd
      • Reconnection
      • RedirectActionType
      • Redirection
      • RedirectScanner
      • RedirectType
      • Registries
      • Registry
      • RemoteFxUsbRedirection
      • RemotePCDynamicProvider
      • RemotePCDynamicVersion
      • RemotePCStatic
      • RemotePCStaticProvider
      • RemotePCStaticVersion
      • RemoveType
      • RepairObjType
      • RepeatSpecificDays
      • RepeatType
      • ReportingSettings
      • RequestType
      • ResourceType
      • RetryLastActionObjType
      • RoamSearch
      • RouteFlowHopType
      • RouteFlowInfoEntry
      • RoutingType
      • RuleObjType
      • SafeNetAuthMode
      • SAMLIDP
      • SAMLIDPAttribute
      • SAMLIDPAttributes
      • SaveZipSupportRequest
      • ScaleComputingProvider
      • ScaleVersion
      • Scanning
      • ScanningSettings
      • ScanningTechnologyUse
      • ScanType
      • Schedule
      • ScheduleActionType
      • ScheduleMessage
      • ScheduleObjType
      • ScheduleTargetType
      • SecondaryConnection
      • SecondaryConnections
      • SectionPermission
      • SectionPermissions
      • SecurityPrincipalCriteriaEntry
      • SecurityPrincipalsCriteria
      • SendMsgWhen
      • SendSupportReport
      • ServerAppInfo
      • ServerAuthentication
      • ServerDefObjType
      • Session
      • SessionAction
      • SessionColorDepth
      • SessionLoginStatus
      • SessionMode
      • SessionPolicy
      • SessionPrelaunch
      • SessionProtocol
      • SessionPublishingType
      • SessionsPrinting
      • SessionState
      • SessionType
      • SessionUPDStatus
      • Settings
      • SettingsColorDepth
      • ShowInformationForUnenrolledUsers
      • SingleSignOn
      • Site
      • SitePermission
      • SiteSysInfo
      • SiteTypePermission
      • SmartCards
      • SmartSizing
      • StatusLevel
      • StopOptimizationObjType
      • StorageDevice
      • Subnet
      • SupportType
      • TargetNativeHost
      • TargetType
      • TempFolderRedirectionMode
      • Template
      • TemplateAdvanced
      • TemplateAdvancedAWS
      • TemplateAdvancedAzure
      • TemplateAdvancedFolder
      • TemplateAdvancedMultipleNIC
      • TemplateAdvancedNativePool
      • TemplateAdvancedPhysicalHost
      • TemplateCmd
      • TemplateLicense
      • TemplateLicenseKey
      • TemplateObjType
      • TemplatePreparation
      • TemplateSettings
      • TemplateState
      • TemplateStatus
      • TemplateVersion
      • TemplateVersionObjType
      • TemplateVersionStatus
      • TemplateVersionStatusType
      • Tenant
      • TenantBrokerSettings
      • TenantBrokerSettingsCommand
      • TenantCommand
      • Theme
      • ThemeCustomImage
      • ThemeImageTypes
      • ThemesCriteria
      • ThemeUserPortal
      • ThemeUserPortalBranding
      • ThemeUserPortalGateway
      • ThemeUserPortalMessages
      • ThemeWindowsBranding
      • ThemeWindowsClient
      • ThemeWindowsMessages
      • ThresholdDirection
      • TokenType
      • TOTPType
      • Trigger
      • UIType
      • UniversalPrinting
      • Update
      • UPDMode
      • UPDRoamingMode
      • UPDStatus
      • Url
      • URLRedirectEntry
      • URLRedirectionSettings
      • UserEnrollment
      • UserFilter
      • UserGroupType
      • UserProfileSettings
      • UserProfileTech
      • UserProfileType
      • UserType
      • UWPApps
      • ValueType
      • VCenterProvider
      • VDIAzureInfo
      • VDICommand
      • VDIDefaultSettings
      • VDIGeneralSettings
      • VDIHost
      • VDIHostConn
      • VDIHostPool
      • VDIHostPoolMember
      • VDIHostPoolMemberType
      • VDIHostPoolStatus
      • VDIHostState
      • VDIHostSysInfo
      • VDIMatchingMode
      • VDIPersistentHost
      • VDIProcessCmd
      • VDIRDPSession
      • VDISecuritySettings
      • VDIServerAppInfo
      • VDISessionCmd
      • VHDAccessMode
      • VHDXSectorSize
      • VideoCaptureDevices
      • VisualEffects
      • VisualEffectsType
      • VM
      • VMState
      • VMwareESXiProvider
      • VmwareESXiVersion
      • VmwareVCenterVersion
      • VolumeType
      • WebAuthentication
      • WeekDays
      • WhenAllSessionClosedAction
      • WinDeviceGroup
      • WinDeviceGroupInboundPort
      • WindowsAdvancedOptions
      • WindowsClient
      • WindowsComponent
      • WindowsComponents
      • WindowsDefenderATP
      • WindowsDefenderATPEnable
      • WindowsScheduledTasks
      • WindowsService
      • WindowsServices
      • WindowsTouchInput
      • WindowType
      • WorkAreaImage
    • Parallels RAS PowerShell
    • Contents
  • API Versions
  • Examples
    • Basic Example
    • Farm Example
    • Parallels RAS PowerShell
    • PA Promote Example
    • Publishing Example
    • Agent Example
    • RDS Template Example
    • Status Info Example
    • VDI Example
Powered by GitBook

© 2025 Parallels International GmbH. All rights reserved.

On this page
  • NAME
  • SYNOPSIS
  • SYNTAX
  • DESCRIPTION
  • PARAMETERS
  • INPUTS
  • OUTPUTS
  • EXAMPLES
  • RELATED LINKS
Export as PDF
  1. Parallels RAS Powershell Admin Module
  2. Commands

Set-RASPubFolder

PreviousSet-RASPubDefaultSettingsNextSet-RASPubItem

Last updated 8 months ago

NAME

Set-RASPubFolder

SYNOPSIS

Modifies properties of a published folder.

SYNTAX

Set-RASPubFolder [-] <uint> [- <bool>] [- <string>] [- <bool>] [- {Disabled | Enabled | Maintenance}] [- <string>] [- <uint>] [- <bool>] [- <string>] [- <string>] [- <string>] [- <string>] [- <string>] [- <string>] [- <string>] [- <string>] [- <string>] [- <string>] [- <string>] [- <string>] [- <bool>] [- <>] [- <uint[]>] [- <bool>] [- <uint>] [<>]

Set-RASPubFolder [-] <> [- <bool>] [- <string>] [- <bool>] [- {Disabled | Enabled | Maintenance}] [- <string>] [- <uint>] [- <bool>] [- <string>] [- <string>] [- <string>] [- <string>] [- <string>] [- <string>] [- <string>] [- <string>] [- <string>] [- <string>] [- <string>] [- <string>] [- <bool>] [- <>] [- <uint[]>] [- <bool>] [- <uint>] [<>]

DESCRIPTION

Modifies properties of a published folder.

You can include only the parameters (published folder properties) that you want to modify.

To set filtering options, use Pub Filtering cmdlets (e.g. Set-RASPubItemClientFilter).

PARAMETERS

-AdminOnly <bool> Use folder for administrative purposes only.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Name <string> A new name to assign to the published resource.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Icon <string> Published resource icon file name. Can be an executable (.exe), a .dll or a .ico file.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-IconIndex <uint> Icon index

Specifies the index of the icon that will be loaded from the binary specified in the Icon property

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ReplicateMaintenance <bool> Replicate Maintenance

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InheritMaintenance <bool> Inherit Maintenance

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Enabled <bool> Enable or disable a published resource.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Possible values: Disabled, Enabled, Maintenance

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MaintenanceMessage_en_US <string> Maintenance message for the published resource in English.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MaintenanceMessage_ja_JP <string> Maintenance message for the published resource in Japanese.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MaintenanceMessage_fr_FR <string> Maintenance message for the published resource in French.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MaintenanceMessage_es_ES <string> Maintenance message for the published resource in Spanish.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MaintenanceMessage_it_IT <string> Maintenance message for the published resource in Italian.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MaintenanceMessage_pt_BR <string> Maintenance message for the published resource in Portuguese.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MaintenanceMessage_nl_NL <string> Maintenance message for the published resource in Dutch.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MaintenanceMessage_de_DE <string> Maintenance message for the published resource in German.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MaintenanceMessage_zh_TW <string> Maintenance message for the published resource in Chinese (Traditional).

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MaintenanceMessage_zh_CN <string> Maintenance message for the published resource in Chinese (Simplified).

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MaintenanceMessage_ko_KR <string> Maintenance message for the published resource in Korean.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Description <string> Published resource description.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false
        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-PublishToSiteIds <uint[]> An array of sites to which to publish a resource.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-PreferredRoutingEnabled <bool> Enable or disable Preferred Routing.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <uint> Published resource ID.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

To obtain the object, use the Get-PubItem cmdlet.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

-SiteId <uint> Site ID.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

<CommonParameters>

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

        OutBuffer, PipelineVariable, and OutVariable. For more information, see 

        about_CommonParameters documentation. 

INPUTS

OUTPUTS

-none-

EXAMPLES

---------- EXAMPLE 1 ----------

Set-RASPubFolder 1 -Enabled $false

Disables a published folder specified by ID. ---------- EXAMPLE 2 ----------

Set-RASPubFolder $PubFolder -Enabled $false

Disables a published folder specified by the $PubFolder object.

To obtain an object, use the Get-RASPubFolder cmdlet. ---------- EXAMPLE 3 ----------

Get-RASPubFolder -Id 1 | Set-RASPubFolder -Enabled $false

Disables a folder specified by an object obtained from the pipeline output.

RELATED LINKS

-EnabledMode <> Changes the availability status of the published resource.

-PublishToSite <> An array of sites to which to publish a resource.

-InputObject <> An object specifying the published resource.

PubResourceEnabledMode
Site[]
PubItem
PubItem
Get-RASPubFolder
Remove-RASPubFolder
Set-RASPubItemUserFilter
Set-RASPubItemClientFilter
Set-RASPubItemIPFilter
Set-RASPubItemMACFilter
Set-RASPubItemGatewayFilter
Set-RASPubDefaultSettings
Site[]
PubItem
Site[]
Id
AdminOnly
Description
Enabled
EnabledMode
Icon
IconIndex
InheritMaintenance
MaintenanceMessage_de_DE
MaintenanceMessage_en_US
MaintenanceMessage_es_ES
MaintenanceMessage_fr_FR
MaintenanceMessage_it_IT
MaintenanceMessage_ja_JP
MaintenanceMessage_ko_KR
MaintenanceMessage_nl_NL
MaintenanceMessage_pt_BR
MaintenanceMessage_zh_CN
MaintenanceMessage_zh_TW
Name
PreferredRoutingEnabled
PublishToSite
PublishToSiteIds
ReplicateMaintenance
SiteId
CommonParameters
InputObject
AdminOnly
Description
Enabled
EnabledMode
Icon
IconIndex
InheritMaintenance
MaintenanceMessage_de_DE
MaintenanceMessage_en_US
MaintenanceMessage_es_ES
MaintenanceMessage_fr_FR
MaintenanceMessage_it_IT
MaintenanceMessage_ja_JP
MaintenanceMessage_ko_KR
MaintenanceMessage_nl_NL
MaintenanceMessage_pt_BR
MaintenanceMessage_zh_CN
MaintenanceMessage_zh_TW
Name
PreferredRoutingEnabled
PublishToSite
PublishToSiteIds
ReplicateMaintenance
SiteId
CommonParameters