Sacloud Documentation

https://docs.usacloud.jp
Admin
Japanese documentation for Sacloud (Sakura Cloud) open-source products including Usacloud CLI,...
Tokens:167,224
Snippets:2,003
Trust Score:5
Update:4 months ago
Show doc for...
Tokens:
Raw
### Autoscaler Start Command Help

Source: https://docs.usacloud.jp/autoscaler/getting_started

Help output for the 'autoscaler start' command, showing available flags and options.

```bash
$ autoscaler start -h

start autoscaler's core server

Usage:
  autoscaler start [flags]...

Flags:
      --addr string     Address of the gRPC endpoint to listen to (default "unix:autoscaler.sock")
      --config string   File path of configuration of AutoScaler Core (default "autoscaler.yaml")
  -h, --help            help for start
      --strict          Restricting external file loading, etc. in configuration

Global Flags:
      --log-format string   Format of logging to be output. options: [ logfmt | json ] (default "logfmt")
      --log-level string    Level of logging to be output. options: [ error | warn | info | debug ] (default "info")
```

--------------------------------

### Starting Autoscaler Inputs

Source: https://docs.usacloud.jp/autoscaler/getting_started

Commands to start different types of Autoscaler Inputs.

```bash
# Grafana Inputsの場合
$ autoscaler inputs grafana

# AlertManager Inputsの場合
$ autoscaler inputs alertmanager

# Zabbix Inputsの場合
$ autoscaler inputs zabbix

# 汎用Webhook Inputsの場合
$ autoscaler inputs webhook --accept-http-methods "POST,PUT" --executable-path your-executable-path.sh

# Direct Inputsの場合
$ autoscaler inputs direct up
```

--------------------------------

### Starting Autoscaler Core

Source: https://docs.usacloud.jp/autoscaler/getting_started

Command to start the Autoscaler Core with default settings.

```bash
# デフォルト設定で起動
$ autoscaler start
```

--------------------------------

### ESME Resource Example

Source: https://docs.usacloud.jp/terraform/guides/upgrade_to_v2.5.0

Example of how to define a new ESME resource.

```Terraform
resource "sakuracloud_esme" "foobar" {
  name        = "foobar"
  description = "description"
  tags        = ["tag1", "tag2"]
}

```

--------------------------------

### List servers in all zones

Source: https://docs.usacloud.jp/usacloud/upgrade/v1_0_0

Example of listing all servers across all zones by specifying '--zone=all'.

```bash
# 全ゾーンのサーバ一覧
$ usacloud server list --zone=all

```

--------------------------------

### create parameter example

Source: https://docs.usacloud.jp/usacloud/references/simple-monitor

Parameter Examples

```json
{
    "Target": "www.example.com",
    "Description": "example",
    "Tags": [
        "tag1=example1",
        "tag2=example2"
    ],
    "IconID": 123456789012,
    "DelayLoop": 60,
    "MaxCheckAttempts": 3,
    "RetryInterval": 10,
    "Timeout": 10,
    "Enabled": true,
    "HealthCheck": {
        "Protocol": "http | https | ping | tcp | dns | ssh | smtp | pop3 | snmp | sslcertificate | ftp",
        "Port": 80,
        "Path": "/healthz",
        "Status": 200,
        "ContainsString": "ok",
        "SNI": true,
        "Host": "www2.example.com",
        "BasicAuthUsername": "username",
        "BasicAuthPassword": "password",
        "HTTP2": true,
        "FTPS": "explicit | implicit",
        "VerifySNI": true
    },
    "NotifyEmailEnabled": true,
    "NotifyEmailHTML": true,
    "NotifySlackEnabled": true,
    "SlackWebhooksURL": "https://hooks.slack.com/services/XXXXXXXXX/XXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXX",
    "NotifyInterval": 7200
}

```

--------------------------------

### Example of specifying a GPU plan when creating a server

Source: https://docs.usacloud.jp/terraform/guides/upgrade_to_v2.14.0

This example demonstrates how to specify GPU parameters (core, memory, gpu) when creating a SakuraCloud server, utilizing the GPU plan available in the 'is1a' zone.

```Terraform
resource "sakuracloud_server" "foobar" {
  zone = "is1a" 

  name   = "example"

  # 2021/10現在はis1aゾーンにて"GPUプラン/4Core-56GB-1GPU"のみが提供されている
  core   = 4
  memory = 56
  gpu    = 1

  # ...
}

```

