Files
terraform-provider-binarylane/provider_code_spec.json
T

1583 lines
60 KiB
JSON

{
"datasources": [
{
"name": "server",
"schema": {
"attributes": [
{
"name": "id",
"int64": {
"computed_optional_required": "required",
"description": "The ID of the server to fetch."
}
}
]
}
}
],
"provider": {
"name": "binarylane"
},
"resources": [
{
"name": "server",
"schema": {
"attributes": [
{
"name": "backups",
"bool": {
"computed_optional_required": "computed_optional",
"description": "If true this will enable two daily backups for the server. Options.daily_backups will override this value if provided. Setting this to false has no effect.\n"
}
},
{
"name": "image",
"string": {
"computed_optional_required": "required",
"description": "The slug of the selected operating system."
}
},
{
"name": "ipv6",
"bool": {
"computed_optional_required": "computed_optional",
"description": "If true this will enable IPv6 for this server."
}
},
{
"name": "licenses",
"list_nested": {
"computed_optional_required": "computed_optional",
"nested_object": {
"attributes": [
{
"name": "count",
"int64": {
"computed_optional_required": "required",
"description": "The number of licences."
}
},
{
"name": "software_id",
"int64": {
"computed_optional_required": "required",
"description": "The ID of the software to license."
}
}
]
},
"description": "The desired set of licenses."
}
},
{
"name": "name",
"string": {
"computed_optional_required": "computed_optional",
"description": "The hostname of your server, such as vps01.yourcompany.com. If not provided, the server will be created with a random name."
}
},
{
"name": "options1",
"single_nested": {
"computed_optional_required": "computed_optional",
"attributes": [
{
"name": "daily_backups",
"int64": {
"computed_optional_required": "computed_optional",
"description": "Leave null to accept the default for the size if this is a new server or to keep the current value if this is a resize of an existing server.",
"validators": [
{
"custom": {
"imports": [
{
"path": "github.com/hashicorp/terraform-plugin-framework-validators/int64validator"
}
],
"schema_definition": "int64validator.Between(0, 14)"
}
}
]
}
},
{
"name": "disk",
"int64": {
"computed_optional_required": "computed_optional",
"description": "The total storage in GB for this server.\nIf specified this is the absolute value, not just the additional storage above what is included in the size.\nLeave null to accept the default for the size if this is a new server or a resize to a different base size, or to keep the current value if this a resize with the same base size but different options.\n \nValid values for sizes that do not provide a value for options.restricted_storage_values_gb:\n- must be a multiple of 5\n- \u0026gt; 60GB must be a multiple of 10\n- \u0026gt; 200GB must be a multiple of 100"
}
},
{
"name": "ipv4_addresses",
"int64": {
"computed_optional_required": "computed_optional",
"description": "The total count of IPv4 addresses for this server. If specified this is the absolute value, not just the additional IPv4 addresses above what is included in the size. Leave null to accept the default for the size if this is a new server or to keep the current value if this is a resize of an existing server. Must not exceed the size.ipv4_addresses_max value.",
"validators": [
{
"custom": {
"imports": [
{
"path": "github.com/hashicorp/terraform-plugin-framework-validators/int64validator"
}
],
"schema_definition": "int64validator.Between(0, 2147483647)"
}
}
]
}
},
{
"name": "memory",
"int64": {
"computed_optional_required": "computed_optional",
"description": "The total memory in MB for this server.\nIf specified this is the absolute value, not just the additional memory above what is included in the size.\nLeave null to accept the default for the size if this is a new server or a resize to a different base size, or to keep the current value if this a resize with the same base size but different options.\n \nValid values:\n- must be a multiple of 128\n- \u0026gt; 2048MB must be a multiple of 1024\n- \u0026gt; 16384MB must be a multiple of 2048\n- \u0026gt; 24576MB must be a multiple of 4096"
}
},
{
"name": "monthly_backups",
"int64": {
"computed_optional_required": "computed_optional",
"description": "Leave null to accept the default for the size if this is a new server or to keep the current value if this is a resize of an existing server.",
"validators": [
{
"custom": {
"imports": [
{
"path": "github.com/hashicorp/terraform-plugin-framework-validators/int64validator"
}
],
"schema_definition": "int64validator.Between(0, 12)"
}
}
]
}
},
{
"name": "offsite_backups",
"bool": {
"computed_optional_required": "computed_optional",
"description": "Leave null to accept the default for the size if this is a new server or to keep the current value if this is a resize of an existing server."
}
},
{
"name": "transfer",
"float64": {
"computed_optional_required": "computed_optional",
"description": "The total transfer per month in TB for this server.\nIf specified this is the absolute value, not just the additional transfer above what is included in the size.\nLeave null to accept the default for the size if this is a new server or a resize to a different base size, or to keep the current value if this a resize with the same base size but different options.\n \nValid values (when converted to GB by multiplying the value provided by 1024):\n- must be a multiple of 5GB\n- \u0026gt; 30GB must be a multiple of 10\n- \u0026gt; 200GB must be a multiple of 100\n- \u0026gt; 2000GB must be a multiple of 1000"
}
},
{
"name": "weekly_backups",
"int64": {
"computed_optional_required": "computed_optional",
"description": "Leave null to accept the default for the size if this is a new server or to keep the current value if this is a resize of an existing server.",
"validators": [
{
"custom": {
"imports": [
{
"path": "github.com/hashicorp/terraform-plugin-framework-validators/int64validator"
}
],
"schema_definition": "int64validator.Between(0, 13)"
}
}
]
}
}
],
"description": "This may be left null to accept all of the defaults for the selected size."
}
},
{
"name": "password",
"string": {
"computed_optional_required": "computed_optional",
"description": "If this is provided the specified or default remote user's account password will be set to this value. Only valid if the server supports password change actions (check server.password_change_supported via the servers endpoint). If omitted and the server supports password change actions a random password will be generated and emailed to the account email address.\n"
}
},
{
"name": "port_blocking",
"bool": {
"computed_optional_required": "computed_optional",
"description": "Port blocking of outgoing connections for email, SSH and Remote Desktop (TCP ports 22, 25, and 3389) is enabled by default for all new servers. If this is false port blocking will be disabled. Disabling port blocking is only available to reviewed accounts."
}
},
{
"name": "region",
"string": {
"computed_optional_required": "required",
"description": "The slug of the selected region.",
"validators": [
{
"custom": {
"imports": [
{
"path": "github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
}
],
"schema_definition": "stringvalidator.LengthAtLeast(1)"
}
}
]
}
},
{
"name": "size",
"string": {
"computed_optional_required": "required",
"description": "The slug of the selected size.",
"validators": [
{
"custom": {
"imports": [
{
"path": "github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
}
],
"schema_definition": "stringvalidator.LengthAtLeast(1)"
}
}
]
}
},
{
"name": "ssh_keys",
"list": {
"computed_optional_required": "computed_optional",
"element_type": {
"string": {}
},
"description": "This may be either the SSH keys Ids or fingerprints. If this is null or not provided any SSH keys that have been marked as default will be deployed (if the operating system supports SSH keys). Submit an empty array to disable deployment of default keys."
}
},
{
"name": "user_data",
"string": {
"computed_optional_required": "computed_optional",
"description": "If provided this will be used to initialise the new server. This must be left null if the Image does not support UserData, see DistributionInfo.Features for more information.",
"validators": [
{
"custom": {
"imports": [
{
"path": "github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
}
],
"schema_definition": "stringvalidator.LengthAtMost(65536)"
}
}
]
}
},
{
"name": "vpc_id",
"int64": {
"computed_optional_required": "computed_optional",
"description": "Leave null to use default (public) network for the selected region."
}
},
{
"name": "links",
"single_nested": {
"computed_optional_required": "computed",
"attributes": [
{
"name": "actions",
"list_nested": {
"computed_optional_required": "computed",
"nested_object": {
"attributes": [
{
"name": "href",
"string": {
"computed_optional_required": "computed"
}
},
{
"name": "id",
"int64": {
"computed_optional_required": "computed"
}
},
{
"name": "rel",
"string": {
"computed_optional_required": "computed"
}
}
]
}
}
}
]
}
},
{
"name": "server",
"single_nested": {
"computed_optional_required": "computed",
"attributes": [
{
"name": "advanced_features",
"single_nested": {
"computed_optional_required": "computed",
"attributes": [
{
"name": "enabled_advanced_features",
"list": {
"computed_optional_required": "computed",
"element_type": {
"string": {}
},
"description": "A list of the currently enabled advanced features for this server."
}
},
{
"name": "machine_type",
"string": {
"computed_optional_required": "computed",
"description": "The machine_type (corresponding to a KVM version) used for this server.\nA null value indicates automatic selection of the best KVM machine type supported by the host node."
}
},
{
"name": "processor_model",
"int64": {
"computed_optional_required": "computed",
"description": "The ID of the processor model (and therefore CPU flags) available for this server.\nA null value indicates automatic selection of the best processor model supported by the host node.\nThis does not change the physical CPU, only the CPU flags available to the operating system."
}
},
{
"name": "video_device",
"string": {
"computed_optional_required": "computed",
"description": "Video Device\n\n| Value | Description |\n| ----- | ----------- |\n| cirrus-logic | Cirrus Logic GD5446 |\n| standard | Standard VGA with VESA 2.0 extensions |\n| virtio | Virtio VGA (800x600) |\n| virtio-wide | Virtio VGA (1600x900) |\n\n"
}
}
],
"description": "The currently enabled advanced features, machine type and processor flags."
}
},
{
"name": "attached_backup",
"single_nested": {
"computed_optional_required": "computed",
"attributes": [
{
"name": "attached_at",
"string": {
"computed_optional_required": "computed",
"description": "The date and time in ISO8601 format when this image was attached to the server."
}
},
{
"name": "attachment_expires",
"string": {
"computed_optional_required": "computed",
"description": "The date and time in ISO8601 format when the backup will be automatically detached unless it is manually detached earlier."
}
},
{
"name": "disk_identifiers",
"list": {
"computed_optional_required": "computed",
"element_type": {
"string": {}
},
"description": "A list of the operating specific disk identifiers for the attached backup disks."
}
},
{
"name": "id",
"int64": {
"computed_optional_required": "computed",
"description": "The ID of the backup image."
}
}
],
"description": "An object that provides details of any backup image currently attached to the server.."
}
},
{
"name": "backup_ids",
"list": {
"computed_optional_required": "computed",
"element_type": {
"int64": {}
},
"description": "A list of the currently existing backup image IDs for this server (if any)."
}
},
{
"name": "backup_settings",
"single_nested": {
"computed_optional_required": "computed",
"attributes": [
{
"name": "backup_day_of_month",
"int64": {
"computed_optional_required": "computed",
"description": "If monthly backups are enabled the day of the month the monthly backup will occur."
}
},
{
"name": "backup_day_of_week",
"int64": {
"computed_optional_required": "computed",
"description": "If weekly backups are enabled the day of the week that the weekly backup will occur. Sunday is day 0."
}
},
{
"name": "backup_hour_of_day",
"int64": {
"computed_optional_required": "computed",
"description": "The hour of the day that backups will be scheduled. This is an approximate value."
}
},
{
"name": "offsite_backup_settings",
"single_nested": {
"computed_optional_required": "computed",
"attributes": [
{
"name": "manage_offsite_copies",
"bool": {
"computed_optional_required": "computed",
"description": "This only has effect if a custom offsite location is being used: the internal offsite backup location always manages copies.\nIf this is true old offsite backups will be removed once the replacement upload is complete.\nIf this is false backups must be removed from the Amazon S3 bucket manually. Amazon will charge your S3 account at their standard rate for every backup stored."
}
},
{
"name": "offsite_backup_location",
"string": {
"computed_optional_required": "computed",
"description": "If a custom backup location is used, this is the provided location."
}
},
{
"name": "use_custom_backup_location",
"bool": {
"computed_optional_required": "computed",
"description": "If this is true a custom backup location will be used. If false our internally managed offsite backup location be used."
}
}
],
"description": "If offsite backups are enabled this details how they are stored and managed."
}
}
],
"description": "Detailed backup settings for the server."
}
},
{
"name": "cancelled_at",
"string": {
"computed_optional_required": "computed",
"description": "If the server has been cancelled, this is the date and time in ISO8601 format of that cancellation."
}
},
{
"name": "created_at",
"string": {
"computed_optional_required": "computed",
"description": "The date and time in ISO8601 format of this server's initial creation."
}
},
{
"name": "disk",
"int64": {
"computed_optional_required": "computed",
"description": "The total disk in GB of this server."
}
},
{
"name": "disks",
"list_nested": {
"computed_optional_required": "computed",
"nested_object": {
"attributes": [
{
"name": "description",
"string": {
"computed_optional_required": "computed",
"description": "A description of this disk."
}
},
{
"name": "id",
"int64": {
"computed_optional_required": "computed",
"description": "The ID of this disk."
}
},
{
"name": "primary",
"bool": {
"computed_optional_required": "computed",
"description": "A primary disk is treated differently from other disks."
}
},
{
"name": "size_gigabytes",
"float64": {
"computed_optional_required": "computed",
"description": "The size of the disk in GB."
}
}
]
},
"description": "A list of the disks that are currently attached to the server."
}
},
{
"name": "failover_ips",
"list": {
"computed_optional_required": "computed",
"element_type": {
"string": {}
},
"description": "A list of any assigned failover IP addresses for this server."
}
},
{
"name": "features",
"list": {
"computed_optional_required": "computed",
"element_type": {
"string": {}
},
"description": "A list of the currently enabled features on this server."
}
},
{
"name": "host",
"single_nested": {
"computed_optional_required": "computed",
"attributes": [
{
"name": "display_name",
"string": {
"computed_optional_required": "computed",
"description": "The name for this host."
}
},
{
"name": "status_page",
"string": {
"computed_optional_required": "computed",
"description": "This is the URL of the status page of the host. This will normally only be set if the host is under maintenance."
}
},
{
"name": "uptime_ms",
"int64": {
"computed_optional_required": "computed",
"description": "The current uptime in milliseconds of this host."
}
}
],
"description": "Summary information about the host of this server."
}
},
{
"name": "id",
"int64": {
"computed_optional_required": "computed",
"description": "The ID of this server."
}
},
{
"name": "image",
"single_nested": {
"computed_optional_required": "computed",
"attributes": [
{
"name": "backup_info",
"single_nested": {
"computed_optional_required": "computed",
"attributes": [
{
"name": "backup_disks",
"list_nested": {
"computed_optional_required": "computed",
"nested_object": {
"attributes": [
{
"name": "description",
"string": {
"computed_optional_required": "computed",
"description": "A description of this disk."
}
},
{
"name": "id",
"int64": {
"computed_optional_required": "computed",
"description": "The ID of this backup disk."
}
},
{
"name": "min_disk_size",
"int64": {
"computed_optional_required": "computed",
"description": "This is the minimum disk size in GB required to restore this disk image."
}
},
{
"name": "size_gigabytes",
"float64": {
"computed_optional_required": "computed",
"description": "This is the compressed size of the disk image in GB."
}
}
]
},
"description": "A list of the individual disks that make up this backup."
}
},
{
"name": "iso",
"bool": {
"computed_optional_required": "computed",
"description": "If this is true the backup is an ISO image and cannot be restored. ISO images may only be attached for use as a boot disk or an additional disk."
}
},
{
"name": "locked",
"bool": {
"computed_optional_required": "computed",
"description": "If this is true the backup is locked and cannot be replaced."
}
},
{
"name": "offsite",
"bool": {
"computed_optional_required": "computed",
"description": "If this is true, an attempt to create an offsite copy was made. This does not mean that the offsite copy attempt was successful or that the copy still exists."
}
},
{
"name": "server_id",
"int64": {
"computed_optional_required": "computed",
"description": "The server ID that was used to create this backup."
}
},
{
"name": "type",
"string": {
"computed_optional_required": "computed",
"description": "\n| Value | Description |\n| ----- | ----------- |\n| daily | A backup which is scheduled to be taken each day. |\n| weekly | A backup which is scheduled to be taken each week. |\n| monthly | A backup which is scheduled to be taken each month. |\n| temporary | A backup which is created on demand and only retained for a maximum of seven days. |\n\n"
}
}
],
"description": "If this image is a backup, this object will provide further information."
}
},
{
"name": "created_at",
"string": {
"computed_optional_required": "computed",
"description": "If this is a backup image this is the date and time in ISO8601 format when the image was created."
}
},
{
"name": "description",
"string": {
"computed_optional_required": "computed",
"description": "A description that may provide further details or warnings about the image."
}
},
{
"name": "distribution",
"string": {
"computed_optional_required": "computed",
"description": "If this is an operating system image, this is the name of the distribution. If this is a backup image, this is the name of the distribution the server is using."
}
},
{
"name": "distribution_info",
"single_nested": {
"computed_optional_required": "computed",
"attributes": [
{
"name": "features",
"list": {
"computed_optional_required": "computed",
"element_type": {
"string": {}
},
"description": "Features supported by this distribution."
}
},
{
"name": "image_id",
"int64": {
"computed_optional_required": "computed",
"description": "If this is a backup image, the operating system ID of the server at the time the backup was created."
}
},
{
"name": "password_recovery",
"string": {
"computed_optional_required": "computed",
"description": "Supported methods of password recovery.\n\n| Value | Description |\n| ----- | ----------- |\n| manual | Password must be reset manually using the recovery console and rescue disk. |\n| offline-clear | Password can be cleared for the admin/root user only. New password needs to be provided on login via the console (Requires restart). |\n| offline-change | Password can be reset and new credentials sent (Requires restart). |\n| online-change | Password may be reset without requiring a reboot via installed QEMU Guest Agent. |\n\n"
}
},
{
"name": "remote_access_user",
"string": {
"computed_optional_required": "computed",
"description": "User name to use when connecting via remote access (RDP or SSH)."
}
}
],
"description": "This object may provide further information about the distribution."
}
},
{
"name": "distribution_surcharges",
"single_nested": {
"computed_optional_required": "computed",
"attributes": [
{
"name": "surcharge_base_cost",
"float64": {
"computed_optional_required": "computed",
"description": "The additional cost for using this operating system as the base image for a size."
}
},
{
"name": "surcharge_min_vcpu",
"int64": {
"computed_optional_required": "computed",
"description": "The minimum vcpu count for surcharge calculations."
}
},
{
"name": "surcharge_per_memory_max_megabytes",
"int64": {
"computed_optional_required": "computed",
"description": "The maximum memory in MB that counts towards the surcharge_per_memory_mb. Any memory above this cap does not attract the surcharge."
}
},
{
"name": "surcharge_per_memory_megabyte",
"float64": {
"computed_optional_required": "computed",
"description": "The additional cost per MB for using this operating system as the base image for a size."
}
},
{
"name": "surcharge_per_vcpu",
"float64": {
"computed_optional_required": "computed",
"description": "The additional cost per vcpu for using this operating system as the base image for a size."
}
}
],
"description": "If this is not null the use of this image may incur surcharges above the base cost of the server. All costs are in AU$."
}
},
{
"name": "error_message",
"string": {
"computed_optional_required": "computed",
"description": "If the image creation failed this may provide further information."
}
},
{
"name": "full_name",
"string": {
"computed_optional_required": "computed",
"description": "If this is an operating system image, this is the name and version of the distribution. If this is a backup image, this is the server hostname and label of the backup if it exists, otherwise it is the server hostname and UTC timestamp of the creation of the image."
}
},
{
"name": "id",
"int64": {
"computed_optional_required": "computed",
"description": "The ID of this image."
}
},
{
"name": "min_disk_size",
"int64": {
"computed_optional_required": "computed",
"description": "For a distribution image this is the minimum disk size in GB required to install the operating system. For a backup image this is the minimum total disk size in GB required to restore the backup."
}
},
{
"name": "min_memory_megabytes",
"int64": {
"computed_optional_required": "computed",
"description": "This is minimum memory in MB necessary to support this operating system (or the base operating system for a backup image)."
}
},
{
"name": "name",
"string": {
"computed_optional_required": "computed",
"description": "If this is an operating system image, this is the name of the operating system version. If this is a backup image, this is the label of the backup if it exists, otherwise it is the UTC timestamp of the creation of the image."
}
},
{
"name": "public",
"bool": {
"computed_optional_required": "computed",
"description": "A public image is available to all users. A private image is available only to the account that created the image."
}
},
{
"name": "regions",
"list": {
"computed_optional_required": "computed",
"element_type": {
"string": {}
},
"description": "The slugs of the regions where the image is available for use."
}
},
{
"name": "size_gigabytes",
"float64": {
"computed_optional_required": "computed",
"description": "For a distribution image this is the disk size used in GB by the operating system on initial install. For a backup image this is the size of the compressed backup image in GB."
}
},
{
"name": "slug",
"string": {
"computed_optional_required": "computed",
"description": "If this is an operating system image this is a slug which may be used as an alternative to the ID as a reference."
}
},
{
"name": "status",
"string": {
"computed_optional_required": "computed",
"description": "\n| Value | Description |\n| ----- | ----------- |\n| NEW | The image is new. |\n| available | The image is available for use. |\n| pending | The image is pending and is not yet available for use. |\n| deleted | The image has been deleted and is no longer available for use. |\n\n"
}
},
{
"name": "type",
"string": {
"computed_optional_required": "computed",
"description": "\n| Value | Description |\n| ----- | ----------- |\n| custom | An image uploaded by a user. |\n| snapshot | A snapshot. Snapshot creation is not currently supported so only distribution images will have this value. |\n| backup | A backup of a server. |\n\n"
}
}
],
"description": "The base image used to create this server."
}
},
{
"name": "kernel",
"single_nested": {
"computed_optional_required": "computed",
"attributes": [
{
"name": "id",
"int64": {
"computed_optional_required": "computed",
"description": "The ID of this kernel."
}
},
{
"name": "name",
"string": {
"computed_optional_required": "computed",
"description": "This name of this kernel."
}
},
{
"name": "version",
"string": {
"computed_optional_required": "computed",
"description": "The version (if any) of this kernel."
}
}
],
"description": "The currently selected kernel for the server."
}
},
{
"name": "memory",
"int64": {
"computed_optional_required": "computed",
"description": "The memory in MB of this server."
}
},
{
"name": "name",
"string": {
"computed_optional_required": "computed",
"description": "The hostname of this server."
}
},
{
"name": "networks",
"single_nested": {
"computed_optional_required": "computed",
"attributes": [
{
"name": "ipv6_reverse_nameservers",
"list": {
"computed_optional_required": "computed",
"element_type": {
"string": {}
},
"description": "Any configured IPv6 reverse nameservers for this server. Please see our documentation for how this interacts with IPv6 nameserver settings at the account level."
}
},
{
"name": "port_blocking",
"bool": {
"computed_optional_required": "computed",
"description": "Whether the default port blocking is enabled for this server."
}
},
{
"name": "recent_ddos",
"bool": {
"computed_optional_required": "computed",
"description": "If this is true this server has been the target of a recent DDOS attack. An email will have been sent to your email address when the DDOS was detected (and if it has ended, when it ended) with more details."
}
},
{
"name": "separate_private_network_interface",
"bool": {
"computed_optional_required": "computed",
"description": "Whether a separate private network interface is provided for the server's VPC traffic."
}
},
{
"name": "source_and_destination_check",
"bool": {
"computed_optional_required": "computed",
"description": "If enabled, this server is only able to send and receive data packets directly addressed to an IP address assigned to this server."
}
},
{
"name": "v4",
"list_nested": {
"computed_optional_required": "computed",
"nested_object": {
"attributes": [
{
"name": "gateway",
"string": {
"computed_optional_required": "computed",
"description": "The gateway for this network."
}
},
{
"name": "ip_address",
"string": {
"computed_optional_required": "computed",
"description": "The IP address for this network."
}
},
{
"name": "nat_target",
"string": {
"computed_optional_required": "computed",
"description": "If this is not null this property is the private IP address which receives packets from this network."
}
},
{
"name": "netmask",
"string": {
"computed_optional_required": "computed"
}
},
{
"name": "reverse_name",
"string": {
"computed_optional_required": "computed",
"description": "The reverse name (if any) for this network."
}
},
{
"name": "type",
"string": {
"computed_optional_required": "computed",
"description": "\n| Value | Description |\n| ----- | ----------- |\n| private | A private (non internet accessible) network. |\n| public | A public (internet accessible) network. |\n\n"
}
}
]
},
"description": "A list of the IPv4 networks for this server."
}
},
{
"name": "v6",
"list_nested": {
"computed_optional_required": "computed",
"nested_object": {
"attributes": [
{
"name": "gateway",
"string": {
"computed_optional_required": "computed",
"description": "The gateway for this network."
}
},
{
"name": "ip_address",
"string": {
"computed_optional_required": "computed",
"description": "The IP address for this network."
}
},
{
"name": "nat_target",
"string": {
"computed_optional_required": "computed",
"description": "If this is not null this property is the private IP address which receives packets from this network."
}
},
{
"name": "netmask",
"string": {
"computed_optional_required": "computed"
}
},
{
"name": "reverse_name",
"string": {
"computed_optional_required": "computed",
"description": "The reverse name (if any) for this network."
}
},
{
"name": "type",
"string": {
"computed_optional_required": "computed",
"description": "\n| Value | Description |\n| ----- | ----------- |\n| private | A private (non internet accessible) network. |\n| public | A public (internet accessible) network. |\n\n"
}
}
]
},
"description": "A list of the IPv6 networks for this server."
}
}
],
"description": "A list of the networks of the server."
}
},
{
"name": "next_backup_window",
"single_nested": {
"computed_optional_required": "computed",
"attributes": [
{
"name": "end",
"string": {
"computed_optional_required": "computed",
"description": "The expected latest date and time in ISO8601 format of the next scheduled backup.\nThis is not a guarantee that the backup will have started or completed by this date and time."
}
},
{
"name": "start",
"string": {
"computed_optional_required": "computed",
"description": "The approximate earliest start date and time in ISO8601 format of the next scheduled backup."
}
}
],
"description": "The details of the next scheduled backup, if any."
}
},
{
"name": "partner_id",
"int64": {
"computed_optional_required": "computed",
"description": "The server ID of the partner of this server, if one has been assigned."
}
},
{
"name": "password_change_supported",
"bool": {
"computed_optional_required": "computed",
"description": "If this is true the password_reset server action can be called to change a user's password. If this is false the password_reset server action will merely clear the root/administrator password allowing the password to be changed via the web console."
}
},
{
"name": "permalink",
"string": {
"computed_optional_required": "computed",
"description": "A randomly generated two-word identifier assigned to servers in regions that support this feature."
}
},
{
"name": "region",
"single_nested": {
"computed_optional_required": "computed",
"attributes": [
{
"name": "available",
"bool": {
"computed_optional_required": "computed",
"description": "Whether this region is available for the allocation of new resources."
}
},
{
"name": "features",
"list": {
"computed_optional_required": "computed",
"element_type": {
"string": {}
},
"description": "A list of features available for resources in this region."
}
},
{
"name": "name",
"string": {
"computed_optional_required": "computed",
"description": "The name of this region."
}
},
{
"name": "name_servers",
"list": {
"computed_optional_required": "computed",
"element_type": {
"string": {}
},
"description": "A list of nameservers available for resources in this region."
}
},
{
"name": "sizes",
"list": {
"computed_optional_required": "computed",
"element_type": {
"string": {}
},
"description": "The slugs of the sizes available in this region."
}
},
{
"name": "slug",
"string": {
"computed_optional_required": "computed",
"description": "The unique slug for this region."
}
}
],
"description": "The region this server is allocated to."
}
},
{
"name": "selected_size_options",
"single_nested": {
"computed_optional_required": "computed",
"attributes": [
{
"name": "daily_backups",
"int64": {
"computed_optional_required": "computed",
"description": "The number of retained daily backups. e.g. if this is '2' we will store two daily backups, so each daily backup will be retained for two days before being overwritten."
}
},
{
"name": "disk",
"int64": {
"computed_optional_required": "computed",
"description": "The total storage in GB for this server."
}
},
{
"name": "ipv4_addresses",
"int64": {
"computed_optional_required": "computed",
"description": "The total count of IPv4 addresses for this server."
}
},
{
"name": "memory",
"int64": {
"computed_optional_required": "computed",
"description": "The total memory in MB for this server."
}
},
{
"name": "monthly_backups",
"int64": {
"computed_optional_required": "computed",
"description": "The number of retained monthly backups. e.g. if this is '3' we will store three monthly backups, so each monthly backup will be retained for three months before being overwritten."
}
},
{
"name": "offsite_backups",
"bool": {
"computed_optional_required": "computed",
"description": "If this is true any daily, weekly or monthly backups will be duplicated to an off-site location."
}
},
{
"name": "transfer",
"float64": {
"computed_optional_required": "computed",
"description": "The total transfer per month in TB for this server."
}
},
{
"name": "weekly_backups",
"int64": {
"computed_optional_required": "computed",
"description": "The number of retained weekly backups. e.g. if this is '1' we will store one weekly backup, so that weekly backup will be retained for one week before being overwritten."
}
}
],
"description": "An object that details the selected options for the current size."
}
},
{
"name": "size",
"single_nested": {
"computed_optional_required": "computed",
"attributes": [
{
"name": "available",
"bool": {
"computed_optional_required": "computed",
"description": "If this is false the size is not available for new servers."
}
},
{
"name": "cpu_description",
"string": {
"computed_optional_required": "computed",
"description": "A description of the CPU provided in this size."
}
},
{
"name": "description",
"string": {
"computed_optional_required": "computed",
"description": "A description of this size."
}
},
{
"name": "disk",
"int64": {
"computed_optional_required": "computed",
"description": "The included storage for this size in GB."
}
},
{
"name": "excess_transfer_cost_per_gigabyte",
"float64": {
"computed_optional_required": "computed",
"description": "The excess charged for any transfer above the included data transfer in AU$ per GB."
}
},
{
"name": "memory",
"int64": {
"computed_optional_required": "computed",
"description": "The included memory for this size in MB."
}
},
{
"name": "options2",
"single_nested": {
"computed_optional_required": "computed",
"attributes": [
{
"name": "backups_cost_per_backup_per_gigabyte",
"float64": {
"computed_optional_required": "computed",
"description": "The cost per GB of storage of each selected backup. See the API support document for how to calculate the final cost of backups based on the options selected."
}
},
{
"name": "daily_backups",
"int64": {
"computed_optional_required": "computed",
"description": "The number of daily backups included in the base size cost."
}
},
{
"name": "discount_for_no_public_ipv4",
"float64": {
"computed_optional_required": "computed",
"description": "This is the discount (if any) that is applied if no public IPv4 addresses are selected."
}
},
{
"name": "disk_cost_per_additional_gigabyte",
"float64": {
"computed_optional_required": "computed",
"description": "The additional cost per GB per month for additional storage space."
}
},
{
"name": "disk_max",
"int64": {
"computed_optional_required": "computed",
"description": "The maximum storage in GB permitted on this size."
}
},
{
"name": "disk_min",
"int64": {
"computed_optional_required": "computed",
"description": "The minimum storage in GB permitted on this size."
}
},
{
"name": "ipv4_addresses_cost_per_address",
"float64": {
"computed_optional_required": "computed",
"description": "The additional cost per public IPv4 address per month for additional IPv4 addresses."
}
},
{
"name": "ipv4_addresses_max",
"int64": {
"computed_optional_required": "computed",
"description": "The maximum number of IPv4 addresses permitted on this size."
}
},
{
"name": "memory_cost_per_additional_megabyte",
"float64": {
"computed_optional_required": "computed",
"description": "The additional cost per MB per month for additional memory."
}
},
{
"name": "memory_max",
"int64": {
"computed_optional_required": "computed",
"description": "The maximum memory in MB permitted on this size."
}
},
{
"name": "monthly_backups",
"int64": {
"computed_optional_required": "computed",
"description": "The number of monthly backups included in the base size cost."
}
},
{
"name": "offsite_backup_frequency_cost",
"single_nested": {
"computed_optional_required": "computed",
"attributes": [
{
"name": "daily_per_gigabyte",
"float64": {
"computed_optional_required": "computed",
"description": "The additional cost per GB per month for enabling daily offsite backups. Only the highest value of the daily, weekly and monthly is applied. See the API support document for how to calculate the final cost of backups based on the options selected."
}
},
{
"name": "monthly_per_gigabyte",
"float64": {
"computed_optional_required": "computed",
"description": "The additional cost per GB per month for enabling monthly offsite backups. Only the highest value of the daily, weekly and monthly is applied. See the API support document for how to calculate the final cost of backups based on the options selected."
}
},
{
"name": "weekly_per_gigabyte",
"float64": {
"computed_optional_required": "computed",
"description": "The additional cost per GB per month for enabling weekly offsite backups. Only the highest value of the daily, weekly and monthly is applied. See the API support document for how to calculate the final cost of backups based on the options selected."
}
}
],
"description": "The additional cost per GB of storage for enabling offsite backups based on highest frequency of backups currently enabled. All costs are in AU$."
}
},
{
"name": "offsite_backups_cost_per_gigabyte",
"float64": {
"computed_optional_required": "computed",
"description": "The additional cost per GB of storage for enabling offsite backups. See the API support document for how to calculate the final cost of backups based on the options selected."
}
},
{
"name": "restricted_disk_values",
"list": {
"computed_optional_required": "computed",
"element_type": {
"int64": {}
},
"description": "If this is null the normal valid values in the documentation for SizeOptionsRequest are used, otherwise only these values (in GB) are permitted."
}
},
{
"name": "transfer_cost_per_additional_gigabyte",
"float64": {
"computed_optional_required": "computed",
"description": "The additional cost per GB per month for additional included transfer."
}
},
{
"name": "transfer_max",
"float64": {
"computed_optional_required": "computed",
"description": "The maximum transfer in TB permitted for this size."
}
},
{
"name": "weekly_backups",
"int64": {
"computed_optional_required": "computed",
"description": "The number of weekly backups included in the base size cost."
}
}
],
"description": "Available add-ons (optional features not included in the base price) for the size. All costs are in AU$ per month (pro-rated)."
}
},
{
"name": "price_hourly",
"float64": {
"computed_optional_required": "computed",
"description": "Hourly price in AU$."
}
},
{
"name": "price_monthly",
"float64": {
"computed_optional_required": "computed",
"description": "Monthly Price in AU$."
}
},
{
"name": "regions",
"list": {
"computed_optional_required": "computed",
"element_type": {
"string": {}
},
"description": "A list of region slugs where this size is available regardless of stock.\nIf this a response to a query that included a selected operating system this response will only include regions where that operating system is available on this size,\notherwise not all regions listed will support all operating systems on this size."
}
},
{
"name": "regions_out_of_stock",
"list": {
"computed_optional_required": "computed",
"element_type": {
"string": {}
},
"description": "A list of region slugs where the size is normally available but is currently not available due to lack of stock."
}
},
{
"name": "size_type",
"single_nested": {
"computed_optional_required": "computed",
"attributes": [
{
"name": "description",
"string": {
"computed_optional_required": "computed",
"description": "The description of this size type, generally used to indicate the intended use case for sizes of this type."
}
},
{
"name": "name",
"string": {
"computed_optional_required": "computed",
"description": "The name of this size type."
}
},
{
"name": "slug",
"string": {
"computed_optional_required": "computed",
"description": "The slug of this size type."
}
}
],
"description": "The type of this size, generally used to differentiate sizes optimized for different usages."
}
},
{
"name": "slug",
"string": {
"computed_optional_required": "computed",
"description": "The slug of this size."
}
},
{
"name": "storage_description",
"string": {
"computed_optional_required": "computed",
"description": "A description of the storage provided in this size."
}
},
{
"name": "transfer",
"float64": {
"computed_optional_required": "computed",
"description": "The included data transfer for this size in TB."
}
},
{
"name": "vcpu_units",
"string": {
"computed_optional_required": "computed",
"description": "This is the unit that the vcpus field counts, e.g. \"core\" or \"thread\"."
}
},
{
"name": "vcpus",
"int64": {
"computed_optional_required": "computed",
"description": "The count of virtual CPUs for this size. See vcpu_units for a description of how each virtual CPU maps to the underlying hardware."
}
}
],
"description": "The currently selected size for this server."
}
},
{
"name": "size_slug",
"string": {
"computed_optional_required": "computed",
"description": "The slug of the currently selected size for this server."
}
},
{
"name": "status",
"string": {
"computed_optional_required": "computed",
"description": "\n| Value | Description |\n| ----- | ----------- |\n| new | The server is currently in the process of building and is not yet available for use. |\n| active | The server is available for use. |\n| archive | The server is powered off due to cancellation or non payment. |\n| off | The server has been powered off, but may be powered back on. |\n\n"
}
},
{
"name": "vcpus",
"int64": {
"computed_optional_required": "computed",
"description": "The number of virtual CPUs of this server."
}
},
{
"name": "vpc_id",
"int64": {
"computed_optional_required": "computed",
"description": "The VPC ID that this server is allocated to. If this value is null the server is in the default (public) network for the region."
}
}
]
}
},
{
"name": "id",
"int64": {
"computed_optional_required": "computed_optional",
"description": "The ID of the server to fetch."
}
}
]
}
}
],
"version": "0.1"
}