agents

Documentation

Index

• Constants
• type AddAgentCommandInput
• type AgentsAPI
• type AgentsService
  • func New(cfg *config.Config) *AgentsService
  • func (s *AgentsService) AddAgentCommand(input *AddAgentCommandInput) (output *models.AgentView, resp *http.Response, err error)
  • func (s *AgentsService) DeleteAgentCommand(input *DeleteAgentCommandInput) (resp *http.Response, err error)
  • func (s *AgentsService) GetAgentCertificateCommand(input *GetAgentCertificateCommandInput) (output *models.AgentCertificateView, resp *http.Response, err error)
  • func (s *AgentsService) GetAgentCertificatesCommand(input *GetAgentCertificatesCommandInput) (output *models.AgentCertificatesView, resp *http.Response, err error)
  • func (s *AgentsService) GetAgentCommand(input *GetAgentCommandInput) (output *models.AgentView, resp *http.Response, err error)
  • func (s *AgentsService) GetAgentFileCommand(input *GetAgentFileCommandInput) (resp *http.Response, err error)
  • func (s *AgentsService) GetAgentsCommand(input *GetAgentsCommandInput) (output *models.AgentsView, resp *http.Response, err error)
  • func (s *AgentsService) UpdateAgentCommand(input *UpdateAgentCommandInput) (output *models.AgentView, resp *http.Response, err error)
• type DeleteAgentCommandInput
• type GetAgentCertificateCommandInput
• type GetAgentCertificatesCommandInput
• type GetAgentCommandInput
• type GetAgentFileCommandInput
• type GetAgentsCommandInput
• type UpdateAgentCommandInput

Constants

const (
	// ServiceName - The name of service.
	ServiceName = "Agents"
)

Types

type AddAgentCommandInput

type AddAgentCommandInput struct {
	Body models.AgentView
}

AddAgentCommandInput - Inputs for AddAgentCommand

type AgentsAPI

type AgentsAPI interface {
	GetAgentsCommand(input *GetAgentsCommandInput) (output *models.AgentsView, resp *http.Response, err error)
	AddAgentCommand(input *AddAgentCommandInput) (output *models.AgentView, resp *http.Response, err error)
	GetAgentCertificatesCommand(input *GetAgentCertificatesCommandInput) (output *models.AgentCertificatesView, resp *http.Response, err error)
	GetAgentCertificateCommand(input *GetAgentCertificateCommandInput) (output *models.AgentCertificateView, resp *http.Response, err error)
	GetAgentFileCommand(input *GetAgentFileCommandInput) (resp *http.Response, err error)
	DeleteAgentCommand(input *DeleteAgentCommandInput) (resp *http.Response, err error)
	GetAgentCommand(input *GetAgentCommandInput) (output *models.AgentView, resp *http.Response, err error)
	UpdateAgentCommand(input *UpdateAgentCommandInput) (output *models.AgentView, resp *http.Response, err error)
}

type AgentsService

type AgentsService struct {
	*client.Client
}

AgentsService provides the API operations for making requests to Agents endpoint.

func New

func New(cfg *config.Config) *AgentsService

New createa a new instance of the AgentsService client.

Example:

cfg := config.NewConfig().WithUsername("Administrator").WithPassword("2Access").WithEndpoint(paURL)

//Create a AgentsService from the configuration
svc := agents.New(cfg)

func (*AgentsService) AddAgentCommand

func (s *AgentsService) AddAgentCommand(input *AddAgentCommandInput) (output *models.AgentView, resp *http.Response, err error)

AddAgentCommand - Add an Agent RequestType: POST Input: input *AddAgentCommandInput

func (*AgentsService) DeleteAgentCommand

func (s *AgentsService) DeleteAgentCommand(input *DeleteAgentCommandInput) (resp *http.Response, err error)

DeleteAgentCommand - Delete an Agent RequestType: DELETE Input: input *DeleteAgentCommandInput

func (*AgentsService) GetAgentCertificateCommand

func (s *AgentsService) GetAgentCertificateCommand(input *GetAgentCertificateCommandInput) (output *models.AgentCertificateView, resp *http.Response, err error)

GetAgentCertificateCommand - Get an Agent Certificate RequestType: GET Input: input *GetAgentCertificateCommandInput

func (*AgentsService) GetAgentCertificatesCommand

func (s *AgentsService) GetAgentCertificatesCommand(input *GetAgentCertificatesCommandInput) (output *models.AgentCertificatesView, resp *http.Response, err error)

GetAgentCertificatesCommand - Get all Agent Certificates RequestType: GET Input: input *GetAgentCertificatesCommandInput

func (*AgentsService) GetAgentCommand

func (s *AgentsService) GetAgentCommand(input *GetAgentCommandInput) (output *models.AgentView, resp *http.Response, err error)

GetAgentCommand - Get an Agent RequestType: GET Input: input *GetAgentCommandInput

func (*AgentsService) GetAgentFileCommand

func (s *AgentsService) GetAgentFileCommand(input *GetAgentFileCommandInput) (resp *http.Response, err error)

GetAgentFileCommand - Get a configuration file for an Agent RequestType: GET Input: input *GetAgentFileCommandInput

func (*AgentsService) GetAgentsCommand

func (s *AgentsService) GetAgentsCommand(input *GetAgentsCommandInput) (output *models.AgentsView, resp *http.Response, err error)

GetAgentsCommand - Get all Agents RequestType: GET Input: input *GetAgentsCommandInput

func (*AgentsService) UpdateAgentCommand

func (s *AgentsService) UpdateAgentCommand(input *UpdateAgentCommandInput) (output *models.AgentView, resp *http.Response, err error)

UpdateAgentCommand - Update an Agent RequestType: PUT Input: input *UpdateAgentCommandInput

type DeleteAgentCommandInput

type DeleteAgentCommandInput struct {
	Id string
}

DeleteAgentCommandInput - Inputs for DeleteAgentCommand

type GetAgentCertificateCommandInput

type GetAgentCertificateCommandInput struct {
	Id string
}

GetAgentCertificateCommandInput - Inputs for GetAgentCertificateCommand

type GetAgentCertificatesCommandInput

type GetAgentCertificatesCommandInput struct {
	Page          string
	NumberPerPage string
	Filter        string
	Alias         string
	SortKey       string
	Order         string
}

GetAgentCertificatesCommandInput - Inputs for GetAgentCertificatesCommand

type GetAgentCommandInput

type GetAgentCommandInput struct {
	Id string
}

GetAgentCommandInput - Inputs for GetAgentCommand

type GetAgentFileCommandInput

type GetAgentFileCommandInput struct {
	AgentId        string
	SharedSecretId string
}

GetAgentFileCommandInput - Inputs for GetAgentFileCommand

type GetAgentsCommandInput

type GetAgentsCommandInput struct {
	Page          string
	NumberPerPage string
	Filter        string
	Name          string
	SortKey       string
	Order         string
}

GetAgentsCommandInput - Inputs for GetAgentsCommand

type UpdateAgentCommandInput

type UpdateAgentCommandInput struct {
	Body models.AgentView
	Id   string
}

UpdateAgentCommandInput - Inputs for UpdateAgentCommand