appgate

Documentation

Overview

Code generated by go generate; DO NOT EDIT.

Index

• Constants
• Variables
• func AppendErrorf(diags diag.Diagnostics, format string, a ...any) diag.Diagnostics
• func AppendFromErr(diags diag.Diagnostics, err error) diag.Diagnostics
• func FileExists(name string) (bool, error)
• func ImportLicenseState(ctx context.Context, d *schema.ResourceData, m interface{}) ([]*schema.ResourceData, error)
• func Nprintf(format string, params map[string]interface{}) string
• func Provider() *schema.Provider
• func ResolveAdministrativeRoleFromResourceData(ctx context.Context, d *schema.ResourceData, api *openapi.AdminRolesApiService, ...) (*openapi.AdministrativeRole, diag.Diagnostics)
• func ResolveApplianceCustomizationFromResourceData(ctx context.Context, d *schema.ResourceData, ...) (*openapi.ApplianceCustomization, diag.Diagnostics)
• func ResolveApplianceFromResourceData(ctx context.Context, d *schema.ResourceData, api *openapi.AppliancesApiService, ...) (*openapi.Appliance, diag.Diagnostics)
• func ResolveClientProfileFromResourceData(ctx context.Context, d *schema.ResourceData, ...) (*openapi.ClientProfile, diag.Diagnostics)
• func ResolveConditionFromResourceData(ctx context.Context, d *schema.ResourceData, api *openapi.ConditionsApiService, ...) (*openapi.Condition, diag.Diagnostics)
• func ResolveCriteriaScriptFromResourceData(ctx context.Context, d *schema.ResourceData, ...) (*openapi.CriteriaScript, diag.Diagnostics)
• func ResolveDeviceScriptFromResourceData(ctx context.Context, d *schema.ResourceData, ...) (*openapi.DeviceScript, diag.Diagnostics)
• func ResolveEntitlementFromResourceData(ctx context.Context, d *schema.ResourceData, ...) (*openapi.Entitlement, diag.Diagnostics)
• func ResolveEntitlementScriptFromResourceData(ctx context.Context, d *schema.ResourceData, ...) (*openapi.EntitlementScript, diag.Diagnostics)
• func ResolveIpPoolFromResourceData(ctx context.Context, d *schema.ResourceData, api *openapi.IPPoolsApiService, ...) (*openapi.IpPool, diag.Diagnostics)
• func ResolveLocalUserFromResourceData(ctx context.Context, d *schema.ResourceData, api *openapi.LocalUsersApiService, ...) (*openapi.LocalUser, diag.Diagnostics)
• func ResolveMfaProviderFromResourceData(ctx context.Context, d *schema.ResourceData, ...) (*openapi.MfaProvider, diag.Diagnostics)
• func ResolvePolicyFromResourceData(ctx context.Context, d *schema.ResourceData, api *openapi.PoliciesApiService, ...) (*openapi.Policy, diag.Diagnostics)
• func ResolveRingfenceRuleFromResourceData(ctx context.Context, d *schema.ResourceData, ...) (*openapi.RingfenceRule, diag.Diagnostics)
• func ResolveSiteFromResourceData(ctx context.Context, d *schema.ResourceData, api *openapi.SitesApiService, ...) (*openapi.Site, diag.Diagnostics)
• func ResolveTrustedCertificateFromResourceData(ctx context.Context, d *schema.ResourceData, ...) (*openapi.TrustedCertificate, diag.Diagnostics)
• func ResolveUserScriptFromResourceData(ctx context.Context, d *schema.ResourceData, ...) (*openapi.UserScript, diag.Diagnostics)
• type ApplianceStatsRetryableError
  • func (e ApplianceStatsRetryableError) Error() string
• type Client
  • func (c *Client) GetToken() (string, error)
• type Config
  • func (c *Config) Client() (*Client, error)
  • func (c *Config) Validate(usingFile bool) error
• type ContextPolicyType

Constants

const (
	Version12 int = 12
	Version13 int = 13
	Version14 int = 14
	Version15 int = 15
	Version16 int = 16
	Version17 int = 17
	Version18 int = 18
	Version19 int = 19
	Version20 int = 20
	// DefaultClientVersion is the latest support version of appgate sdp client that is supported.
	// its not recommended to change this value.
	DefaultClientVersion    = Version20
	MinimumSupportedVersion = Version18
)

const (
	PolicyTypeAccess string = "Access"
	PolicyTypeDevice string = "Device"
	PolicyTypeDns    string = "Dns"
	PolicyTypeAdmin  string = "Admin"
	PolicyTypeMixed  string = "Mixed"
	PolicyTypeStop   string = "Stop"
)