--------------------------------

### fish Shell Completion Setup

Source: https://docs.usacloud.jp/autoscaler/cli

Example commands to set up fish shell completion for autoscaler.

```fish
$ autoscaler completion fish | source

# To load completions for each session, execute once:
$ autoscaler completion fish > ~/.config/fish/completions/autoscaler.fish

```

--------------------------------

### Autoscaling Configuration

Source: https://docs.usacloud.jp/terraform/guides/upgrade_to_v2.17.0

Example Terraform configuration for setting up autoscaling with SakuraCloud.

```terraform
resource "sakuracloud_auto_scale" "foobar" {
  name  = "example"
  zones = [local.zone]

  config = jsonencode({
    resources : [{
      type : "Server",
      selector : {
        names : [sakuracloud_server.foobar.name],
        zones : [local.zone],
      },
    }],
  })

  api_key_id = local.api_key_id

  cpu_threshold_scaling {
    server_prefix = local.server_name_prefix
    up            = 80
    down          = 20
  }
}

```

--------------------------------

### Example

Source: https://docs.usacloud.jp/terraform/r/webaccel

Example of creating a Web Accelerator site.

```Terraform
resource "sakuracloud_webaccel" "foobar" {
  name             = "hoge"
  domain_type      = "subdomain"
  request_protocol = "https-redirect"
  origin_parameters {
    type     = "web"
    origin   = "docs.usacloud.jp"
    protocol = "https"
  }
  logging {
    s3_bucket_name = "example-bucket"
    s3_access_key_id = "xxxxxxxxxxxxxxx"
    s3_secret_access_key = "xxxxxxxxxxxxxxxxxxxxxxx"
    enabled = true
  }
  onetime_url_secrets = [
    "abc-0x123456"
  ]
  vary_support      = true
  default_cache_ttl = 3600
  normalize_ae      = "gzip"
}

```

--------------------------------

### Using read and list commands

Source: https://docs.usacloud.jp/usacloud/guides/basic_usage

Example of using the 'read' command to get an icon ID and passing it to the 'switch create' command.

```bash
usacloud switch create --icon-id=$(usacloud icon read -q example)
```

--------------------------------

### Docker Commands for Autoscaler

Source: https://docs.usacloud.jp/autoscaler/getting_started

Commands to run the Autoscaler Core, Grafana Inputs, and AlertManager Inputs using Docker.

```bash
# Coreを起動する場合(Unixドメインソケットでリッスン)
$ docker run -d -w /work -d /your/work/dir:/work ghcr.io/sacloud/autoscaler start

# Grafana Inputsを起動する場合(CoreとはVolume経由でUnixドメインソケットを受け渡して通信する)
$ docker run -d -w /work -d /your/work/dir:/work ghcr.io/sacloud/autoscaler inputs grafana --addr ":8080"

# AlertManager Inputsを起動する場合(CoreとはVolume経由でUnixドメインソケットを受け渡して通信する)
$ docker run -d -w /work -d /your/work/dir:/work ghcr.io/sacloud/autoscaler inputs alertmanager --addr ":8080"
```

--------------------------------

### Archive Data Source with Ubuntu 20.04

Source: https://docs.usacloud.jp/terraform/guides/upgrade_to_v2.5.0

Example of using the archive data source to specify Ubuntu 20.04.

```Terraform
data "sakuracloud_archive" "foobar" {
  os_type = "ubuntu2004"
}

```

--------------------------------

### Bash Shell Completion Setup

Source: https://docs.usacloud.jp/autoscaler/cli

Example commands to set up Bash shell completion for autoscaler.

```bash
$ source <(autoscaler completion bash)

# To load completions for each session, execute once:
# Linux:
$ autoscaler completion bash > /etc/bash_completion.d/autoscaler
# macOS:
$ autoscaler completion bash > /usr/local/etc/bash_completion.d/autoscaler

```

--------------------------------

### String as Selector Example

Source: https://docs.usacloud.jp/autoscaler/configuration

Example showing how a string is interpreted as a resource selector.

```yaml
# 文字列を指定した場合
selector: "name"

# 以下と同等
# selector:
#   names: ["name"]

```

--------------------------------

### PowerShell Shell Completion Setup

Source: https://docs.usacloud.jp/autoscaler/cli

