Logo

Documentation home for Transend tools

Export-KRODomains

SYNOPSIS

Exports domains from a Kerio tenant.

SYNTAX

Help

Export-KRODomains
  [-ShowPrereqs]
  [<CommonParameters>]

Action

Export-KRODomains
  -ConfigNode <String>
  [-Target <String>]
  [-Format <String>]
  [<CommonParameters>]

DESCRIPTION

Use the Export-KRODomains cmdlet to export domains from a Kerio tenant.

See the Notes section for cmdlet requirements.

EXAMPLES

Example 1: Export raw data

Export-KRODomains -ConfigNode Source -Format Csv >'domains.csv'

This example exports all domains from a Kerio tenant. The exported data is formatted as CSV and saved to the file domains.csv.

PARAMETERS

-ConfigNode

The config.psd1 configuration node to use.

Type: String
Parameter Sets: Action
Aliases:
Accepted values: Source, Target

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Format

The output type for exported data.

Note that extended properties cannot be serialized into CSV format. When using -Format Csv, extended properties will display as System.Collections.Hashtable in the output.

Type: String
Parameter Sets: Action
Aliases:
Accepted values: Csv, Json, Objects

Required: False
Position: Named
Default value: Objects
Accept pipeline input: False
Accept wildcard characters: False

-ShowPrereqs

Prints the cmdlet prerequisites.

Type: SwitchParameter
Parameter Sets: Help
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Target

Specifies a mapping target for the exported data. Exported data mapped for a supported target is directly consumable by a corresponding import cmdlet.

To export unmapped data, use -Target None.

Type: String
Parameter Sets: Action
Aliases:
Accepted values: None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

System.Object[]

NOTES

Required config.psd1 keys

These configuration keys are scoped to the Source or Target node in config.psd1.

  • KROJsonRpcServer: The GQDN or IP address of a Kerio server.

Optional config.psd1 keys

These configuration keys are scoped to the Source or Target node in config.psd1.

  • KROJsonRpcInsecure: Determines whether certificates will be checked for JSON-RPC API connections.

    Default: $false

  • KROJsonRpcPort: The port to connect to when making JSON-RPC API connections.

    Default: 9710

  • KROJsonRpcTlsProtocol: The TLS protocol version to use when making JSON-RPC API connections. Valid values are Default, Tls, Tls11, Tls12 and Tls13.

    Default: Default

Required APIs

  • JSON-RPC API

General configuration options