const (
	ApplianceStateInit                 = "init"
	ApplianceStateWaitingConfig        = "waiting_config"
	ApplianceStateMigratingdata        = "data_migration"
	ApplianceStateUpgrading            = "upgrading"
	ApplianceStateCloudinitializing    = "cloud_initializing"
	ApplianceStateApplianceActivating  = "appliance_activating"
	ApplianceStateApplianceRegistering = "appliance_registering"
	ApplianceStateApplianceReady       = "appliance_ready"
	ApplianceStateControllerReady      = "controller_ready"
)

const (
	// DefaultDescription is the default string for terraform resources.
	DefaultDescription = "Managed by terraform"
)

Variables

var (
	// ApplianceVersionMap match appliance version to go client version.
	ApplianceVersionMap = map[int]string{
		Version12: "5.1.0",
		Version13: "5.2.0",
		Version14: "5.3.0",
		Version15: "5.4.0",
		Version16: "5.5.0",
		Version17: "6.0.0",
		Version18: "6.1.0",
		Version19: "6.2.0",
		Version20: "6.3.0",
	}

	Appliance53Version, _ = version.NewVersion(ApplianceVersionMap[Version14])
	Appliance54Version, _ = version.NewVersion(ApplianceVersionMap[Version15])
	Appliance55Version, _ = version.NewVersion(ApplianceVersionMap[Version16])
	Appliance60Version, _ = version.NewVersion(ApplianceVersionMap[Version17])
	Appliance61Version, _ = version.NewVersion(ApplianceVersionMap[Version18])
	Appliance62Version, _ = version.NewVersion(ApplianceVersionMap[Version19])
	Appliance63Version, _ = version.NewVersion(ApplianceVersionMap[Version20])
)

var (
	ErrNetworkInactivityTimeoutEnabled = errors.New("network_inactivity_timeout_enabled is only available in 6.1 or higher")
)

Functions

func AppendErrorf

func AppendErrorf(diags diag.Diagnostics, format string, a ...any) diag.Diagnostics

func AppendFromErr

func AppendFromErr(diags diag.Diagnostics, err error) diag.Diagnostics

func FileExists

func FileExists(name string) (bool, error)

func ImportLicenseState

func ImportLicenseState(ctx context.Context, d *schema.ResourceData, m interface{}) ([]*schema.ResourceData, error)

func Nprintf

func Nprintf(format string, params map[string]interface{}) string

Nprintf is a Printf sibling (Nprintf; Named Printf), which handles strings like Nprintf("Hello %{target}!", map[string]interface{}{"target":"world"}) == "Hello world!". This is particularly useful for generated tests, where we don't want to use Printf, since that would require us to generate a very particular ordering of arguments.

func Provider

func Provider() *schema.Provider

Provider function returns the object that implements the terraform.ResourceProvider interface, specifically a schema.Provider

func ResolveAdministrativeRoleFromResourceData

func ResolveAdministrativeRoleFromResourceData(ctx context.Context, d *schema.ResourceData, api *openapi.AdminRolesApiService, token string) (*openapi.AdministrativeRole, diag.Diagnostics)

func ResolveApplianceCustomizationFromResourceData

func ResolveApplianceCustomizationFromResourceData(ctx context.Context, d *schema.ResourceData, api *openapi.ApplianceCustomizationsApiService, token string) (*openapi.ApplianceCustomization, diag.Diagnostics)

func ResolveApplianceFromResourceData

func ResolveApplianceFromResourceData(ctx context.Context, d *schema.ResourceData, api *openapi.AppliancesApiService, token string) (*openapi.Appliance, diag.Diagnostics)

func ResolveClientProfileFromResourceData

func ResolveClientProfileFromResourceData(ctx context.Context, d *schema.ResourceData, api *openapi.ClientProfilesApiService, token string) (*openapi.ClientProfile, diag.Diagnostics)

func ResolveConditionFromResourceData

func ResolveConditionFromResourceData(ctx context.Context, d *schema.ResourceData, api *openapi.ConditionsApiService, token string) (*openapi.Condition, diag.Diagnostics)

func ResolveCriteriaScriptFromResourceData

func ResolveCriteriaScriptFromResourceData(ctx context.Context, d *schema.ResourceData, api *openapi.CriteriaScriptsApiService, token string) (*openapi.CriteriaScript, diag.Diagnostics)

func ResolveDeviceScriptFromResourceData

func ResolveDeviceScriptFromResourceData(ctx context.Context, d *schema.ResourceData, api *openapi.DeviceClaimScriptsApiService, token string) (*openapi.DeviceScript, diag.Diagnostics)

