Set-FilesSite
Update Site Settings.
Syntax
Description
Update Site Settings.
The command supports -WhatIf, which describes the change without sending it to Files.com, and -Confirm, which asks before sending it. It asks for confirmation by default; use -Confirm:$false in scripts that have already decided.
File parameters take a FilesAttachment: a local file from Get-Item, such as (Get-Item ./logo.png), or one New-FilesAttachment makes from a file, bytes or a stream. The file goes in the same request as the other parameters, whose values are sent exactly as they would be without it; a local file is opened, and a stream read, only when the command goes ahead with the change: never under -WhatIf or when a confirmation is declined. A stream is borrowed: the command leaves it open.
Examples
Example 1: Update Site Settings
Writes the site returned.
Example 2: Preview the change
Describes the change without sending anything to Files.com.
Parameters
-Name
Site name
- Type:
System.String - Parameter sets:
(All)
-Subdomain
Site subdomain
- Type:
System.String - Parameter sets:
(All)
-Domain
Custom domain
- Type:
System.String - Parameter sets:
(All)
-DomainHstsHeader
Send HSTS (HTTP Strict Transport Security) header when visitors access the site via a custom domain?
- Type:
System.Boolean - Parameter sets:
(All)
-DomainLetsencryptChain
Letsencrypt chain to use when registering SSL Certificate for domain. No longer used as of 2026.
- Type:
System.String - Parameter sets:
(All)
Main email for this site
- Type:
System.String - Parameter sets:
(All)
-ReplyToEmail
Reply-to email for this site
- Type:
System.String - Parameter sets:
(All)
-AllowBundleNames
Are manual Bundle names allowed?
- Type:
System.Boolean - Parameter sets:
(All)
-BundleExpiration
Site-wide Bundle expiration in days
- Type:
System.Int64 - Parameter sets:
(All)
-WelcomeEmailEnabled
Will the welcome email be sent to new users?
- Type:
System.Boolean - Parameter sets:
(All)
-AskAboutOverwrites
If false, rename conflicting files instead of asking for overwrite confirmation. Only applies to web interface.
- Type:
System.Boolean - Parameter sets:
(All)
-ShowRequestAccessLink
Show request access link for users without access? Currently unused.
- Type:
System.Boolean - Parameter sets:
(All)
-AlwaysMkdirParents
Create parent directories if they do not exist during uploads? This is primarily used to work around broken upload clients that assume servers will perform this step.
- Type:
System.Boolean - Parameter sets:
(All)
-WelcomeEmailCc
Include this email in welcome emails if enabled
- Type:
System.String - Parameter sets:
(All)
-WelcomeEmailSubject
Include this email subject in welcome emails if enabled
- Type:
System.String - Parameter sets:
(All)
-WelcomeCustomText
Custom text send in user welcome email
- Type:
System.String - Parameter sets:
(All)
-Language
Site default language
- Type:
System.String - Parameter sets:
(All)
-WindowsModeFtp
Does FTP user Windows emulation mode?
- Type:
System.Boolean - Parameter sets:
(All)
-DefaultTimeZone
Site default time zone
- Type:
System.String - Parameter sets:
(All)
-DesktopApp
Is the desktop app enabled?
- Type:
System.Boolean - Parameter sets:
(All)
-DesktopAppSessionIpPinning
Is desktop app session IP pinning enabled?
- Type:
System.Boolean - Parameter sets:
(All)
-DesktopAppSessionLifetime
Desktop app session lifetime (in hours)
- Type:
System.Int64 - Parameter sets:
(All)
-MobileApp
Is the mobile app enabled?
- Type:
System.Boolean - Parameter sets:
(All)
-MobileAppSessionIpPinning
Is mobile app session IP pinning enabled?
- Type:
System.Boolean - Parameter sets:
(All)
-MobileAppSessionLifetime
Mobile app session lifetime (in hours)
- Type:
System.Int64 - Parameter sets:
(All)
-FolderPermissionsGroupsOnly
If true, permissions for this site must be bound to a group (not a user).
- Type:
System.Boolean - Parameter sets:
(All)
-WelcomeScreen
Does the welcome screen appear?
- Type:
System.String - Parameter sets:
(All)
-OfficeIntegrationAvailable
If true, allows users to use a document editing integration.
- Type:
System.Boolean - Parameter sets:
(All)
-OfficeIntegrationType
Which document editing integration to support. Files.com Editor or Microsoft Office for the Web.
- Type:
System.String - Parameter sets:
(All)
-PinAllRemoteServersToSiteRegion
If true, we will ensure that all internal communications with any remote server are made through the primary region of the site. This setting overrides individual remote server settings.
- Type:
System.Boolean - Parameter sets:
(All)
-MotdText
A message to show users when they connect via FTP or SFTP.
- Type:
System.String - Parameter sets:
(All)
-MotdUseForFtp
Show message to users connecting via FTP
- Type:
System.Boolean - Parameter sets:
(All)
-MotdUseForSftp
Show message to users connecting via SFTP
- Type:
System.Boolean - Parameter sets:
(All)
-LeftNavigationVisibility
Visibility settings for account navigation Give a hashtable or PSCustomObject; keys keep their case and values their types.
- Type:
System.Collections.IDictionary - Parameter sets:
(All)
-DisableAllAiFeatures
If true, all AI features are disabled for this site.
- Type:
System.Boolean - Parameter sets:
(All)
-AiFeatureAvailability
Availability settings for AI features. Each feature requires the site_admins, workspace_admins, folder_admins, and all_users keys. Optional selected_group_members defaults to false; when true, members of at least one group in group_ids get access regardless of the other options. All availability options are additive: any enabled option matching the user grants access. Optional group_ids is an array of integer IDs of active groups on this site, from any workspace. Omitted or empty group_ids grants no access through selected_group_members and does not affect other options. Disabling all AI features overrides these settings. Give a hashtable or PSCustomObject; keys keep their case and values their types.
- Type:
System.Collections.IDictionary - Parameter sets:
(All)
-McpDcrEnabled
Is OAuth DCR (dynamic client registration) for MCP enabled?
- Type:
System.Boolean - Parameter sets:
(All)
-AdditionalTextFileTypes
Additional extensions that are considered text files
- Type:
System.String[] - Parameter sets:
(All)
-BundleRequireNote
Do Bundles require internal notes?
- Type:
System.Boolean - Parameter sets:
(All)
-BundleSendSharedReceipts
Do Bundle creators receive receipts of invitations?
- Type:
System.Boolean - Parameter sets:
(All)
-BundlesDefaultOwnedByPrimaryGroup
If true, new Share Links created by a user with a primary group will default to that group as owner.
- Type:
System.Boolean - Parameter sets:
(All)
-CalculateFileChecksumsCrc32
Calculate CRC32 checksums for files?
- Type:
System.Boolean - Parameter sets:
(All)
-CalculateFileChecksumsMd5
Calculate MD5 checksums for files?
- Type:
System.Boolean - Parameter sets:
(All)
-CalculateFileChecksumsSha1
Calculate SHA1 checksums for files?
- Type:
System.Boolean - Parameter sets:
(All)
-CalculateFileChecksumsSha256
Calculate SHA256 checksums for files?
- Type:
System.Boolean - Parameter sets:
(All)
-LegacyChecksumsMode
Use legacy checksums mode?
- Type:
System.Boolean - Parameter sets:
(All)
-MigrateRemoteServerSyncToSync
If true, we will migrate all remote server syncs to the new Sync model.
- Type:
System.Boolean - Parameter sets:
(All)
-As2MessageRetentionDays
Number of days to retain AS2 messages (incoming and outgoing).
- Type:
System.Int64 - Parameter sets:
(All)
-FileActivityEventsEnabled
If true, file operations produce file_action.activity.v1 EventChannel events in all workspaces. Defaults to false; subscription filters and workspace access still control delivery.
- Type:
System.Boolean - Parameter sets:
(All)
-UsernameDisplay
How usernames are displayed in the web UI. Can be username_only, full_name_only, full_name_username, full_name_company, or full_name_username_company.
- Type:
System.String - Parameter sets:
(All)
-SessionExpiryMinutes
Session expiry in minutes
- Type:
System.Int64 - Parameter sets:
(All)
-SslRequired
Is SSL required? Disabling this is insecure.
- Type:
System.Boolean - Parameter sets:
(All)
-SftpInsecureCiphers
If true, we will allow weak and known insecure ciphers to be used for SFTP connections. Enabling this setting severely weakens the security of your site and it is not recommend, except as a last resort for compatibility.
- Type:
System.Boolean - Parameter sets:
(All)
-SftpInsecureDiffieHellman
If true, we will allow weak Diffie Hellman parameters to be used within ciphers for SFTP that are otherwise on our secure list. This has the effect of making the cipher weaker than our normal threshold for security, but is required to support certain legacy or broken SSH and MFT clients. Enabling this weakens security, but not nearly as much as enabling the full sftp_insecure_ciphers option.
- Type:
System.Boolean - Parameter sets:
(All)
-DisableFilesCertificateGeneration
If set, Files.com will not set the CAA records required to generate future SSL certificates for this domain.
- Type:
System.Boolean - Parameter sets:
(All)
-Fedramp
Are FedRAMP security restrictions enabled for this site?
- Type:
System.Boolean - Parameter sets:
(All)
-UserLockout
Will users be locked out after incorrect login attempts?
- Type:
System.Boolean - Parameter sets:
(All)
-UserLockoutTries
Number of login tries within user_lockout_within hours before users are locked out
- Type:
System.Int64 - Parameter sets:
(All)
-UserLockoutWithin
Number of hours for user lockout window
- Type:
System.Int64 - Parameter sets:
(All)
-UserLockoutLockPeriod
How many hours to lock user out for failed password?
- Type:
System.Int64 - Parameter sets:
(All)
-IncludePasswordInWelcomeEmail
Include password in emails to new users?
- Type:
System.Boolean - Parameter sets:
(All)
-AllowedCountries
Comma separated list of allowed Country codes Give the values as an array; the module joins them as the API expects.
- Type:
System.String[] - Parameter sets:
(All)
-AllowedIps
List of allowed IP addresses
- Type:
System.String - Parameter sets:
(All)
-AllowUserLevel2faOverride
Allow the site-wide two-factor authentication requirement to be overriden on a per-user-basis?
- Type:
System.Boolean - Parameter sets:
(All)
-AllowUserLevelAllowedIpOverride
Allow the site-wide allowed IP restriction to be overriden on a per-user-basis?
- Type:
System.Boolean - Parameter sets:
(All)
-AllowUserLevelSslOverride
Allow the site-wide FTP SSL requirement to be overriden on a per-user-basis?
- Type:
System.Boolean - Parameter sets:
(All)
-DisallowedCountries
Comma separated list of disallowed Country codes Give the values as an array; the module joins them as the API expects.
- Type:
System.String[] - Parameter sets:
(All)
-DaysToRetainBackups
Number of days to keep deleted files
- Type:
System.Int64 - Parameter sets:
(All)
-MaxPriorPasswords
Number of prior passwords to disallow
- Type:
System.Int64 - Parameter sets:
(All)
-PasswordValidityDays
Number of days password is valid
- Type:
System.Int64 - Parameter sets:
(All)
-PasswordMinLength
Shortest password length for users
- Type:
System.Int64 - Parameter sets:
(All)
-PasswordRequireLetter
Require a letter in passwords?
- Type:
System.Boolean - Parameter sets:
(All)
-PasswordRequireMixed
Require lower and upper case letters in passwords?
- Type:
System.Boolean - Parameter sets:
(All)
-PasswordRequireSpecial
Require special characters in password?
- Type:
System.Boolean - Parameter sets:
(All)
-PasswordRequireNumber
Require a number in passwords?
- Type:
System.Boolean - Parameter sets:
(All)
-PasswordRequireUnbreached
Require passwords that have not been previously breached? (see https://haveibeenpwned.com/)
- Type:
System.Boolean - Parameter sets:
(All)
-RequireLogoutFromBundlesAndInboxes
If true, we will hide the 'Remember Me' box on Inbox and Bundle registration pages, requiring that the user logout and log back in every time they visit the page.
- Type:
System.Boolean - Parameter sets:
(All)
-DavUserRootEnabled
Use user FTP roots also for WebDAV?
- Type:
System.Boolean - Parameter sets:
(All)
-SftpUserRootEnabled
Use user FTP roots also for SFTP?
- Type:
System.Boolean - Parameter sets:
(All)
-DisablePasswordReset
Is password reset disabled?
- Type:
System.Boolean - Parameter sets:
(All)
-ImmutableFiles
Are files protected from modification?
- Type:
System.Boolean - Parameter sets:
(All)
-BundleNotFoundMessage
Custom error message to show when bundle is not found.
- Type:
System.String - Parameter sets:
(All)
-BundlePasswordRequired
Do Bundles require password protection?
- Type:
System.Boolean - Parameter sets:
(All)
-BundleRequireRegistration
Do Bundles require registration?
- Type:
System.Boolean - Parameter sets:
(All)
-BundleRequireShareRecipient
Do Bundles require recipients for sharing?
- Type:
System.Boolean - Parameter sets:
(All)
-BundleSendOneTimePasswordToRecipientAtRegistration
If true, new Share Links must send a one-time password to the recipient when they register. Requires bundle_require_share_recipient and cannot be enabled with bundle_password_required.
- Type:
System.Boolean - Parameter sets:
(All)
-BundleRegistrationNotifications
Do Bundle owners receive registration notification?
- Type:
System.String - Parameter sets:
(All)
-BundleActivityNotifications
Do Bundle owners receive activity notifications?
- Type:
System.String - Parameter sets:
(All)
-BundleUploadReceiptNotifications
Do Bundle uploaders receive upload confirmation notifications?
- Type:
System.String - Parameter sets:
(All)
-DocumentEditsInBundleAllowed
If true, allow public viewers of Bundles with full permissions to use document editing integrations.
- Type:
System.Boolean - Parameter sets:
(All)
-PasswordRequirementsApplyToBundles
Require bundles' passwords, and passwords for other items (inboxes, public shares, etc.) to conform to the same requirements as users' passwords?
- Type:
System.Boolean - Parameter sets:
(All)
-PreventRootPermissionsForNonSiteAdmins
If true, we will prevent non-administrators from receiving any permissions directly on the root folder. This is commonly used to prevent the accidental application of permissions.
- Type:
System.Boolean - Parameter sets:
(All)
-RestrictRootFolderBehaviorsToSiteAdmins
If true, only site admins may create, modify, or delete any behavior at the site root, or a skip that would disable one.
- Type:
System.Boolean - Parameter sets:
(All)
-RootFolderBehaviorsApplyToWorkspaces
If true, supported protective behaviors at the site root also apply within named workspaces. Requires restrict_root_folder_behaviors_to_site_admins to be enabled.
- Type:
System.Boolean - Parameter sets:
(All)
-OptOutGlobal
Use servers in the USA only?
- Type:
System.Boolean - Parameter sets:
(All)
-UseProvidedModifiedAt
Allow uploaders to set provided_modified_at for uploaded files?
- Type:
System.Boolean - Parameter sets:
(All)
-CustomNamespace
Is this site using a custom namespace for users?
- Type:
System.Boolean - Parameter sets:
(All)
-NonSsoGroupsAllowed
If true, groups can be manually created / modified / deleted by Site Admins. Otherwise, groups can only be managed via your SSO provider.
- Type:
System.Boolean - Parameter sets:
(All)
-NonSsoUsersAllowed
If true, users can be manually created / modified / deleted by Site Admins. Otherwise, users can only be managed via your SSO provider.
- Type:
System.Boolean - Parameter sets:
(All)
-SharingEnabled
Allow bundle creation
- Type:
System.Boolean - Parameter sets:
(All)
-SnapshotSharingEnabled
Allow snapshot share links creation
- Type:
System.Boolean - Parameter sets:
(All)
-UserRequestsEnabled
Enable User Requests feature
- Type:
System.Boolean - Parameter sets:
(All)
-UserRequestsNotifyAdmins
Send email to site admins when a user request is received?
- Type:
System.Boolean - Parameter sets:
(All)
-DavEnabled
Is WebDAV enabled?
- Type:
System.Boolean - Parameter sets:
(All)
-FilesComRemoteServerEnabled
Allow other Files.com sites to use this site's API keys for native Files.com Remote Server connections? Defaults to true and applies to all keys and workspaces on this site. When false, new pairings and access through existing connections are rejected without revoking keys or deleting connections. Re-enabling permits access again with usable keys. Does not disable this site's connections to other sites, ordinary API access, or Connected Sites.
- Type:
System.Boolean - Parameter sets:
(All)
-FtpEnabled
Is FTP enabled?
- Type:
System.Boolean - Parameter sets:
(All)
-S3CompatibleEndpointEnabled
Is the S3-compatible endpoint enabled for all users and workspaces on this site? Defaults to true. When false, user and group S3 permissions do not allow access.
- Type:
System.Boolean - Parameter sets:
(All)
-SftpEnabled
Is SFTP enabled?
- Type:
System.Boolean - Parameter sets:
(All)
-SftpFinalizePartialUploads
Finalize partial SFTP uploads from interrupted connections? Default: true.
- Type:
System.Boolean - Parameter sets:
(All)
-UsersCanCreateApiKeys
Allow users to create their own API keys?
- Type:
System.Boolean - Parameter sets:
(All)
-UsersCanCreateSshKeys
Allow users to create their own SSH keys?
- Type:
System.Boolean - Parameter sets:
(All)
-ShowUserNotificationsLogInLink
Show log in link in user notifications?
- Type:
System.Boolean - Parameter sets:
(All)
-SftpHostKeyType
Sftp Host Key Type
- Type:
System.String - Parameter sets:
(All)
-ActiveSftpHostKeyId
Id of the currently selected custom SFTP Host Key
- Type:
System.Int64 - Parameter sets:
(All)
-ActiveSftpHostKeyIds
Ids of the selected custom SFTP Host Keys
- Type:
System.Int64[] - Parameter sets:
(All)
-ProtocolAccessGroupsOnly
If true, protocol access permissions on users will be ignored, and only protocol access permissions set on Groups will be honored. Make sure that your current user is a member of a group with API permission when changing this value to avoid locking yourself out of your site.
- Type:
System.Boolean - Parameter sets:
(All)
-RevokeBundleAccessOnDisableOrDelete
Auto-removes bundles for disabled/deleted users and enforces bundle expiry within user access period.
- Type:
System.Boolean - Parameter sets:
(All)
-GroupAdminsCanAddUsers
Allow group admins to create users in their groups
- Type:
System.Boolean - Parameter sets:
(All)
-GroupAdminsCanManageGroupMemberships
Allow group admins to add or remove existing users in their groups
- Type:
System.Boolean - Parameter sets:
(All)
-GroupAdminsCanDeleteUsers
Allow group admins to delete users in their groups
- Type:
System.Boolean - Parameter sets:
(All)
-GroupAdminsCanEnableDisableUsers
Allow group admins to enable or disable users in their groups
- Type:
System.Boolean - Parameter sets:
(All)
-GroupAdminsCanModifyUsers
Allow group admins to modify users in their groups
- Type:
System.Boolean - Parameter sets:
(All)
-GroupAdminsCanBypassUserLifecycleRules
Allow group admins to exempt users in their groups from lifecycle rules
- Type:
System.Boolean - Parameter sets:
(All)
-GroupAdminsCanResetPasswords
Allow group admins to reset passwords for users in their groups
- Type:
System.Boolean - Parameter sets:
(All)
-GroupAdminsCanSetUserPassword
Allow group admins to set password authentication method
- Type:
System.Boolean - Parameter sets:
(All)
-BundleRecipientBlacklistFreeEmailDomains
Disallow free email domains for Bundle/Inbox recipients?
- Type:
System.Boolean - Parameter sets:
(All)
-BundleRecipientBlacklistDomains
List of email domains to disallow when entering a Bundle/Inbox recipients
- Type:
System.String[] - Parameter sets:
(All)
-AdminsBypassLockedSubfolders
Allow admins to bypass the locked subfolders setting.
- Type:
System.Boolean - Parameter sets:
(All)
-Allowed2faMethodSms
Is SMS two factor authentication allowed?
- Type:
System.Boolean - Parameter sets:
(All)
-Allowed2faMethodTotp
Is TOTP two factor authentication allowed?
- Type:
System.Boolean - Parameter sets:
(All)
-Allowed2faMethodWebauthn
Is WebAuthn two factor authentication allowed?
- Type:
System.Boolean - Parameter sets:
(All)
-Allowed2faMethodYubi
Is yubikey two factor authentication allowed?
- Type:
System.Boolean - Parameter sets:
(All)
-Allowed2faMethodEmail
Is OTP via email two factor authentication allowed?
- Type:
System.Boolean - Parameter sets:
(All)
-Allowed2faMethodStatic
Is OTP via static codes for two factor authentication allowed?
- Type:
System.Boolean - Parameter sets:
(All)
-Allowed2faMethodBypassForFtpSftpDav
Are users allowed to configure their two factor authentication to be bypassed for FTP/SFTP/WebDAV?
- Type:
System.Boolean - Parameter sets:
(All)
-Require2fa
Require two-factor authentication for all users?
- Type:
System.Boolean - Parameter sets:
(All)
-Require2faExemptAllSsoUsers
If true, SSO users using the default user-level two-factor authentication setting are exempt from the site-wide two-factor authentication requirement.
- Type:
System.Boolean - Parameter sets:
(All)
-Require2faUserType
What type of user is required to use two-factor authentication (when require_2fa is set to true for this site)?
- Type:
System.String - Parameter sets:
(All)
-Color2Top
Top bar background color
- Type:
System.String - Parameter sets:
(All)
-Color2Left
Page link and button color
- Type:
System.String - Parameter sets:
(All)
-Color2Link
Top bar link color
- Type:
System.String - Parameter sets:
(All)
-Color2Text
Page link and button color
- Type:
System.String - Parameter sets:
(All)
-Color2TopText
Top bar text color
- Type:
System.String - Parameter sets:
(All)
-SiteHeader
Custom site header text for authenticated pages
- Type:
System.String - Parameter sets:
(All)
-SiteFooter
Custom site footer text for authenticated pages
- Type:
System.String - Parameter sets:
(All)
-SitePublicHeader
Custom site header text for public pages
- Type:
System.String - Parameter sets:
(All)
-SitePublicFooter
Custom site footer text for public pages
- Type:
System.String - Parameter sets:
(All)
-LoginHelpText
Login help text
- Type:
System.String - Parameter sets:
(All)
-UseDedicatedIpsForSmtp
If using custom SMTP, should we use dedicated IPs to deliver emails?
- Type:
System.Boolean - Parameter sets:
(All)
-EmailFooterCustomText
Custom footer text for system-generated emails (as Markdown). Supports standard strftime date/time patterns like %Y (4-digit year), %m (month), %d (day).
- Type:
System.String - Parameter sets:
(All)
-SmtpAddress
SMTP server hostname or IP
- Type:
System.String - Parameter sets:
(All)
-SmtpAuthentication
SMTP server authentication type
- Type:
System.String - Parameter sets:
(All)
-SmtpFrom
From address to use when mailing through custom SMTP
- Type:
System.String - Parameter sets:
(All)
-SmtpUsername
SMTP server username
- Type:
System.String - Parameter sets:
(All)
-SmtpPort
SMTP server port
- Type:
System.Int64 - Parameter sets:
(All)
-SmtpSsl
Custom SMTP encryption mode: if_available (default) uses STARTTLS when offered and otherwise sends credentials and messages unencrypted. A certificate-verified STARTTLS connection automatically changes if_available to require unless smtp_ssl is managed by a parent policy. require requires STARTTLS before authentication; require_implicit uses TLS from connection start; never disables TLS. TLS verifies the server certificate against smtp_address. Encryption is never automatically downgraded.
- Type:
System.String - Parameter sets:
(All)
-LdapEnabled
Main LDAP setting: is LDAP enabled?
- Type:
System.Boolean - Parameter sets:
(All)
-LdapType
LDAP type
- Type:
System.String - Parameter sets:
(All)
-LdapHost
LDAP host
- Type:
System.String - Parameter sets:
(All)
-LdapHost2
LDAP backup host
- Type:
System.String - Parameter sets:
(All)
-LdapHost3
LDAP backup host
- Type:
System.String - Parameter sets:
(All)
-LdapPort
LDAP port
- Type:
System.Int64 - Parameter sets:
(All)
-LdapSecure
Use secure LDAP?
- Type:
System.Boolean - Parameter sets:
(All)
-LdapServerCertificate
How to validate the LDAP server certificate. require_match validates the certificate chain and hostname; allow_any disables certificate validation.
- Type:
System.String - Parameter sets:
(All)
-LdapUsername
Username for signing in to LDAP server.
- Type:
System.String - Parameter sets:
(All)
-LdapUsernameField
LDAP username field
- Type:
System.String - Parameter sets:
(All)
-LdapDomain
Domain name that will be appended to usernames
- Type:
System.String - Parameter sets:
(All)
-LdapUserAction
Should we sync users from LDAP server?
- Type:
System.String - Parameter sets:
(All)
-LdapGroupAction
Should we sync groups from LDAP server?
- Type:
System.String - Parameter sets:
(All)
-LdapUserIncludeGroups
Comma or newline separated list of group names (with optional wildcards) - if provided, only users in these groups will be added or synced. Give the values as an array; the module joins them as the API expects.
- Type:
System.String[] - Parameter sets:
(All)
-LdapGroupExclusion
Comma or newline separated list of group names (with optional wildcards) to exclude when syncing. Give the values as an array; the module joins them as the API expects.
- Type:
System.String[] - Parameter sets:
(All)
-LdapGroupInclusion
Comma or newline separated list of group names (with optional wildcards) to include when syncing. Give the values as an array; the module joins them as the API expects.
- Type:
System.String[] - Parameter sets:
(All)
-LdapBaseDn
Base DN for looking up users in LDAP server
- Type:
System.String - Parameter sets:
(All)
-UploadsViaEmailAuthentication
Require email authentication, virus, and spam checks for incoming emails to Inboxes and Incoming Email Automations in every Workspace on this site?
- Type:
System.Boolean - Parameter sets:
(All)
-BundleWatermarkValue
Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value Give a hashtable or PSCustomObject; keys keep their case and values their types.
- Type:
System.Collections.IDictionary - Parameter sets:
(All)
-Icon16File
Icon16 file Give a FilesAttachment, such as (Get-Item ./file.png) or one from New-FilesAttachment.
- Type:
FilesCom.PowerShell.FilesAttachment - Parameter sets:
(All)
-Icon16Delete
If true, will delete the file stored in icon16
- Type:
System.Boolean - Parameter sets:
(All)
-Icon32File
Icon32 file Give a FilesAttachment, such as (Get-Item ./file.png) or one from New-FilesAttachment.
- Type:
FilesCom.PowerShell.FilesAttachment - Parameter sets:
(All)
-Icon32Delete
If true, will delete the file stored in icon32
- Type:
System.Boolean - Parameter sets:
(All)
-Icon48File
Icon48 file Give a FilesAttachment, such as (Get-Item ./file.png) or one from New-FilesAttachment.
- Type:
FilesCom.PowerShell.FilesAttachment - Parameter sets:
(All)
-Icon48Delete
If true, will delete the file stored in icon48
- Type:
System.Boolean - Parameter sets:
(All)
-Icon128File
Icon128 file Give a FilesAttachment, such as (Get-Item ./file.png) or one from New-FilesAttachment.
- Type:
FilesCom.PowerShell.FilesAttachment - Parameter sets:
(All)
-Icon128Delete
If true, will delete the file stored in icon128
- Type:
System.Boolean - Parameter sets:
(All)
-LogoFile
Logo file Give a FilesAttachment, such as (Get-Item ./file.png) or one from New-FilesAttachment.
- Type:
FilesCom.PowerShell.FilesAttachment - Parameter sets:
(All)
-LogoDelete
If true, will delete the file stored in logo
- Type:
System.Boolean - Parameter sets:
(All)
-BundleWatermarkAttachmentFile
Bundle watermark attachment file Give a FilesAttachment, such as (Get-Item ./file.png) or one from New-FilesAttachment.
- Type:
FilesCom.PowerShell.FilesAttachment - Parameter sets:
(All)
-BundleWatermarkAttachmentDelete
If true, will delete the file stored in bundle_watermark_attachment
- Type:
System.Boolean - Parameter sets:
(All)
-LoginPageBackgroundImageFile
Login page background image file Give a FilesAttachment, such as (Get-Item ./file.png) or one from New-FilesAttachment.
- Type:
FilesCom.PowerShell.FilesAttachment - Parameter sets:
(All)
-LoginPageBackgroundImageDelete
If true, will delete the file stored in login_page_background_image
- Type:
System.Boolean - Parameter sets:
(All)
-Disable2faWithDelay
If set to true, we will begin the process of disabling 2FA on this site.
- Type:
System.Boolean - Parameter sets:
(All)
-LdapPasswordChange
New LDAP password. Give a SecureString, such as one from Read-Host -AsSecureString or Get-Secret; text typed on the command line, even inside ConvertTo-SecureString, stays in command history.
- Type:
System.Security.SecureString - Parameter sets:
(All)
-LdapPasswordChangeConfirmation
Confirm new LDAP password. Give a SecureString, such as one from Read-Host -AsSecureString or Get-Secret; text typed on the command line, even inside ConvertTo-SecureString, stays in command history.
- Type:
System.Security.SecureString - Parameter sets:
(All)
-RedirectOldSubdomain
If true, and if changing the site subdomain, then create a redirect from the previous Files.com subdomain to the new Files.com subdomain.
- Type:
System.Boolean - Parameter sets:
(All)
-SmtpPassword
Password for SMTP server. Give a SecureString, such as one from Read-Host -AsSecureString or Get-Secret; text typed on the command line, even inside ConvertTo-SecureString, stays in command history.
- Type:
System.Security.SecureString - Parameter sets:
(All)
-Connection
The connection to use, from Connect-FilesAccount. Defaults to the connection of the -InputObject or -Continuation given, and otherwise to the current runspace's default connection.
- Type:
FilesCom.PowerShell.FilesConnection - Parameter sets:
(All)
-WorkspaceScope
Runs this command's requests in this workspace, including workspace 0, instead of the connection's or, for an -InputObject, instead of the workspace the object was read in. The connection and the object are unchanged.
- Type:
System.Int64 - Parameter sets:
(All)
-NoWorkspaceScope
Runs this command's requests in no workspace, even if the connection has one. The connection itself is unchanged.
- Type:
System.Management.Automation.SwitchParameter - Parameter sets:
(All)
-Confirm
Prompts you for confirmation before running the cmdlet.
- Type:
System.Management.Automation.SwitchParameter - Confirm impact: High. At the default
$ConfirmPreferenceofHigh, the command asks before each change;-Confirm:$falseruns it without asking.
-WhatIf
Shows what the cmdlet would change without sending anything to Files.com.
- Type:
System.Management.Automation.SwitchParameter
Common Parameters
This cmdlet supports the PowerShell common parameters, such as -Verbose and -ErrorAction.
Inputs
None. The command takes no pipeline input.
Outputs
FilesCom.PowerShell.Models.Site: the site as Files.com returned it.
Notes
Failures are written as error records with IDs such as Files.NotFound or Files.Authentication. Run Get-Help about_FilesCom for connections, paging, errors and previewing changes.