The configuration file format

A file containing individual settings must have the JavaScript Object Notation (JSON) format and .config extension.

Structure of a .config file

Top-level object

Pair

Required

Description

Name

Value
type

machines

array
of
objects

Yes

The machines for which you want to enable individual settings.

Each machine should be represented as an object (see the table below).

Machine object

Pair

Required

Description

Name

Value
type

mac address

string

Yes

A MAC address of a machine for which you want to enable individual settings.

The hexadecimal numbers in a MAC address can be separated by a colon (:) or a hyphen (-), or have no separator. Any set of six hexadecimal numbers is recognized as a valid MAC address of a machine, even if a network adapter with that address does not actually exist.

parameters

object

Yes

Any individual settings that you want to enable for this machine.

The value must be a set of the following pairs: the string identifier of a setting (as in the list of individual settings) and the object containing the setting options (see the table below).

Setting object

Pair

Required

Action during importing

Name

Value
type

Online deployment

activate_to_
win_pe

true or false

Yes

true: Select the WinPE-based media option.

false: Select the Acronis media option.

win_pe_image_
path

string

Yes, if activate_to_
win_pe is true

A non-empty value: Select the Specify a path to the media option and specify this value in the WinPE image path field.

An empty value: Select the Use the media from the master image option.

inject_manage
ment_agent

true or false

No

Select (true) or clear (false or not specified) the Install agent check box.

Target disk layout

target_disk_
number

string

Yes

"1": Select the Default disk option.

Any other numeric string: Select the Disk number in BIOS option and specify this value.

target_disk_
partition

string

Yes

"0": Select the Erase the target disk data... option.

Any other numeric string: Select the Replace volume option and specify this value.

Disk space utilization

entirely_disk_
space_occupy

true or false

Yes

true: Select the Resize volumes to fit target disk option.

false: Select the As in the master image option.

Machine name and membership

computer_name

string

Yes

Specify this value in the Machine name pattern field.

domain_member
ship_name

string

Yes, if adding
the machine to
an Active Directory
domain

Select the Domain option and specify this value as a domain name.

domain_user

string

Specify the user name of a domain administrator.

domain_
password

string

Specify the password of a domain administrator.

domain_
encoded

true or false

Encode the values specified in the domain_user and domain_password names.

This name must have the false value if you specify or modify the domain_user and domain_password names. Otherwise, the target machine will not be added to the domain.

work_group_
membership

string

Yes, if adding
the machine to
a workgroup

Select the Workgroup option and specify this value as a workgroup name.

TCP/IP properties

use_master_
image_network_
settings

true or false

Yes

Select (true) or clear (false) the Use the settings from the master image check box.

gateway

string

Yes, if use_master_
image_network_
settings is
false and
any of these names are
specified

Specify the default gateway (gateway), IP address (static_ip_address), and subnet mask (static_ip_mask).

If you want to obtain an IP address for the machine automatically, do not specify these names.

static_
ip_address

string

static_ip_mask

string

dns_ip_address

string

Yes, if use_master_
image_network_
settings is
false and
any of these names are
specified

Specify the DNS server IP address (dns_ip_address), name (dns_host_name), and domain name (dns_domain).

If you want to obtain a DNS server address for the machine automatically, do not specify these names.

dns_host_name

string

dns_domain

string

User accounts

user_accounts

object

Yes

Add user accounts.

The value must be a set of the following pairs: a group name and an array of objects containing the Username, Password, and Encoded names.

A group name can be any of the following: Administrators, Power users, or Users. The Username and Password names must have string values. The value of the Encoded name must be false.

Security identifier

sid_changing

true or false

Yes

Select (true) or clear (false) the Generate a unique SID for each deployed machine check box.

Action after deployment

post_deploy
ment_action

string

Yes

"Shutdown": Select the Shut down option.

"Restart": Select the Restart option.

"StayReady": Select the Make ready for deployment option.

If another value is specified, this name will be ignored.

Licensing

license_type

string

Yes

"PerDeploy": Select the Use deployment licenses option.

"PerMachine": Select the Use machine licenses option.

no_deploy
ment_
license_
action

string

Yes, if license_
type is
"PerDeploy"

"Stop": Select the Stop deployment option.

"UseMachineLicense": Select the Use a machine license automatically option.

no_machine_
license_
action

string

Yes, if license_
type is
"PerMachine"

"Stop": Select the Stop deployment option.

"UseDeploymentLicense": Select the Use a deployment license automatically option.

no_work
station_
license_
action

string

No

"Stop" or not specified: Select the Stop deployment option.

"UseServerLicense": Select the Use a server license automatically option.

Sample .config file

{
    "machines": [
        {
            "mac address": "AA:AA:AA:AA:AA:AA",
            "parameters": {
                "Online deployment": {
                    "activate_to_win_pe": "false",
                    "inject_management_agent": "false"
                },
                "Target disk layout": {
                    "target_disk_number": "1",
                    "target_partition_number": "0"
                },
                "Disk space utilization": {
                    "entirely_disk_space_occupy": "true"
                },
                "Machine name and membership": {
                    "computer_name": "Computer",
                    "work_group_membership": "WORKGROUP"
                },
                "TCP/IP properties": {
                    "use_master_image_network_settings": "false",
                    "gateway": "10.0.2.1",
                    "static_ip_address": "10.0.2.32",
                    "static_ip_mask": "255.255.255.0",
                    "dns_ip_address": "10.0.2.32",
                    "dns_host_name": "TEST-HOST",
                    "dns_domain": "asd.test"
                },
                "User accounts": {
                    "user_accounts": {
                        "Users": [
                            {
                                "Password": "pass",
                                "Username": "user",
                                "Encoded": "false"
                            }
                        ]
                    }
                },
                "Security identifier": {
                    "sid_changing": "true"
                },
                "Action after deployment": {
                    "post_deployment_action": "Shutdown"
                },
                "Licensing": {
                    "license_type": "PerDeploy",
                    "no_deployment_license_action": "UseMachineLicense"
                }
            }
        }
    ]
}