customdevice

Documentation

Index

• type CustomDevice
  • func (me *CustomDevice) MarshalHCL(properties hcl.Properties) error
  • func (me *CustomDevice) Name() string
  • func (me *CustomDevice) Schema() map[string]*schema.Schema
  • func (me *CustomDevice) UnmarshalHCL(decoder hcl.Decoder) error
• type CustomDeviceGetResponse
  • func (me *CustomDeviceGetResponse) MarshalHCL(properties hcl.Properties) error
  • func (me *CustomDeviceGetResponse) Schema() map[string]*schema.Schema
  • func (me *CustomDeviceGetResponse) UnmarshalHCL(decoder hcl.Decoder) error
• type CustomDeviceResponse
• type CustomProperties
• type FromRelationshipsResponse
• type IsInstanceOf
• type PropertiesResponse

Types

type CustomDevice

type CustomDevice struct {
	EntityId       string            `json:"entityId,omitempty"`       // The ID of the custom device.
	DisplayName    *string           `json:"displayName,omitempty"`    // The name of the custom device, displayed in the UI.
	CustomDeviceID string            `json:"customDeviceId,omitempty"` // A unique name that can be provided or generated by the provider
	Group          *string           `json:"group,omitempty"`          // User defined group of entity. Changing the group requires a new custom device to be created.
	IPAddresses    []string          `json:"ipAddresses,omitempty"`    // The list of IP addresses that belong to the custom device.
	ListenPorts    []int             `json:"listenPorts,omitempty"`    // The list of ports the custom devices listens to.
	Type           *string           `json:"type,omitempty"`           // The technology type definition of the custom device.
	FaviconUrl     *string           `json:"faviconUrl,omitempty"`     // The icon to be displayed for your custom component within Smartscape. Provide the full URL of the icon file.
	ConfigUrl      *string           `json:"configUrl,omitempty"`      // The URL of a configuration web page for the custom device, such as a login page for a firewall or router.
	DNSNames       []string          `json:"dnsNames,omitempty"`       // The list of DNS names related to the custom device.
	UIBased        *bool             `json:"-"`
	Properties     map[string]string `json:"properties,omitempty"` // The list of key-value pair properties that will be shown beneath the infographics of your custom device.
}

func (*CustomDevice) MarshalHCL

func (me *CustomDevice) MarshalHCL(properties hcl.Properties) error

func (*CustomDevice) Name

func (me *CustomDevice) Name() string

func (*CustomDevice) Schema

func (me *CustomDevice) Schema() map[string]*schema.Schema

func (*CustomDevice) UnmarshalHCL

func (me *CustomDevice) UnmarshalHCL(decoder hcl.Decoder) error

type CustomDeviceGetResponse

type CustomDeviceGetResponse struct {
	Entities []*CustomDeviceResponse `json:"entities,omitempty"` // An unordered list of custom devices
}

func (*CustomDeviceGetResponse) MarshalHCL

func (me *CustomDeviceGetResponse) MarshalHCL(properties hcl.Properties) error

func (*CustomDeviceGetResponse) Schema

func (me *CustomDeviceGetResponse) Schema() map[string]*schema.Schema

func (*CustomDeviceGetResponse) UnmarshalHCL

func (me *CustomDeviceGetResponse) UnmarshalHCL(decoder hcl.Decoder) error

type CustomDeviceResponse

type CustomDeviceResponse struct {
	EntityId          string                     `json:"entityId,omitempty"`
	DisplayName       *string                    `json:"displayName,omitempty"`
	Type              *string                    `json:"type,omitempty"`
	Properties        *PropertiesResponse        `json:"properties,omitempty"`
	FromRelationships *FromRelationshipsResponse `json:"fromRelationships,omitempty"`
}

type CustomProperties

type CustomProperties struct {
	Key   string `json:"key,omitempty"`
	Value string `json:"value,omitempty"`
}

type FromRelationshipsResponse

type FromRelationshipsResponse struct {
	IsInstanceOf []*IsInstanceOf `json:"isInstanceOf,omitempty"`
}

type IsInstanceOf

type IsInstanceOf struct {
	ID   *string `json:"id,omitempty"`
	Type *string `json:"type,omitempty"`
}

type PropertiesResponse

type PropertiesResponse struct {
	DetectedName     string              `json:"detectedName,omitempty"`
	IPAddress        []string            `json:"ipAddress,omitempty"`
	ListenPorts      []int               `json:"listenPorts,omitempty"`
	CustomFavicon    *string             `json:"customFavicon,omitempty"`
	DNSNames         []string            `json:"dnsNames,omitempty"`
	CustomProperties []*CustomProperties `json:"customProperties,omitempty"`
}