Example commands to set up PowerShell shell completion for autoscaler.

```powershell
PS> autoscaler completion powershell | Out-String | Invoke-Expression

# To load completions for every new session, run:
PS> autoscaler completion powershell > autoscaler.ps1
# and source this file from your PowerShell profile.

```

--------------------------------

### Zsh Shell Completion Setup

Source: https://docs.usacloud.jp/autoscaler/cli

Example commands to set up Zsh shell completion for autoscaler.

```zsh
# If shell completion is not already enabled in your environment,
you will need to enable it.  You can execute the following once:

$ echo "autoload -U compinit; compinit" >> ~/.zshrc

# To load completions for each session, execute once:
$ autoscaler completion zsh > "${fpath[1]}/_autoscaler"

# You will need to start a new shell for this setup to take effect.

```

--------------------------------

### Example

Source: https://docs.usacloud.jp/terraform/r/webaccel_activation

Example of enabling a website accelerator site.

```HCL
data "sakuracloud_webaccel" "site" {
  name = "your-site-name"
  # or
  # domain = "your-domain"
}

resource "sakuracloud_webaccel_activation" "site_status" {
  site_id    = data.sakuracloud_webaccel.site.id
  enabled    = true
}

```

--------------------------------

### Example Usage

Source: https://docs.usacloud.jp/terraform/d/simple_monitor

Example of how to use the sakuracloud_simple_monitor data source.

```Terraform
data "sakuracloud_simple_monitor" "foobar" {
  filter {
    names = ["foobar"]
  }
}

```

--------------------------------

### create parameter example

Source: https://docs.usacloud.jp/usacloud/references/certificate-authority

Example parameters for the create command.

```json
{
    "Name": "example",
    "Description": "example",
    "Tags": [
        "tag1=example1",
        "tag2=example2"
    ],
    "IconID": 123456789012,
    "Country": "JP",
    "Organization": "usacloud",
    "OrganizationUnit": [
        "ou1",
        "ou2"
    ],
    "CommonName": "example.usacloud.jp",
    "ValidityPeriodHours": 8760,
    "Clients": [
        {
            "ID": "",
            "Country": "JP",
            "Organization": "usacloud",
            "OrganizationUnit": [
                "ou1",
                "ou2"
            ],
            "CommonName": "client.usacloud.jp",
            "NotAfter": "2023-01-27T08:48:51.39852+09:00",
            "IssuanceMethod": "url | email | csr | public_key",
            "EMail": "example@example.com",
            "CertificateSigningRequest": "-----BEGIN CERTIFICATE REQUEST-----\n...",
            "PublicKey": "-----BEGIN PUBLIC KEY-----\n...",
            "Hold": true
        }
    ],
    "Servers": [
        {
            "ID": "",
            "Country": "JP",
            "Organization": "usacloud",
            "OrganizationUnit": [
                "ou1",
                "ou2"
            ],
            "CommonName": "client.usacloud.jp",
            "NotAfter": "2023-01-27T08:48:51.398521+09:00",
            "SANs": [
                "www1.usacloud.jp",
                "www2.usacloud.jp"
            ],
            "CertificateSigningRequest": "-----BEGIN CERTIFICATE REQUEST-----\n...",
            "PublicKey": "-----BEGIN PUBLIC KEY-----\n...",
            "Hold": true
        }
    ]
}
```

--------------------------------

### Parameter Examples

Source: https://docs.usacloud.jp/usacloud/references/vpc-router

Example JSON structure for configuring a VPC Router.