func ResolveEntitlementFromResourceData

func ResolveEntitlementFromResourceData(ctx context.Context, d *schema.ResourceData, api *openapi.EntitlementsApiService, token string) (*openapi.Entitlement, diag.Diagnostics)

func ResolveEntitlementScriptFromResourceData

func ResolveEntitlementScriptFromResourceData(ctx context.Context, d *schema.ResourceData, api *openapi.EntitlementScriptsApiService, token string) (*openapi.EntitlementScript, diag.Diagnostics)

func ResolveIpPoolFromResourceData

func ResolveIpPoolFromResourceData(ctx context.Context, d *schema.ResourceData, api *openapi.IPPoolsApiService, token string) (*openapi.IpPool, diag.Diagnostics)

func ResolveLocalUserFromResourceData

func ResolveLocalUserFromResourceData(ctx context.Context, d *schema.ResourceData, api *openapi.LocalUsersApiService, token string) (*openapi.LocalUser, diag.Diagnostics)

func ResolveMfaProviderFromResourceData

func ResolveMfaProviderFromResourceData(ctx context.Context, d *schema.ResourceData, api *openapi.MFAProvidersApiService, token string) (*openapi.MfaProvider, diag.Diagnostics)

func ResolvePolicyFromResourceData

func ResolvePolicyFromResourceData(ctx context.Context, d *schema.ResourceData, api *openapi.PoliciesApiService, token string) (*openapi.Policy, diag.Diagnostics)

func ResolveRingfenceRuleFromResourceData

func ResolveRingfenceRuleFromResourceData(ctx context.Context, d *schema.ResourceData, api *openapi.RingfenceRulesApiService, token string) (*openapi.RingfenceRule, diag.Diagnostics)

func ResolveSiteFromResourceData

func ResolveSiteFromResourceData(ctx context.Context, d *schema.ResourceData, api *openapi.SitesApiService, token string) (*openapi.Site, diag.Diagnostics)

func ResolveTrustedCertificateFromResourceData

func ResolveTrustedCertificateFromResourceData(ctx context.Context, d *schema.ResourceData, api *openapi.TrustedCertificatesApiService, token string) (*openapi.TrustedCertificate, diag.Diagnostics)

func ResolveUserScriptFromResourceData

func ResolveUserScriptFromResourceData(ctx context.Context, d *schema.ResourceData, api *openapi.UserClaimScriptsApiService, token string) (*openapi.UserScript, diag.Diagnostics)

Types

type ApplianceStatsRetryableError

type ApplianceStatsRetryableError struct {
	// contains filtered or unexported fields
}

ApplianceStatsRetryableError is used when /stats/appliance should be retried.

func (ApplianceStatsRetryableError) Error

func (e ApplianceStatsRetryableError) Error() string

Error returns non-empty string if there was an error.

type Client

type Client struct {
	Token            string
	UUID             string
	ApplianceVersion *version.Version
	ClientVersion    int
	API              *openapi.APIClient
	Config           *Config
	// contains filtered or unexported fields
}

Client is the appgate API client.

func (*Client) GetToken

func (c *Client) GetToken() (string, error)

GetToken makes first login and initiate the client towards the controller. this is always the first request made

type Config

type Config struct {
	URL          string        `json:"appgate_url,omitempty"`
	Username     string        `json:"appgate_username,omitempty"`
	Password     string        `json:"appgate_password,omitempty"`
	Provider     string        `json:"appgate_provider,omitempty"`
	Insecure     bool          `json:"appgate_insecure,omitempty"`
	Timeout      int           `json:"appgate_timeout,omitempty"`
	LoginTimeout time.Duration `json:"appgate_login_timeout,omitempty"`
	Debug        bool          `json:"appgate_http_debug,omitempty"`
	Version      int           `json:"appgate_client_version,omitempty"`
	BearerToken  string        `json:"appgate_bearer_token,omitempty"`
	PemFilePath  string        `json:"appgate_pem_filepath,omitempty"`
	DeviceID     string        `json:"appgate_device_id,omitempty"`
	UserAgent    string
}

Config for appgate provider.

func (*Config) Client

func (c *Config) Client() (*Client, error)

Client creates the http client, APIClient, and setup configuration for custom pem file toggle tls verification based on config setup http proxy based on environment variables

func (*Config) Validate

func (c *Config) Validate(usingFile bool) error

Validate makes sure we have minimum required configuration values to authenticate against the controller.

type ContextPolicyType

type ContextPolicyType string

const (
	PolicyTypeCtx ContextPolicyType = "policyType"
)