Skip to content

Commit

Permalink
manual documentation additions as nested object property descriptions…
Browse files Browse the repository at this point in the history
  • Loading branch information
Mario Schäfer committed May 16, 2022
1 parent f960ef2 commit 6fc6696
Show file tree
Hide file tree
Showing 15 changed files with 132 additions and 132 deletions.
14 changes: 7 additions & 7 deletions docs/data-sources/core_locations.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,12 @@ data "anxcloud_core_locations" "example" {

Read-Only:

- `city_code` (String)
- `code` (String)
- `country` (String)
- `identifier` (String)
- `lat` (String)
- `lon` (String)
- `name` (String)
- `city_code` (String) Location city code.
- `code` (String) Location code.
- `country` (String) Location country.
- `identifier` (String) Identifier of the API resource.
- `lat` (String) Location latitude.
- `lon` (String) Location longitude.
- `name` (String) Location name.


8 changes: 4 additions & 4 deletions docs/data-sources/cpu_performance_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ data "anxcloud_cpu_performance_types" "example" {}

Read-Only:

- `id` (String)
- `limit` (Number)
- `prioritization` (String)
- `unit` (String)
- `id` (String) CPU performance type identifier.
- `limit` (Number) CPU performance type limit.
- `prioritization` (String) CPU performance type prioritization.
- `unit` (String) CPU performance type limit unit.


10 changes: 5 additions & 5 deletions docs/data-sources/disk_types.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@ data "anxcloud_disk_types" "example" {

Read-Only:

- `bandwidth` (Number)
- `id` (String)
- `iops` (Number)
- `latency` (Number)
- `storage_type` (String)
- `bandwidth` (Number) Bandwidth.
- `id` (String) Identifier of the API resource.
- `iops` (Number) Input/output operations per second.
- `latency` (Number) Latency.
- `storage_type` (String) Storage type.


16 changes: 8 additions & 8 deletions docs/data-sources/dns_records.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,13 @@ data "anxcloud_dns_records" "example" {

Read-Only:

- `identifier` (String)
- `immutable` (Boolean)
- `name` (String)
- `rdata` (String)
- `region` (String)
- `ttl` (Number)
- `type` (String)
- `zone_name` (String)
- `identifier` (String) DNS Record identifier. Changes on revision change and therefore shouldn't be used as reference.
- `immutable` (Boolean) Specifies whether or not a record is immutable.
- `name` (String) DNS record name.
- `rdata` (String) DNS record data.
- `region` (String) DNS record region (for GeoDNS aware records).
- `ttl` (Number) Region specific TTL. If not set the zone TTL will be used.
- `type` (String) DNS record type.
- `zone_name` (String) Zone of DNS record.


32 changes: 16 additions & 16 deletions docs/data-sources/dns_zones.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,27 +32,27 @@ data "anxcloud_dns_zones" "example" {}

Read-Only:

- `admin_email` (String)
- `deployment_level` (Number)
- `dns_sec_mode` (String)
- `dns_servers` (List of Object) (see [below for nested schema](#nestedobjatt--zones--dns_servers))
- `expire` (Number)
- `is_editable` (Boolean)
- `is_master` (Boolean)
- `master_nameserver` (String)
- `name` (String)
- `notify_allowed_ips` (List of String)
- `refresh` (Number)
- `retry` (Number)
- `ttl` (Number)
- `validation_level` (Number)
- `admin_email` (String) Admin email address.
- `deployment_level` (Number) Current deployment progress in percent.
- `dns_sec_mode` (String) DNSSec mode value for master zones. [`managed` or `unvalidated`]
- `dns_servers` (List of Object) (see [below for nested schema](#nestedobjatt--zones--dns_servers)) Configured DNS servers.
- `expire` (Number) Expiration value.
- `is_editable` (Boolean) Indicator if zone is editable.
- `is_master` (Boolean) Indicator if the zone is a master zone.
- `master_nameserver` (String) IP or domain of master nameserver.
- `name` (String) Zone name.
- `notify_allowed_ips` (List of String) IP addresses allowed to initiate domain transfer.
- `refresh` (Number) Refresh value.
- `retry` (Number) Retry value.
- `ttl` (Number) TTL value.
- `validation_level` (Number) Current validation level in percent.

<a id="nestedobjatt--zones--dns_servers"></a>
### Nested Schema for `zones.dns_servers`

Read-Only:

- `alias` (String)
- `server` (String)
- `alias` (String) DNS server alias.
- `server` (String) DNS server name.


8 changes: 4 additions & 4 deletions docs/data-sources/ip_addresses.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ data "anxcloud_ip_addresses" "example" {

Read-Only:

- `address` (String)
- `description_customer` (String)
- `identifier` (String)
- `role` (String)
- `address` (String) The IP address.
- `description_customer` (String) Additional customer description.
- `identifier` (String) Identifier of the API resource.
- `role` (String) Role of the IP address.


4 changes: 2 additions & 2 deletions docs/data-sources/tags.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ data "anxcloud_tags" "example" {

Read-Only:

- `identifier` (String)
- `name` (String)
- `identifier` (String) Identifier of the tag.
- `name` (String) Name of the tag.


32 changes: 16 additions & 16 deletions docs/data-sources/template.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,22 +63,22 @@ Read-Only:

Read-Only:

- `boot_delay_seconds` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--boot_delay_seconds))
- `cpus` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--cpus))
- `disk_gb` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--disk_gb))
- `disk_type` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--disk_type))
- `dns0` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--dns0))
- `dns1` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--dns1))
- `dns2` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--dns2))
- `dns3` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--dns3))
- `enter_bios_setup` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--enter_bios_setup))
- `hostname` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--hostname))
- `ips` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--ips))
- `memory_mb` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--memory_mb))
- `nics` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--nics))
- `password` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--password))
- `user` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--user))
- `vlan` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--vlan))
- `boot_delay_seconds` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--boot_delay_seconds)) Boot delay parameter.
- `cpus` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--cpus)) CPUs parameter.
- `disk_gb` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--disk_gb)) Disk size parameter.
- `disk_type` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--disk_type)) Disk type parameter.
- `dns0` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--dns0)) DNS 0 parameter.
- `dns1` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--dns1)) DNS 1 parameter.
- `dns2` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--dns2)) DNS 2 parameter.
- `dns3` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--dns3)) DNS 3 parameter.
- `enter_bios_setup` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--enter_bios_setup)) Enter BIOS parameter.
- `hostname` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--hostname)) Hostname parameter.
- `ips` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--ips)) IPs parameter.
- `memory_mb` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--memory_mb)) Memory parameter.
- `nics` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--nics)) NICs parameter.
- `password` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--password)) Password parameter.
- `user` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--user)) User parameter.
- `vlan` (List of Object) (see [below for nested schema](#nestedobjatt--templates--params--vlan)) VLAN parameter.

<a id="nestedobjatt--templates--params--boot_delay_seconds"></a>
### Nested Schema for `templates.params.boot_delay_seconds`
Expand Down
6 changes: 3 additions & 3 deletions docs/data-sources/vlans.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ data "anxcloud_vlans" "example" {

Read-Only:

- `description_customer` (String)
- `identifier` (String)
- `name` (String)
- `description_customer` (String) Additional customer description.
- `identifier` (String) Identifier of the API resource.
- `name` (String) VLAN name.


16 changes: 9 additions & 7 deletions docs/data-sources/vsphere_locations.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ description: |-

# anxcloud_vsphere_locations (Data Source)

~> This data-source is deprecated. Please use `anxcloud_core_locations` instead.

Provides available vSphere locations.

## Example Usage
Expand Down Expand Up @@ -39,12 +41,12 @@ data "anxcloud_vsphere_locations" "example" {

Read-Only:

- `code` (String)
- `country` (String)
- `country_name` (String)
- `identifier` (String)
- `lat` (String)
- `lon` (String)
- `name` (String)
- `code` (String) Location code.
- `country` (String) Location country.
- `country_name` (String) Location country name.
- `identifier` (String) Identifier of the API resource.
- `lat` (String) Location latitude.
- `lon` (String) Location longitude.
- `name` (String) Location name.


4 changes: 4 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ description: |-
# anxcloud Provider


-> Visit the [Anexia official website](https://anexia.com/en/) to get more info about Anexia Cloud.

The `anxcloud` provider is used to interact with Anexia Cloud API.


## Example Usage

Expand Down
16 changes: 7 additions & 9 deletions docs/resources/network_prefix.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,12 +74,10 @@ Optional:

Read-Only:

- `city_code` (String)
- `code` (String)
- `country` (String)
- `identifier` (String)
- `lat` (String)
- `lon` (String)
- `name` (String)


- `city_code` (String) Location city code.
- `code` (String) Location code.
- `country` (String) Location country.
- `identifier` (String) Identifier of the API resource.
- `lat` (String) Location latitude.
- `lon` (String) Location longitude.
- `name` (String) Location name.
20 changes: 10 additions & 10 deletions docs/resources/tag.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,28 +52,28 @@ Optional:

Read-Only:

- `customer` (List of Object) (see [below for nested schema](#nestedobjatt--organisation_assignments--customer))
- `service` (List of Object) (see [below for nested schema](#nestedobjatt--organisation_assignments--service))
- `customer` (List of Object) Customer related information. (see [below for nested schema](#nestedobjatt--organisation_assignments--customer))
- `service` (List of Object) Service related information. (see [below for nested schema](#nestedobjatt--organisation_assignments--service))

<a id="nestedobjatt--organisation_assignments--customer"></a>
### Nested Schema for `organisation_assignments.customer`

Read-Only:

- `customer_id` (String)
- `demo` (Boolean)
- `id` (String)
- `name` (String)
- `name_slug` (String)
- `reseller` (String)
- `customer_id` (String) Customer identifier.
- `demo` (Boolean) Whether is demo.
- `id` (String) Identifier.
- `name` (String) Customer name.
- `name_slug` (String) Slug name.
- `reseller` (String) Reseller name.


<a id="nestedobjatt--organisation_assignments--service"></a>
### Nested Schema for `organisation_assignments.service`

Read-Only:

- `id` (String)
- `name` (String)
- `id` (String) Service identifier.
- `name` (String) Service name.


62 changes: 30 additions & 32 deletions docs/resources/virtual_server.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ page_title: "anxcloud_virtual_server Resource - terraform-provider-anxcloud"
subcategory: ""
description: |-
The virtual_server resource allows you to configure and run virtual machines.
Known limitations
removal of disks not supportedremoval of networks not supported
---

# anxcloud_virtual_server (Resource)
Expand Down Expand Up @@ -161,48 +159,48 @@ Optional:

Read-Only:

- `cores` (Number)
- `cpu` (Number)
- `custom_name` (String)
- `disks_info` (List of Object) (see [below for nested schema](#nestedobjatt--info--disks_info))
- `disks_number` (Number)
- `guest_os` (String)
- `guest_tools_status` (String)
- `identifier` (String)
- `location_code` (String)
- `location_country` (String)
- `location_name` (String)
- `name` (String)
- `network` (List of Object) (see [below for nested schema](#nestedobjatt--info--network))
- `ram` (Number)
- `status` (String)
- `version_tools` (String)
- `cores` (Number) Number of CPU cores.
- `cpu` (Number) Number of CPUs.
- `custom_name` (String) Virtual server custom name.
- `disks_info` (List of Object) Disks info. (see [below for nested schema](#nestedobjatt--info--disks_info))
- `disks_number` (Number) Number of the attached disks.
- `guest_os` (String) Guest operating system.
- `guest_tools_status` (String) Guest tools status.
- `identifier` (String) Identifier of the API resource.
- `location_code` (String) Location code.
- `location_country` (String) Location country.
- `location_name` (String) Location name.
- `name` (String) Virtual server name.
- `network` (List of Object) Network interfaces. (see [below for nested schema](#nestedobjatt--info--network))
- `ram` (Number) Memory in MB.
- `status` (String) Virtual server status.
- `version_tools` (String) Version tools.

<a id="nestedobjatt--info--disks_info"></a>
### Nested Schema for `info.disks_info`

Read-Only:

- `bus_type` (String)
- `bus_type_label` (String)
- `disk_gb` (Number)
- `disk_id` (Number)
- `disk_type` (String)
- `iops` (Number)
- `latency` (Number)
- `storage_type` (String)
- `bus_type` (String) Bus type.
- `bus_type_label` (String) Bus type label.
- `disk_gb` (Number) Size of the disk in GB.
- `disk_id` (Number) Disk identifier.
- `disk_type` (String) Disk type.
- `iops` (Number) Disk input/output operations per second.
- `latency` (Number) Disk latency.
- `storage_type` (String) Disk storage type.


<a id="nestedobjatt--info--network"></a>
### Nested Schema for `info.network`

Read-Only:

- `id` (Number)
- `ip_v4` (List of String)
- `ip_v6` (List of String)
- `mac_address` (String)
- `nic` (Number)
- `vlan` (String)
- `id` (Number) Network interface card identifier.
- `ip_v4` (List of String) List of IPv4 addresses attached to the interface.
- `ip_v6` (List of String) List of IPv6 addresses attached to the interface.
- `mac_address` (String) MAC address of the NIC.
- `nic` (Number) NIC type number.
- `vlan` (String) VLAN identifier.


16 changes: 7 additions & 9 deletions docs/resources/vlan.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,10 @@ Optional:

Read-Only:

- `city_code` (String)
- `code` (String)
- `country` (String)
- `identifier` (String)
- `lat` (String)
- `lon` (String)
- `name` (String)


- `city_code` (String) Location city code.
- `code` (String) Location code.
- `country` (String) Location country.
- `identifier` (String) Identifier of the API resource.
- `lat` (String) Location latitude.
- `lon` (String) Location longitude.
- `name` (String) Location name.

0 comments on commit 6fc6696

Please sign in to comment.