```json
{
    "Zone": "tk1a | tk1b | is1a | is1b | tk1v",
    "Name": "example",
    "Description": "example",
    "Tags": [
        "tag1=example1",
        "tag2=example2"
    ],
    "IconID": 123456789012,
    "Version": 2,
    "PrivateNetworkInterfacesData": "",
    "PrivateNetworkInterfaces": [
        {
            "SwitchID": 123456789012,
            "IPAddress": "192.168.0.11",
            "NetworkMaskLen": 24,
            "Index": 1
        }
    ],
    "RouterSetting": {
        "InternetConnectionEnabled": true,
        "PortForwarding": [
            {
                "Protocol": "tcp | udp",
                "GlobalPort": "22",
                "PrivateAddress": "192.168.0.11",
                "PrivatePort": "22",
                "Description": "example"
            }
        ],
        "Firewall": [
            {
                "Send": [
                    {
                        "Protocol": "tcp | udp | icmp | ip",
                        "SourceNetwork": "192.0.2.1 | 192.0.2.0/24",
                        "SourcePort": "1024 | 1024-2048",
                        "DestinationNetwork": "192.0.2.1 | 192.0.2.0/24",
                        "DestinationPort": "1024 | 1024-2048",
                        "Action": "allow | deny",
                        "Logging": "True",
                        "Description": "example"
                    }
                ],
                "Receive": [
                    {
                        "Protocol": "tcp | udp | icmp | ip",
                        "SourceNetwork": "192.0.2.1 | 192.0.2.0/24",
                        "SourcePort": "1024 | 1024-2048",
                        "DestinationNetwork": "192.0.2.1 | 192.0.2.0/24",
                        "DestinationPort": "1024 | 1024-2048",
                        "Action": "allow | deny",
                        "Logging": "True",
                        "Description": "example"
                    }
                ],
                "Index": 0
            }
        ],
        "DHCPServer": [
            {
                "Interface": "eth1",
                "RangeStart": "192.168.0.240",
                "RangeStop": "192.168.0.244",
                "DNSServers": [
                    "133.242.0.3",
                    "133.242.0.4"
                ]
            }
        ],
        "DHCPStaticMapping": [
            {
                "MACAddress": "9C:A3:BA:xx:xx:xx",
                "IPAddress": "192.168.0.245"
            }
        ],
        "DNSForwarding": {
            "Interface": "eth1",
            "DNSServers": [
                "133.242.0.3",
                "133.242.0.4"
            ]
        },
        "PPTPServer": {
            "RangeStart": "192.168.0.246",
            "RangeStop": "192.168.0.249"
        },
        "L2TPIPsecServer": {
            "RangeStart": "192.168.0.250",
            "RangeStop": "192.168.0.254",
            "PreSharedSecret": "presharedsecret"
        },
        "RemoteAccessUsers": [
            {
                "UserName": "username",
                "Password": "password"
            }
        ],
        "WireGuard": {
            "IPAddress": "192.168.0.240/28",
            "Peers": [
                {
                    "Name": "client1",
                    "IPAddress": "192.168.0.242",
                    "PublicKey": "your-key"
                }
            ]
        },
        "SiteToSiteIPsecVPN": [
            {
                "Peer": "192.0.2.1",
                "PreSharedSecret": "presharedsecret",
                "RemoteID": "192.0.2.1",
                "Routes": [
                    "10.0.0.0/8"
                ],
                "LocalPrefix": [
                    "192.168.0.0/24"
                ]
            }
        ],
        "StaticRoute": [
            {
                "Prefix": "172.16.0.0/16",
                "NextHop": "192.168.0.21"
            }
        ],
        "SyslogHost": "192.168.0.1"
    },
    "BootAfterCreate": true,
    "NoWait": false
}
```

--------------------------------

### Parameter Examples

Source: https://docs.usacloud.jp/usacloud/references/auto-backup

Example JSON structure for auto backup parameters.

```json
{
    "Zone": "tk1a | tk1b | is1a | is1b | tk1v",
    "Name": "example",
    "Description": "example",
    "Tags": [
        "tag1=example1",
        "tag2=example2"
    ],
    "IconID": 123456789012,
    "Weekdays": [
        "all | sun | mon | tue | wed | thu | fri | sat"
    ],
    "MaxNumOfArchives": 5

}
```

--------------------------------

### create Command Parameter Example

Source: https://docs.usacloud.jp/usacloud/references/ssh-key

Example JSON structure for the 'create' command parameters.

```json
{
    "Name": "example",
    "Description": "example",
    "PublicKey": "/path/to/your/public/key | ssh-rsa ..."
}

```

--------------------------------

### Boot Servers by Partial Name Match (Example 2)

Source: https://docs.usacloud.jp/usacloud/guides/basic_usage

Boots servers whose names contain 'Test3'.

```bash
$ usacloud server boot Test3 # 名称にTest3を含むもの

Target resource IDs => [
    000000000031,
    000000000032
]
Are you sure you want to boot?(y/n) [n]:
```

--------------------------------

### Boot Servers by Partial Name Match (Example 1)

Source: https://docs.usacloud.jp/usacloud/guides/basic_usage

Boots servers whose names contain 'Test'.

