New-OfflineAddressBook
此 cmdlet 可在本地 Exchange 和基于云的服务中使用。 一些参数和设置可能只适用于某个特定的环境。
使用 New-OfflineAddressBook cmdlet (OAB) 创建脱机通讯簿。
在 Exchange Online 中,此 cmdlet 仅在“地址列表”角色中可用,默认情况下,该角色不会分配给任何角色组。 若要使用此 cmdlet,需要将“地址列表”角色添加到角色组 (例如“组织管理”角色组) 。 有关详细信息,请参阅向角色组添加角色。
有关以下语法部分的参数设置的详细信息,请参阅 Exchange cmdlet 语法。
语法
New-OfflineAddressBook
[-Name] <String>
-AddressLists <AddressBookBaseIdParameter[]>
[-Confirm]
[-DiffRetentionPeriod <Unlimited>]
[-DomainController <Fqdn>]
[-GeneratingMailbox <MailboxIdParameter>]
[-GlobalWebDistributionEnabled <Boolean>]
[-IsDefault <Boolean>]
[-PublicFolderDatabase <DatabaseIdParameter>]
[-PublicFolderDistributionEnabled <Boolean>]
[-Schedule <Schedule>]
[-Server <ServerIdParameter>]
[-ShadowMailboxDistributionEnabled <Boolean>]
[-SkipPublicFolderInitialization]
[-Versions <MultiValuedProperty>]
[-VirtualDirectories <VirtualDirectoryIdParameter[]>]
[-WhatIf]
[<CommonParameters>]
说明
您必须先获得权限,然后才能运行此 cmdlet。 虽然本主题中列出了此 cmdlet 的所有参数,但如果这些参数并未包含在分配给您的权限中,那么您将无法使用这些参数。 若要查找在贵组织中运行任何 cmdlet 或参数所需的权限,请参阅 Find the permissions required to run any Exchange cmdlet。
示例
示例 1
$a = Get-AddressList | Where {$_.Name -Like "*AgencyB*"}
New-OfflineAddressBook -Name "OAB_AgencyB" -Server myserver.contoso.com -AddressLists $a -Schedule "Mon.01:00-Mon.02:00, Wed.01:00-Wed.02:00"
在 Exchange Server 2010 和 2013 中,此示例使用两个命令创建名为 OAB_AgencyB 的 OAB,其中包括所有地址列表,其中 AgencyB 是该名称的一部分。 通过使用所示的设置,myserver.contoso.com 在星期一和星期三的 01:00 (凌晨 1:00 ) 到 02:00 (凌晨 2 点) 生成 OAB。 此示例命令还为组织创建默认 OAB。
示例 2
New-OfflineAddressBook -Name "Contoso Executives OAB" -AddressLists "Default Global Address List","Contoso Executives Address List" -GlobalWebDistributionEnabled $true
此示例使用以下属性创建名为 Contoso Executives OAB 的新 OAB:
- OAB 中包含的地址列表:默认全局地址列表和 Contoso 高管地址列表
- 组织中的所有 OAB 虚拟目录都可以接受下载 OAB 的请求。
负责生成 OAB 的组织邮箱是 SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c} (我们未使用 GeneratingMailbox 参数指定其他组织邮箱) 。
未指定 OAB 的邮箱和邮箱数据库不使用 OAB, (未将 IsDefault 参数与值$true) 。
示例 3
New-OfflineAddressBook -Name "New OAB" -AddressLists "\Default Global Address List" -Server SERVER01 -VirtualDirectories "SERVER01\OAB (Default Web Site)"
在 Exchange Server 2010 中,此示例使用默认虚拟目录为 SERVER01 上的 Microsoft Office Outlook 2007 或更高版本客户端创建使用基于 Web 的分发的 OAB 新 OAB。
示例 4
New-OfflineAddressBook -Name "Legacy OAB" -AddressLists "\Default Global Address List" -Server SERVER01 -PublicFolderDatabase "PFDatabase" -PublicFolderDistributionEnabled $true -Versions Version1,Version2
在 Exchange Server 2010 中,此示例创建使用 Outlook 2003 Service Pack 1 (SP1) 和 Outlook 98 Service Pack 2 (SP2 () 客户端的 OAB 旧版 OAB。
如果将 OAB 配置为使用公用文件夹分发,但组织没有任何公用文件夹基础结构,则会返回错误。 有关详细信息,请参阅 管理公用文件夹。
参数
-AddressLists
AddressLists 参数指定 OAB 中包含的地址列表或全局地址列表。 您可以使用任何能够唯一标识地址列表的值。 例如:
- 名称
- 可分辨名称 (DN)
- GUID
Update 如果值包含空格或需要引号,请使用以下语法: "Value1","Value2",..."ValueN"
。
可以使用 Get-AddressList 和 Get-GlobalAddressList cmdlet 查找地址列表和全局地址列表的标识值。
Type: | AddressBookBaseIdParameter[] |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Confirm
Confirm 开关指定是否显示确认提示。 此开关对 cmdlet 造成的影响取决于在你继续操作之前 cmdlet 是否需要确认。
- 破坏性 cmdlet (例如,Remove-* cmdlet) 具有内置的暂停,该暂停会强制你在继续操作之前确认命令。 对于这些 cmdlet,您可以使用此确切语法跳过确认提示:
-Confirm:$false
。 - 大多数其他 cmdlet (例如,New-* 和 Set-* cmdlet) 没有内置暂停。 对于这些 cmdlet,指定不含值的 Confirm 开关会引入暂停,从而强制要求你先确认命令,然后再继续操作。
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-DiffRetentionPeriod
DiffRetentionPeriod 参数指定 OAB 差异文件在服务器上存储的天数。 有效值是介于 7 到 1825 之间的整数(或值 unlimited)。 默认值为 30。
Type: | Unlimited |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-DomainController
此参数只在本地 Exchange 中可用。
DomainController 参数指定此 cmdlet 从 Active Directory 读取数据或向其写入数据时使用的域控制器。 可以使用完全限定的域名 (FQDN) 来标识域控制器。 例如,dc01.contoso.com。
Type: | Fqdn |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-GeneratingMailbox
此参数只在本地 Exchange 中可用。
GeneratingMailbox 参数指定生成 OAB 的仲裁邮箱。 具体而言,仲裁邮箱必须包含 PersistedCapability 属性的 OrganizationCapabilityOABGen 值。 具有此功能的仲裁邮箱亦称为“组织邮箱”。 可以使用能够唯一标识邮箱的任意值。 例如:
- 名称
- 别名
- 可分辨名称 (DN)
- 可分辨名称 (DN)
- 域\用户名
- 电子邮件地址
- GUID
- LegacyExchangeDN
- SamAccountName
- 用户 ID 或用户主体名称 (UPN)
此参数的默认值是名为 SystemMailbox{bb558c35-97f1-4cb9-8ff7-d53741dc928c} 的组织邮箱。
单个组织邮箱可以生成多个 OAB, (可以在多个 OAB) 的设置中为此参数使用相同的值,但在 Exchange 2013 CU5 或更高版本中,OAB 只能由单个组织邮箱生成, (此参数不接受多个值) 。 若要向其他组织邮箱分发 OAB 的只读副本(亦称为“影子副本”),请使用 ShadowMailboxDistributionEnabled 参数。
Type: | MailboxIdParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-GlobalWebDistributionEnabled
此参数只在本地 Exchange 中可用。
GlobalWebDistributionEnabled 参数指定组织中的所有 OAB 虚拟目录是否都能接受 OAB 下载请求。 这些位置由自动发现服务播发。 有效值包含:
- $true:组织中的任何 OAB 虚拟目录都可以接受下载 OAB 的请求。 不能将此设置与 VirtualDirectories 参数一起使用。
- $false:只有 VirtualDirectories 参数指定的 OAB 虚拟目录才接受下载 OAB 的请求。 此值为默认值。
在 Exchange 2013 CU7 或更高版本中,建议对此参数使用值$true。 任何邮箱服务器上的客户端访问服务都能将传入的 OAB 下载请求代理至正确的位置。
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-IsDefault
IsDefault 参数指定 OAB 是供所有邮箱使用,还是供尚未指定 OAB 的邮箱数据库使用。 有效值包含:
- $true:OAB 是默认的 OAB。
- $false:OAB 不是默认的 OAB。 此值为默认值。
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-Name
Name 参数指定 OAB 的唯一名称。 最大长度为 64 个字符。 如果值包含空格,则使用引号括住该值。
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
-PublicFolderDatabase
此参数仅在 2010 Exchange Server可用。
PublicFolderDatabase 参数指定用于分发 OAB 的公用文件夹数据库。 可以使用任何能够唯一标识此数据库的值。 例如:
- 名称
- 可分辨名称 (DN)
- GUID
若要使用此参数,必须将 PublicFolderDistributionEnabled 参数设置为 $true。
Type: | DatabaseIdParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-PublicFolderDistributionEnabled
此参数仅在 2010 Exchange Server可用。
PublicFolderDistributionEnabled 参数指定是否通过公用文件夹分发 OAB。 如果 PublicFolderDistributionEnabled 参数的值$true,则通过公用文件夹分发 OAB。
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-Schedule
此参数仅在 2010 Exchange Server可用。
Schedule 参数指定在 Exchange 2010 或更早版本中生成 OAB 的间隔。
此参数的语法为: StartDay.Hour:Minute [AM | PM]-EndDay.Hour:Minute [AM | PM]
。
可使用以下天数值:
- 当天的全名。
- 当天的缩写名称。
- 介于 0 到 6 的整数,其中 0 = 星期日。
可以输入 24 小时格式的时间,并省略 AM/PM 值。 如果以 12 小时格式输入时间,请在时间与 AM/PM 值之间添加一个空格。
可以混合和匹配日期/时间格式。
开始时间和结束时间必须至少间隔 15 分钟。 分钟数将四舍五入到 0、15、30 或 45。
下面是一些示例:
- "Sun.11:30 PM-Mon.1:30 AM"
- “6.22:00-6.22:15” (从周六晚上 10:00 运行到周六晚上 10:15.)
- “星期日 1:15 AM-monday.23:00”
Type: | Schedule |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-Server
此参数仅在 2010 Exchange Server可用。
服务器参数指定要运行此命令的Exchange服务器。 可以使用唯一标识该服务器的任何值。 例如:
- 名称
- FQDN
- 可分辨名称 (DN)
- ExchangeLegacyDN
Exchange 旧版 DN
Type: | ServerIdParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-ShadowMailboxDistributionEnabled
此参数只在本地 Exchange 中可用。
ShadowMailboxDistributionEnabled 参数指定是否将 OAB 的只读副本(亦称为“影子副本”)分发给其他所有 OAB 生成邮箱(亦称为“组织邮箱”)。 这样一来,其他邮箱服务器便会成为 OAB 下载请求的终结点,有助于防止用户跨慢速 WAN 链接下载 OAB。 有效值包含:
- $true:OAB 将分发到所有其他组织邮箱。
- $false:OAB 不会分发到其他组织邮箱。 此值为默认值。
仅当有多个组织邮箱时,此参数的值才有意义,并且仅在具有多个 Active Directory 站点的 Exchange 组织中有用。
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-SkipPublicFolderInitialization
此参数仅在 2010 Exchange Server可用。
SkipPublicFolderInitialization 开关指定,如果要创建使用公用文件夹分发的 OAB,是否跳过立即创建 OAB 公用文件夹。 不必为此开关指定值。
在下一个站点文件夹维护周期完成之前,OAB 无法下载。 省略此开关可能会导致任务在与负责的公用文件夹服务器联系以创建必要的公用文件夹时暂停。 如果服务器当前无法访问,或者联系成本高昂,则暂停时间可能很大。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-Versions
此参数仅在 2010 Exchange Server可用。
Versions 参数指定针对客户端下载生成的 OAB 版本。 有效值包含:
- 版本 2 (需要公用文件夹分发)
- 版本 3 (需要公用文件夹分发)
- 版本 4 (默认值)
Type: | MultiValuedProperty |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010 |
-VirtualDirectories
此参数只在本地 Exchange 中可用。
VirtualDirectories 参数指定接受下载 OAB 请求的 OAB 虚拟目录。 这些位置是在自动发现服务中播发。
可以使用唯一标识虚拟目录的任何值。 例如:
- 名称或服务器\名称
- 可分辨名称 (DN)
- GUID
Name 值使用虚拟目录属性中的语法 "VirtualDirectoryName (WebsiteName)"
。 可以使用 语法 VirtualDirectoryName*
指定通配符 (*) 而不是默认网站。
此参数的默认值是客户端访问服务 (前端) 和后端 OAB 虚拟目录在邮箱服务器上保存 OAB 生成邮箱 (生成邮箱{bb558c35-97f1-4cb9-8ff7-d53741dc928c}) 。 例如,Mailbox01\OAB (默认网站) ,Mailbox01\OAB (Exchange 后端。
GlobalWebDistributionEnabled 参数的值必须是 $false,才能使用此参数。
在 Exchange 2013 CU7 或更高版本中,建议将 GlobalWebDistributionEnabled 参数设置为 $true,因为任何邮箱服务器上的客户端访问服务都可以将传入的 OAB 下载请求代理到正确的位置。
Type: | VirtualDirectoryIdParameter[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-WhatIf
WhatIf 开关模拟命令操作。 可以使用此开关在不实际应用将会发生的更改的情况下预览这些更改。 不必为此开关指定值。
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online |
输入
Input types
若要了解此 cmdlet 接受的输入类型,请参阅 cmdlet 的输入和输出类型。 如果 cmdlet 的"输入类型"字段为空,则表明此 cmdlet 不接受输入数据。
输出
Output types
若要了解此 cmdlet 接受的返回类型(亦称为"输出类型"),请参阅 cmdlet 的输入和输出类型。 如果"输出类型"字段为空,则表明此 cmdlet 不返回任何数据。