Skip to content

Latest commit

 

History

History
211 lines (166 loc) · 7.36 KB

support_assist.md

File metadata and controls

211 lines (166 loc) · 7.36 KB
title linkTitle page_title subcategory description
powerscale_support_assist resource
powerscale_support_assist
powerscale_support_assist Resource - terraform-provider-powerscale
This resource is used to manage the Support Assist settings of PowerScale Array. We can Create, Update and Delete the Support Assist settings using this resource. Note that, Support Assist settings is the native functionality of PowerScale.

powerscale_support_assist (Resource)

This resource is used to manage the Support Assist settings of PowerScale Array. We can Create, Update and Delete the Support Assist settings using this resource. Note that, Support Assist settings is the native functionality of PowerScale.

Example Usage

/*
Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.
Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
    http://mozilla.org/MPL/2.0/
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# Available actions: Create, Read, Update, Delete and Import. Delete will clear the the state file.
# After `terraform apply` of this example file will update the settings according to the attributes set in the config.
# All attributes are optional. This resource expects atleast one attribute to be present in the config.

resource "powerscale_support_assist" "test" {
  supportassist_enabled   = true
  enable_download         = true
  automatic_case_creation = false
  enable_remote_support   = true
  accepted_terms          = true
  access_key              = "key"
  pin                     = "pin"
  telemetry = {
    offline_collection_period = 7200,
    telemetry_enabled         = true,
    telemetry_persist         = true,
    telemetry_threads         = 6
  }
  contact = {
    primary = {
      email      = "abc@gmail.com",
      first_name = "terraform_first",
      language   = "En",
      last_name  = "terraform_last",
      phone      = "1234567890"
    },
    secondary = {
      email      = "xyz@gmail.com",
      first_name = "terraform_second",
      language   = "No",
      last_name  = "terraform",
      phone      = "1234567890"
    }
  }
  connections = {
    mode = "gateway"
    gateway_endpoints = [
      {
        enabled      = true,
        host         = "1.2.3.4",
        port         = 9443,
        priority     = 1,
        use_proxy    = true,
        validate_ssl = true
      },
    ],
    network_pools = ["subnet0:pool0"]
  }
}

Schema

Optional

  • accepted_terms (Boolean) Set T&C accepted or rejected status
  • access_key (String) SupportAssist access key
  • automatic_case_creation (Boolean) True indicates automatic case creation is enabled
  • connections (Attributes) (see below for nested schema)
  • contact (Attributes) (see below for nested schema)
  • enable_download (Boolean) True indicates downloads are enabled
  • enable_remote_support (Boolean) Allow remote support.
  • pin (String) SupportAssist pin
  • supportassist_enabled (Boolean) Whether SupportAssist is enabled
  • telemetry (Attributes) (see below for nested schema)

Read-Only

  • id (String) Placeholder ID

Nested Schema for connections

Optional:

  • gateway_endpoints (Attributes List) Gateway details (see below for nested schema)
  • mode (String) Connection Mode for SupportAssist: can be direct or via gateway
  • network_pools (List of String) Network pools for gateway use

Nested Schema for connections.gateway_endpoints

Optional:

  • enabled (Boolean) Whether this gateway is enabled/disabled
  • host (String) Gateway hostname or IPv4 address
  • port (Number) Gateway port
  • priority (Number) Gateway's priority
  • use_proxy (Boolean) Whether to use Proxy for this gateway
  • validate_ssl (Boolean) Whether to validate SSL for this gateway

Nested Schema for contact

Optional:

Nested Schema for contact.primary

Optional:

  • email (String) Contact's email address.
  • first_name (String) Contact's first name.
  • language (String)
  • last_name (String) Contact's last name.
  • phone (String) Contact's phone number.

Nested Schema for contact.secondary

Optional:

  • email (String) Contact's email address.
  • first_name (String) Contact's first name.
  • language (String)
  • last_name (String) Contact's last name.
  • phone (String) Contact's phone number.

Nested Schema for telemetry

Optional:

  • offline_collection_period (Number) Change the offline collection period for when the connection to gateway is down
  • telemetry_enabled (Boolean) Change the status of telemetry
  • telemetry_persist (Boolean) Change if files are kept after upload
  • telemetry_threads (Number) Change the number of threads for telemetry gathers

Unless specified otherwise, all fields of this resource can be updated.

Import

Import is supported using the following syntax:

# Copyright (c) 2024 Dell Inc., or its subsidiaries. All Rights Reserved.

# Licensed under the Mozilla Public License Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at

#     http://mozilla.org/MPL/2.0/


# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# The command is
# terraform import powerscale_support_assist.example_support_assist <anyString>
# Example:
terraform import powerscale_support_assist.example_support_assist "support_assist"
# After running this command, populate one or more fields in the config file to start managing this resource.
# Note: running "terraform show" after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.