JSON Schema

Definitions

• ResourceObject (object): Resource object for advanced os-assets. Cannot contain additional properties.

  • resource_template_version (string, required)

  • datacenter: Refer to #/definitions/Datacenter.

  • user_ssh_key (array)

    • Items (string)

  • user_custom_variables (array)

    • Items: Refer to #/definitions/UserCustomVariable.

  • management_ssh_key (string, required)

  • infrastructure_id (integer, required)

  • infrastructure_label (string, required)

  • infrastructure_subdomain_permanent (string, required)

  • infrastructure_custom_variables (array)

    • Items: Refer to #/definitions/InfrastructureCustomVariable.

  • instance_array_id (integer, required)

  • instance_array_label (string, required)

  • instance_array_subdomain_permanent (string, required)

  • instance_array_custom_variables (array)

    • Items: Refer to #/definitions/InstanceArrayCustomVariable.

  • instance_id (integer, required)

  • instance_label (string, required)

  • instance_subdomain_permanent (string, required)

  • instance_subdomain_base (string, required)

  • initial_username (string)

  • initial_password (string, required)

  • iscsi: Refer to #/definitions/Iscsi.

  • instance_custom_variables (array)

    • Items: Refer to #/definitions/InstanceCustomVariable.

  • server: Refer to #/definitions/Server.

  • drive_arrays (array)

    • Items: Refer to #/definitions/DriveArray.

  • shared_drives (array)

    • Items: Refer to #/definitions/SharedDrive.

  • file_shares (array)

    • Items: Refer to #/definitions/FileShare.

  • storage_configuration: Refer to #/definitions/StorageConfiguration.

  • network_configuration: Refer to #/definitions/NetworkConfiguration.

• Datacenter (object): Cannot contain additional properties.

  • name (string, required)

  • repo_url_root (string, format: uri, required)

  • repo_url_root_quarantine_network (string, format: uri, required)

  • dns_servers (array, required)

    • Items

      • Any of

        • string, format: ipv4

        • string, format: ipv6

  • ntp_servers (array, required)

    • Items

      • Any of

        • string, format: ipv4

        • string, format: ipv6

  • nfs_server

    • Any of

      • string, format: ipv4

      • string, format: ipv6

  • web_proxy: Refer to #/definitions/WebProxy.

  • kms (string, format: ipv4)

  • samba_server: Refer to #/definitions/SambaServer.

• WebProxy (object): Cannot contain additional properties.

  • server_ip (string, format: ipv4, required)

  • server_port (integer, required)

  • username (string, required)

  • password (string, required)

• SambaServer (object): Cannot contain additional properties.

  • samba_server_ip (string, format: ipv4, required)

  • samba_server_hostname (string)

  • samba_server_password (string, required)

  • samba_server_username (string, required)

  • samba_server_windows_kit_share_name (string, required)

• UserCustomVariable (array): Length must be at least 1.

  • Items ([‘object’])

• InfrastructureCustomVariable (array): Length must be at least 1.

  • Items ([‘object’])

• InstanceArrayCustomVariable (array): Length must be at least 1.

  • Items ([‘object’])

• Iscsi (object): Cannot contain additional properties.

  • initiator_iqn (string, required)

  • chap_username (string, required)

  • chap_password (string, required)

• InstanceCustomVariable (array): Length must be at least 1.

  • Items ([‘object’])

• Server (object): Cannot contain additional properties.

  • type (string, required)

  • serial_number (string, required)

  • disks (array)

    • Items: Refer to #/definitions/Disk.

  • network_interfaces (array, required)

    • Items: Refer to #/definitions/NetworkInterface.

• Disk (object): Cannot contain additional properties.

  • id (integer, required)

  • model (string)

  • size (integer, required)

  • vendor (string)

  • serial_number (string, required)

  • wwn (string)

  • disk_type (string, required)

• NetworkInterface (object): Cannot contain additional properties.

  • interface_index (integer, required): The Index of the interface as it appears in the system after registration.

  • alias_index (integer): Index of the interface in the Operating System.

  • protocol (string, required)

  • capacity (integer, required)

  • mac_address (string, required)

• DriveArray (object): Cannot contain additional properties.

  • id (integer, required)

  • storage_type (string, required)

  • storage_protocol (string, required)

  • lun_id_hex (integer, required)

  • lun_id_dec (integer, required)

  • wwid (string, required)

  • targets (array, required)

    • Items (object): Can contain additional properties.

      • Additional properties: Refer to #/definitions/Target.

  • multipath (boolean, required)