```bash
$ usacloud server boot Test # 名称にTestを含むもの

Target resource IDs => [
    000000000011,
    000000000021,
    000000000031,
    000000000032
]
Are you sure you want to boot?(y/n) [n]:
```

--------------------------------

### Example Usage

Source: https://docs.usacloud.jp/autoscaler/inputs/config

This example shows how to use the `--config` parameter to specify a configuration file for an Input exporter.

```bash
$ autoscaler inputs grafana --addr 192.0.2.1:443 --config your-config.yaml

```

--------------------------------

### Install script for MacOS/Linux

Source: https://docs.usacloud.jp/usacloud/upgrade/v1_0_0

This command downloads and executes the installation script for usacloud on MacOS and Linux systems.

```bash
$ curl -fsSL https://github.com/sacloud/usacloud/releases/latest/download/install.sh | bash

```

--------------------------------

### Example Usage

Source: https://docs.usacloud.jp/terraform/d/note

This example shows how to reference a startup script using the `sakuracloud_note` data source.

```hcl
data "sakuracloud_note" "foobar" {
  filter {
    names = ["foobar"]
  }
}

```

--------------------------------

### List Servers

Source: https://docs.usacloud.jp/usacloud/guides/basic_usage

Example of listing all available servers and their details.

```bash
$ usacloud server ls
+--------------+---------+-----+--------+---------------+--------+
|      ID      |  NAME   | CPU | MEMORY |   IPADDRESS   | STATUS |
+--------------+---------+-----+--------+---------------+--------+
| 000000000011 | Test1-1 | 1   | 1024MB | 192.0.2.11/24 | up     |
| 000000000021 | Test2-1 | 1   | 1024MB | 192.0.2.21/24 | up     |
| 000000000031 | Test3-1 | 1   | 1024MB | 192.0.2.31/24 | up     |
| 000000000032 | Test3-2 | 1   | 1024MB | 192.0.2.32/24 | up     |
+--------------+---------+-----+--------+---------------+--------+
```

--------------------------------

### Startup Script Example for IP Address Configuration (eth1)

Source: https://docs.usacloud.jp/autoscaler/network

This example demonstrates how to use a startup script with Go templates to configure network settings for the second NIC (eth1) on a server.

```bash
#!/bin/bash

# eth1向け設定ファイル作成
cat <<EOL >> /etc/netplan/99-eth1-netcfg.yaml
network:
  ethernets:
    eth1:
      addresses:
        # パラメータ中のNetworkInterfacesからインデックス1の要素を取り出し、N.N.N.N/N形式で出力する
        - {{ with index .NetworkInterfaces 1 }}{{ with .AssignedNetwork }}{{ .IpAddress }}/{{ .Netmask }}{{ end }}{{ end }}
      dhcp4: 'no'
      dhcp6: 'no'
EOL

# 反映
netplan apply

```

--------------------------------

### Create Command Parameter Example

Source: https://docs.usacloud.jp/usacloud/references/enhanced-db

Provides a JSON example for the parameters required by the 'create' command.

```json
{
    "Name": "example",
    "Description": "example",
    "Tags": [
        "tag1=example1",
        "tag2=example2"
    ],
    "IconID": 123456789012,
    "DatabaseName": "example",
    "Password": "your-password"
}

```

--------------------------------

### Archive Data Source with Name Filter

Source: https://docs.usacloud.jp/terraform/guides/upgrade_to_v2.17.0

Example of using the sakuracloud_archive data source to find an OS image by name, useful for Windows OS after deprecation of specific os_type values.

```terraform
data "sakuracloud_archive" "foobar" {
  filter {
    names = ["Windows Server 2022 for RDS"]
    #tags  = ["with-office"]
  }
}

```

--------------------------------

### Configuration File Example

Source: https://docs.usacloud.jp/autoscaler/configuration

An example of a configuration file for sacloud/autoscaler, demonstrating resource definitions and autoscaler behavior settings.