• SharedDrive (object): Cannot contain additional properties.

  • id (integer, required)

  • storage_type (string, required)

  • storage_protocol (string, required)

  • lun_id_hex (integer, required)

  • lun_id_dec (integer, required)

  • wwid (string, required)

  • targets (array, required)

    • Items (object): Can contain additional properties.

      • Additional properties: Refer to #/definitions/Target.

  • multipath (boolean, required)

• FileShare (object): Cannot contain additional properties.

  • id (integer, required)

  • endpoint (string, required)

• Target (object): Cannot contain additional properties.

  • name (string, required)

  • portals (array, required)

    • Items: Refer to #/definitions/Portal.

• Portal (object): Cannot contain additional properties.

  • ip (string, required)

  • ip_type (string, required): Must be one of: ["ipv4", "ipv6"].

  • port (integer, required)

• StorageConfiguration (object): Cannot contain additional properties.

  • install_disk: Refer to #/definitions/InstallDisk.

  • layout (string)

• InstallDisk (object): Cannot contain additional properties.

  • Any of

  • id (integer)

  • size (string)

  • serial (string)

  • path (string)

• NetworkConfiguration (object): Cannot contain additional properties.

  • interfaces (array, required)

    • Items: Refer to #/definitions/Interface.

• Interface (object): Cannot contain additional properties.

  • network_type (string, required): The type of network this interface is connected to. Must be one of: ["wan", "san", "lan", "qrt"].

  • network_id (integer, required): The ID of the network this interface is connected to.

  • network_label (string): The label of the network this interface is connected to.

  • interface_index (integer): The Index of the interface as it appears in the system after registration.

  • alias_index (integer): Index of the interface in the Operating System.

  • mac_address (string): The MAC address of the interface.

  • interface_type (string, required): The type of interface. Must be one of: ["physical", "bond", "vlan"].

  • type_interface_id (integer, required): The ID of the interface by network type with should be assigned in order from 0 to n. Each group of interfaces by network type and network ID should have there own sequence of IDs.

  • dhcp4 (boolean)

  • dhcp6 (boolean)

  • optional (boolean)

  • critical (boolean)

  • members (array)

    • Items: Refer to #/definitions/Member.

  • mtu (integer)

  • ipv4_addresses (array)

    • Items: Refer to #/definitions/Ipv4Address.

  • ipv6_addresses (array)

    • Items: Refer to #/definitions/Ipv6Address.

  • routes (array)

    • Items: Refer to #/definitions/Route.

  • parameters: Refer to #/definitions/Parameters.

  • dns_nameservers: Refer to #/definitions/DNSNameservers.

  • vlan_id (integer)

  • link: Refer to #/definitions/Link.

• Member (object): Cannot contain additional properties.

  • id (integer, required): Type interface ID of the underlying device on which this Bond gets created.

  • type (string, required): The interface type of the underlying device on which this Bond gets created. Default: "physical".

• Link (object): Cannot contain additional properties.

  • id (integer, required): Type interface ID of the underlying device on which this VLAN gets created.

  • type (string, required): The interface type of the underlying device on which this VLAN gets created. Must be one of: ["physical", "bond"].

• Ipv4Address (object): Cannot contain additional properties.

  • ip (string, format: ipv4, required)

  • cidr (string, required)

  • netmask (string, required)

  • mask_bits (integer, required)

  • gateway (string, format: ipv4, required)

• Ipv6Address (object): Cannot contain additional properties.

  • ip (string, format: ipv6, required)

  • cidr (string, required)

  • mask_bits (integer, required)

  • gateway (string, format: ipv6, required)

• Route (object): Cannot contain additional properties.

  • to (string, required)

  • via

    • Any of

      • string, format: ipv4

      • string, format: ipv6

  • metric (integer)

  • on_link (boolean)

  • table (integer)

• Parameters (object): Cannot contain additional properties.

  • mode (string, required)

  • lacp_rate (string)

  • mii_monitor_interval (integer)

  • transmit_hash_policy (string)

• DNSNameservers (object): Cannot contain additional properties.

  • addresses (array, required)

    • Items

      • Any of

        • string, format: ipv4

        • string, format: ipv6

  • search_domains (array)

    • Items (string)