```yaml
# 操作対象のリソースの定義
# スケールさせたいリソース群をここで定義する
resources:
  # サーバ(垂直スケール)
  - type: Server
    name: "server"
    selector:
      names: ["example"]
      zones: ["is1a"]
    shutdown_force: true

    # 親リソース(GSLB)
    # GSLB配下のサーバが垂直スケールする際にサーバのデタッチ&アタッチが行われる
    parent:
      type: GSLB
      selector: "example-gslb"

# カスタムハンドラーの定義
# handlers:
#   - name: "fake"
#     endpoint: "unix:autoscaler-handlers-fake.sock"

# オートスケーラーの動作設定
autoscaler:
  cooldown: 600 

# さくらのクラウド API関連
# sakuracloud:
#   # Usacloud互換のプロファイル機能でAPIキーを指定
#   profile: "<your-profile-name>"
#
#   # APIキーの直接指定も可能
#   token: "<your-token>"
#   secret: "<your-secret>"

```

--------------------------------

### create command parameter example

Source: https://docs.usacloud.jp/usacloud/references/icon

Example JSON structure for parameters used with the 'create' command.

```json
{
    "Name": "example",
    "Tags": [
        "tag1=example1",
        "tag2=example2"
    ],
    "Image": "/path/to/your/icon/image.png"
}

```

--------------------------------

### create Command Parameter Example

Source: https://docs.usacloud.jp/usacloud/references/internet

An example JSON object demonstrating the parameters required for the 'create' internet command.

```json
{
    "Zone": "tk1a | tk1b | is1a | is1b | tk1v",
    "Name": "example",
    "Description": "example",
    "Tags": [
        "tag1=example1",
        "tag2=example2"
    ],
    "IconID": 123456789012,
    "NetworkMaskLen": 28,
    "BandWidthMbps": 100,
    "EnableIPv6": true,
    "NoWait": false,
    "NotFoundRetry": 10
}

```

--------------------------------

### Example Usage

Source: https://docs.usacloud.jp/terraform/r/switch

Example of how to use the sakuracloud_switch resource.

```Terraform
resource "sakuracloud_switch" "foobar" {
  name        = "foobar"
  description = "description"
  tags        = ["tag1", "tag2"]
}

```

--------------------------------

### Example Usage

Source: https://docs.usacloud.jp/terraform/r/internet

Example usage of the sakuracloud_internet resource.

```Terraform
resource "sakuracloud_internet" "foobar" {
  name = "foobar"

  netmask     = 28
  band_width  = 100
  enable_ipv6 = false

  description = "description"
  tags        = ["tag1", "tag2"]
}

```

--------------------------------

### Example Usage

Source: https://docs.usacloud.jp/terraform/r/enhanced_db

Example usage of the sakuracloud_enhanced_db resource.

```hcl
resource "sakuracloud_enhanced_db" "foobar" {
  name            = "example"
  password        = "your-password"

  database_name   = "example"
  database_type   = "tidb"
  region          = "is1"

  description = "..."
  tags        = ["...", "..."]
}

```

--------------------------------

### Web Accelerator Support Example

Source: https://docs.usacloud.jp/terraform/guides/upgrade_to_v2.6.0

Example demonstrating the usage of new resources/data sources for Web Accelerator.

```Terraform
data sakuracloud_webaccel "site" {
  name = "your-site-name"
  # or
  # domain = "your-domain"
}

resource sakuracloud_webaccel_certificate "foobar" {
  site_id           = data.sakuracloud_webaccel.site.id
  certificate_chain = file("path/to/your/certificate/chain")
  private_key       = file("path/to/your/private/key")
}
```

--------------------------------

### From source

Source: https://docs.usacloud.jp/prometheus/install

ソースコードからSakura Cloud exporterをインストールする方法。

```bash
$ go install github.com/sacloud/sakuracloud_exporter

```

--------------------------------

### Parameter Examples

Source: https://docs.usacloud.jp/usacloud/references/ssh-key

Example of parameter format for SSH key.

```json
{
    "Name": "example",
    "Description": "example"
}

```

--------------------------------

### Parameter Examples

Source: https://docs.usacloud.jp/usacloud/references/esme

Example parameters for the send-message command.

```json
{
    "Destination": "81zzzzzzzzzz",
    "Sender": "example-sender",
    "DomainName": "www.example.com",
    "OTP": "your-otp"
}


```

--------------------------------

### Server Create Parameter Example

Source: https://docs.usacloud.jp/usacloud/references/server

Example JSON structure for creating a server, including disk and network interface configurations.

```json
{
    "Zone": "tk1a | tk1b | is1a | is1b | tk1v",
    "Name": "example",
    "Description": "example",
    "Tags": [
        "tag1=example1",
        "tag2=example2"
    ],
    "IconID": 123456789012,
    "CPU": 1,
    "Memory": 2,
    "GPU": 0,
    "Commitment": "standard | dedicatedcpu",
    "Generation": "default | g100 | g200",
    "InterfaceDriver": "virtio | e1000",
    "BootAfterCreate": true,
    "CDROMID": 123456789012,
    "PrivateHostID": 123456789012,
    "NetworkInterfaces": [
        {
            "Upstream": "shared | disconnected | (switch-id)",
            "PacketFilterID": 123456789012,
            "UserIPAddress": "192.0.2.11"
        }
    ],
    "Disks": [
        {
            "Description": "新規ディスクを作成する例",
            "Tags": [
                "tag1=example1",
                "tag2=example2"
            ],
            "IconID": 123456789012,
            "DiskPlan": "ssd | hdd",
            "Connection": "virtio | ide",
            "SourceDiskID": 123456789012,
            "SourceArchiveID": 123456789012,
            "SizeGB": 20,
            "DistantFrom": [
                123456789012
            ],
            "OSType": "centos | centos8stream | centos7 | almalinux | rockylinux | miracle | miraclelinux | ubuntu | ubuntu2004 | ubuntu1804 | debian | debian10 | debian11 | rancheros | k3os | kusanagi | windows2016 | windows2016-rds | windows2016-rds-office | windows2016-sql-web | windows2016-sql-standard | windows2016-sql-standard-all | windows2016-sql2017-standard | windows2016-sql2017-enterprise | windows2016-sql2017-standard-all | windows2019 | windows2019-rds | windows2019-rds-office2019 | windows2019-sql2017-web | windows2019-sql2019-web | windows2019-sql2017-standard | windows2019-sql2019-standard | windows2019-sql2017-enterprise | windows2019-sql2019-enterprise | windows2019-sql2017-standard-all | windows2019-sql2019-standard-all",
            "EditDisk": {
                "HostName": "hostname",
                "Password": "password",
                "IPAddress": "192.0.2.11",
                "NetworkMaskLen": 24,
                "DefaultRoute": "192.0.2.1",
                "DisablePWAuth": true,
                "EnableDHCP": true,
                "ChangePartitionUUID": true,
                "SSHKeys": [
                    "/path/to/your/public/key",
                    "ssh-rsa ..."
                ],
                "SSHKeyIDs": [
                    123456789012
                ],
                "IsSSHKeysEphemeral": true,
                "NoteIDs": [
                    123456789012
                ],
                "IsNotesEphemeral": true,
                "Notes": [
                    {
                        "ID": 123456789012,
                        "Variables": {
                            "variable1": "foo",
                            "variable2": "bar"
                        }
                    }
                ]
            },
            "NoWait": true
        },
        {
            "ID": 123456789012,
            "Description": "既存のディスクを接続する例",
            "EditDisk": {},
            "NoWait": false
        }
    ],
    "NoWait": false
}
```

--------------------------------

### Example Usage

Source: https://docs.usacloud.jp/terraform/r/subnet

Example usage of the sakuracloud_subnet resource.

```Terraform
resource sakuracloud_internet "foobar" {
  name = "foobar"
}

resource "sakuracloud_subnet" "foobar" {
  internet_id = sakuracloud_internet.foobar.id
  next_hop    = sakuracloud_internet.foobar.min_ip_address
}

```

--------------------------------

### Example Usage

Source: https://docs.usacloud.jp/terraform/d/apprun_application

Example usage of the sakuracloud_apprun_application data source.

```terraform
data "sakuracloud_apprun_application" "foobar" {
  name = "foobar"
}

```

--------------------------------

### Import

Source: https://docs.usacloud.jp/terraform/r/load_balancer

Example of how to import an existing Load Balancer resource.

```bash
$ terraform import sakuracloud_load_balancer.example 123456789012

```

--------------------------------

### Import

Source: https://docs.usacloud.jp/terraform/r/note

How to import an existing SakuraCloud startup script into Terraform state.

```Bash
$ terraform import sakuracloud_note.example 123456789012

```

--------------------------------

### Example Usage

Source: https://docs.usacloud.jp/terraform/r/icon

Basic example of how to use the sakuracloud_icon resource.

```Terraform
resource "sakuracloud_icon" "foobar" {
  name = "foobar"
  tags = ["tag1", "tag2"]

  base64content = filebase64("example.icon")
}

```
Tokens:
Raw