controlm_go

package module

v0.0.0-...-0d6cdc9 Latest Latest Go to latest Published: Aug 11, 2021 License: MIT Imports: 21 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/dcompane/controlm_go

Links

Open Source Insights

README ¶

Go API client for controlm_go

Provides access to BMC Control-M Services

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

API version: 9.20.115
Package version: 9.20.210
Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

import "./controlm_go"

Documentation for API Endpoints

All URIs are relative to /

Class	Method	HTTP request	Description
ArchiveApi	GetArchiveJobLog	Get /archive/{jobId}/log	Get job log
ArchiveApi	GetArchiveJobOutput	Get /archive/{jobId}/output	Get job output
ArchiveApi	SearchJobs	Get /archive/search	Search jobs in Archive
BuildApi	BuildFile	Post /build	Compile definitions file to check its validity
ConfigApi	AddArchiveRule	Post /config/archive/rule	Add Workload Archiving rule
ConfigApi	AddExternalUser	Post /config/mft/externaluser	Add and external user
ConfigApi	AddExternalUserOrUserGroupToMFTFolder	Post /config/mft/virtualfolder/{folderName}/user/{userOrGroup}	Add external user or user groups to virtual folder external users list.
ConfigApi	AddGateway	Post /config/mft/gateway	add gateway.
ConfigApi	AddHostToHostgroup	Post /config/server/{server}/hostgroup/{hostgroup}/agent	add agent to hostgroup
ConfigApi	AddHubToCluster	Post /config/mft/cluster/hub/{agentname}	add hub to cluster.
ConfigApi	AddMFTFolder	Post /config/mft/virtualfolder	Add virtual folder
ConfigApi	AddMftUserGroup	Post /config/mft/usergroup	Add user group.
ConfigApi	AddPgpTemplate	Post /config/server/{server}/agent/{agent}/mft/pgptemplate/{templateName}	Add PGP Template
ConfigApi	AddRemoteHost	Post /config/server/{server}/remotehost	add remote host to Server
ConfigApi	AddRole	Post /config/authorization/role	Add Authorization Role
ConfigApi	AddRoleToLdapGroup	Post /config/authorization/ldap/{ldapgroup}/role/{role}	Add a role to LDAP group
ConfigApi	AddRoleToUser	Post /config/authorization/user/{user}/role/{role}	Add a role to user
ConfigApi	AddSecret	Post /config/secret	Add a new secret
ConfigApi	AddServer	Post /config/server	add server to the system
ConfigApi	AddUser	Post /config/authorization/user	Add user
ConfigApi	AddZosTemplate	Post /config/server/{server}/agent/{agent}/mft/zostemplate/{templateName}	Add z/OS Template
ConfigApi	AuthorizeMftSshCluster	Post /config/server/{server}/agent/{agent}/mft/ssh/cluster/{clusterName}	Authorize SSH Cluster
ConfigApi	AuthorizeMftSshHost	Post /config/server/{server}/agent/{agent}/mft/ssh/host/{hostname}	Authorize SSH Host
ConfigApi	AuthorizeSshKnownRemotehost	Post /config/server/{server}/remotehost/{remotehost}/authorize	Authorize
ConfigApi	ChangeUserPassword	Post /config/user/{user}/password/adminUpdate	Change user password
ConfigApi	CreateAgentCertificateSigningRequest	Post /config/server/{server}/agent/{agent}/csr	Create certificate signing request (CSR).
ConfigApi	CreateRunAsUser	Post /config/server/{server}/runasuser	Add a new Run-as user
ConfigApi	DeleteAgent	Delete /config/server/{server}/agent/{agent}	delete an agent from Server
ConfigApi	DeleteArchiveRule	Delete /config/archive/rule/{ruleName}	Delete Workload Archiving rule
ConfigApi	DeleteAuthorizationRole	Delete /config/authorization/role/{role}	Delete Authorization Role
ConfigApi	DeleteExternalUser	Delete /config/mft/externaluser/{username}	Delete an external user
ConfigApi	DeleteExternalUserOrUserGroupFromMFTFolder	Delete /config/mft/virtualfolder/{folderName}/user/{userOrGroup}	Remove an external user or user group from an existing virtual folder in MFT.
ConfigApi	DeleteHostFromGroup	Delete /config/server/{server}/hostgroup/{hostgroup}/agent/{host}	delete an agent from a hostgroup
ConfigApi	DeleteHostGroup	Delete /config/server/{server}/hostgroup/{hostgroup}	delete host group
ConfigApi	DeleteMFTFolder	Delete /config/mft/virtualfolder/{folderName}	Delete a virtual folder.
ConfigApi	DeleteMftUserGroup	Delete /config/mft/usergroup/{name}	Delete user group.
ConfigApi	DeletePgpTemplate	Delete /config/server/{server}/agent/{agent}/mft/pgptemplate/{templateName}	Delete PGP Template
ConfigApi	DeleteRemoteHost	Delete /config/server/{server}/remotehost/{remotehost}	delete a remote host from Server
ConfigApi	DeleteRoleFromLdapGroup	Delete /config/authorization/ldap/{ldapgroup}/role/{role}	Delete a role from LDAP group
ConfigApi	DeleteRunAsUser	Delete /config/server/{server}/runasuser/{agent}/{user}	delete Run-as user
ConfigApi	DeleteSecret	Delete /config/secret/{name}	Delete an existing secret
ConfigApi	DeleteUser	Delete /config/authorization/user/{user}	Delete user
ConfigApi	DeleteZosTemplate	Delete /config/server/{server}/agent/{agent}/mft/zostemplate/{templateName}	Delete z/OS Template
ConfigApi	DeployAgentCertificate	Post /config/server/{server}/agent/{agent}/crt	Deploy certificate (CRT).
ConfigApi	DisableAgent	Post /config/server/{server}/agent/{agent}/disable	disable agent from the Server
ConfigApi	EnableAgent	Post /config/server/{server}/agent/{agent}/enable	enable agent from the Server
ConfigApi	Failover	Put /config/server/{server}/failover	Perform Manual Failover on a specified Server
ConfigApi	GenerateMftRsaSshKey	Post /config/server/{server}/agent/{agent}/mft/ssh/key	Generate RSA SSH Key
ConfigApi	GetAgentCertificateExpirationDate	Get /config/server/{server}/agent/{agent}/crt/expiration	Get certificate expiration date.
ConfigApi	GetAgentParameters	Get /config/server/{server}/agent/{agent}/params	get agent parameters
ConfigApi	GetAgents	Get /config/server/{server}/agents	get Server agents
ConfigApi	GetAllArchiveRules	Get /config/archive/rules	Get all Workload Archiving rules
ConfigApi	GetAllAuthorizationRoles	Get /config/authorization/roles	Get Authorization Roles
ConfigApi	GetAllLdapGroups	Get /config/authorization/ldaps	Get All LDAP groups
ConfigApi	GetAllRolesAssociatedWithLdap	Get /config/authorization/ldap/{ldapgroup}/roles	Get Authorization Roles associated with an LDAP group
ConfigApi	GetAllUsers	Get /config/authorization/users	Get users
ConfigApi	GetArchiveStatistics	Get /config/archive/statistics	Get Workload Archiving statistics
ConfigApi	GetExternalUserAuthorizedFolders	Get /config/mft/externaluser/{name}/virtualfolders	Get MFT external user authorized folders
ConfigApi	GetExternalUsers	Get /config/mft/externalusers	Get MFT external users that match the search criteria.
ConfigApi	GetFtsSettings	Get /config/server/{server}/agent/{agent}/mft/fts/settings	Get File Transfer Server (FTS) configuration data.
ConfigApi	GetHostgroups	Get /config/server/{server}/hostgroups	get Server hostgroups
ConfigApi	GetHostsInGroup	Get /config/server/{server}/hostgroup/{hostgroup}/agents	get hostgroup agents
ConfigApi	GetHubStatusDetails	Get /config/mft/hub/{nodeId}/status	Get hub status.
ConfigApi	GetMFTFolders	Get /config/mft/virtualfolders	Get MFT virtual folders that match the search criteria.
ConfigApi	GetMftConfiguration	Get /config/server/{server}/agent/{agent}/mft/configuration	Get MFT Configuration
ConfigApi	GetMftGateways	Get /config/mft/gateways	Get MFT gateways
ConfigApi	GetMftUserGroups	Get /config/mft/usergroups	Get all user groups that match the search criteria.
ConfigApi	GetPgpTemplates	Get /config/server/{server}/agent/{agent}/mft/pgptemplates	Get PGP Templates
ConfigApi	GetRemoteHostProperties	Get /config/server/{server}/remotehost/{remotehost}	get a remote host configuration from Server
ConfigApi	GetRemoteHosts	Get /config/server/{server}/remotehosts	get Server remote hosts
ConfigApi	GetRole	Get /config/authorization/role/{role}	Get Authorization Role
ConfigApi	GetRoleAssociates	Get /config/authorization/role/{role}/associates	Get all authorization entities associated with role
ConfigApi	GetRunAsUser	Get /config/server/{server}/runasuser/{agent}/{user}	Get Run-as user
ConfigApi	GetRunAsUsersList	Get /config/server/{server}/runasusers	Get Run-as user list that match the requested search criteria.
ConfigApi	GetServerParameters	Get /config/server/{server}/params	get Server parameters
ConfigApi	GetServers	Get /config/servers	get all the Servers name and hostname in the system
ConfigApi	GetUser	Get /config/authorization/user/{user}	Get user
ConfigApi	GetUserEffectiveRights	Get /config/authorization/user/effectiveRights	Get user real effective authorizations
ConfigApi	GetZosTemplates	Get /config/server/{server}/agent/{agent}/mft/zostemplates	Get z/OS Templates
ConfigApi	ListSecrets	Get /config/secrets	Get list of secret names
ConfigApi	PingAgent	Post /config/server/{server}/agent/{agent}/ping	ping to the agent in the Server
ConfigApi	RecycleItem	Post /config/item/{id}/recycle	recycle item
ConfigApi	RemoveControlmServer	Delete /config/server/{server}	Delete Server
ConfigApi	RemoveGateway	Delete /config/mft/gateway/{gatewayName}	remove gateway.
ConfigApi	RemoveHubFromCluster	Delete /config/mft/cluster/hub/{agentname}	remove hub from cluster.
ConfigApi	RemoveRoleFromUser	Delete /config/authorization/user/{user}/role/{role}	Remove a role from a user
ConfigApi	SendArchiveCleanupRequest	Delete /config/archive/cleanup	Deletes data (jobs including outputs and logs) from the Workload Archiving database.
ConfigApi	SetAgentParameter	Post /config/server/{server}/agent/{agent}/param/{name}	set agent parameter
ConfigApi	SetSystemParam	Post /config/em/param/{name}	set value of a an em system parameter
ConfigApi	Setasprimary	Put /config/server/{server}/setasprimary	Set secondary server as Primary on a specified Server
ConfigApi	TestRunAsUser	Post /config/server/{server}/runasuser/{agent}/{user}/test	Test existed Run-as user
ConfigApi	UpdateArchiveRule	Post /config/archive/rule/{ruleName}	Edit Workload Archiving rule
ConfigApi	UpdateExternalUser	Post /config/mft/externaluser/{username}	Update an external user
ConfigApi	UpdateFtsSettings	Post /config/server/{server}/agent/{agent}/mft/fts/settings	Update File Transfer Server (FTS) configuration data.
ConfigApi	UpdateHostsInHostgroup	Post /config/server/{server}/hostgroup/{hostgroup}	update agents in hostgroup.
ConfigApi	UpdateMFTFolder	Post /config/mft/virtualfolder/{folderName}	Update an existing virtual folder in MFT.
ConfigApi	UpdateMftConfiguration	Post /config/server/{server}/agent/{agent}/mft/configuration	Update MFT Configuration
ConfigApi	UpdateMftUserGroup	Post /config/mft/usergroup/{name}	Update user group.
ConfigApi	UpdatePgpTemplate	Put /config/server/{server}/agent/{agent}/mft/pgptemplate/{templateName}	Update PGP Template
ConfigApi	UpdateRole	Post /config/authorization/role/{role}	Update Authorization Role
ConfigApi	UpdateRunAsUser	Post /config/server/{server}/runasuser/{agent}/{user}	Update Run-as user
ConfigApi	UpdateSecret	Post /config/secret/{name}	Update an existing secret
ConfigApi	UpdateUser	Post /config/authorization/user/{user}	Update user
ConfigApi	UpdateZosTemplate	Put /config/server/{server}/agent/{agent}/mft/zostemplate/{templateName}	Update z/OS Template
DeployApi	DeleteCalendar	Delete /deploy/calendar/{calendarName}	delete a calendar
DeployApi	DeleteConnectionProfile	Delete /deploy/connectionprofile/{server}/{agent}/{type}/{name}	Delete Local Connection Profile
DeployApi	DeleteFolder	Delete /deploy/folder/{controlM}/{folderName}	delete a folder
DeployApi	DeleteLocalConnectionProfile	Delete /deploy/connectionprofile/local/{server}/{agent}/{type}/{name}	Delete Local Connection Profile
DeployApi	DeleteSharedConnectionProfile	Delete /deploy/connectionprofile/centralized/{type}/{name}	Delete centralized Connection Profile
DeployApi	DeployAiJobtype	Post /deploy/ai/jobtype	Deploy of Application Integrator job type.
DeployApi	DeployFile	Post /deploy	Deploy definitions file
DeployApi	DeployJobtypeFile	Post /deploy/jobtype	Deploy jobtype
DeployApi	GetConnectionProfilesDeploymentStatus	Get /deploy/connectionprofile/centralized/deploymentstatus/{type}/{name}	Get deployed connection profiles deployment status
DeployApi	GetDeployedAiJobtypes	Get /deploy/ai/jobtypes	Get Application Integrator job types
DeployApi	GetDeployedCalendars	Get /deploy/calendars	Get deployed calendars that match the search criteria.
DeployApi	GetDeployedConnectionProfiles	Get /deploy/connectionprofiles	Get local deployed connection profiles
DeployApi	GetDeployedConnectionProfilesStatus	Get /deploy/connectionprofiles/centralized/status	Get deployed connection profiles status
DeployApi	GetDeployedFoldersNew	Get /deploy/jobs	Get deployed jobs that match the search criteria.
DeployApi	GetLocalConnectionProfiles	Get /deploy/connectionprofiles/local	Get local deployed connection profiles
DeployApi	GetSharedConnectionProfiles	Get /deploy/connectionprofiles/centralized	Get centralized deployed connection profile
DeployApi	GetSiteStandardFieldRestrictions	Get /deploy/sitestandard/{standardName}/fieldRestriction/{fieldName}	Get the allowed values for the specified field in the specified site standard.
DeployApi	SetSiteStandardFieldRestrictions	Post /deploy/sitestandard/{standardName}/fieldRestriction/{fieldName}	Replace the allowed values for the specified field in the specified site standard.
DeployApi	TestConnectionProfile	Post /deploy/connectionprofile/test	Test connection profile on agent
DeployApi	TransformFile	Post /deploy/transform	Transform a definitions file
ProvisionApi	CancelUpgradeActivity	Post /provision/upgrade/{upgradeId}/cancel	Cancel upgrade activity
ProvisionApi	DeleteUpgradeActivity	Delete /provision/upgrade/{upgradeId}	Delete upgrade activity status for specific upgrade id.
ProvisionApi	GetAllUpgradeActivitiesStatus	Get /provision/upgrades	Get all upgrade activities status.
ProvisionApi	GetDeployVersions	Get /provision/upgrades/versions	Get available versions for upgrade.
ProvisionApi	GetEligibleAgentsForUpgrade	Get /provision/upgrades/agents	Get eligible agents for upgrade that match the requested search criteria.
ProvisionApi	GetImages	Get /provision/images/{os}	get list of available images for the requested OS
ProvisionApi	GetUpgradeActivityLog	Get /provision/upgrade/{upgradeId}/output	Returns log of upgrade activity.
ProvisionApi	GetUpgradeActivityStatusPerUpgradeId	Get /provision/upgrade/{upgradeId}	Get upgrade activity status for specific upgrade id.
ProvisionApi	RetryUpgradeActivity	Post /provision/upgrade/{upgradeId}/retry	Retry upgrade activity
ProvisionApi	TransferAndInstallProduct	Post /provision/upgrade/install	Transfer and install a product on an agent
ProvisionApi	UninstallProduct	Post /provision/upgrade/uninstall	Uninstall a product from an agent
ReportingApi	GetReportByName	Get /reporting/report/{name}	Retrieves a report by name.
ReportingApi	GetReportFilters	Get /reporting/reportFilters/{name}	Retrieves report filters
ReportingApi	GetReportStatus	Get /reporting/status/{reportId}	Retrieves status information for a report generation request based on the report ID
ReportingApi	RunReport	Post /reporting/report	Run a report
RunApi	ActivateWorkloadPolicy	Post /run/workloadpolicy/{policy}/activate	activate workload policy
RunApi	AddEvent	Post /run/event/{server}	Add a new event.
RunApi	AddResource	Post /run/resource/{server}	Add a new pool resource.
RunApi	ConfirmJob	Post /run/job/{jobId}/confirm	confirm a job
RunApi	DeactivateWorkloadPolicy	Post /run/workloadpolicy/{policy}/deactivate	deactivate a workload policy
RunApi	DeleteEvent	Delete /run/event/{server}/{name}/{date}	Delete a event.
RunApi	DeleteJob	Post /run/job/{jobId}/delete	mark job as deleted
RunApi	DeleteResource	Delete /run/resource/{server}/{name}	Delete a pool resource.
RunApi	FreeJob	Post /run/job/{jobId}/free	free an already held the job
RunApi	GetActiveJob	Get /run/job/{jobId}/get	get active job
RunApi	GetActiveServices	Get /run/services/sla	Get SLA active services
RunApi	GetEvents	Get /run/events	Get all events records for specific search.
RunApi	GetJobLog	Get /run/job/{jobId}/log	Get job's log
RunApi	GetJobOutput	Get /run/job/{jobId}/output	Get job output
RunApi	GetJobStatistics	Get /run/job/{jobId}/statistics	Get job statistics
RunApi	GetJobStatus	Get /run/job/{jobId}/status	Get status of a job
RunApi	GetJobsStatus	Get /run/status/{runId}	Get status of running jobs
RunApi	GetJobsStatusByFilter	Get /run/jobs/status	Get jobs that match the search criteria.
RunApi	GetResources	Get /run/resources	Get all resources records matching search.
RunApi	GetWaitingInfo	Get /run/job/{jobId}/waitingInfo	get job's waiting information
RunApi	GetWorkloadPolicies	Get /run/workloadpolicies	get workload policies
RunApi	HoldJob	Post /run/job/{jobId}/hold	hold the job so it will not start untill it is freed
RunApi	KillJob	Post /run/job/{jobId}/kill	Cancel running job
RunApi	ModifyJob	Post /run/job/{jobId}/modify	Modify active job
RunApi	OrderJobsInFolder	Post /run/order	Execute requested jobs in certain folder
RunApi	RerunJob	Post /run/job/{jobId}/rerun	Run job again
RunApi	RunJobs	Post /run	Run jobs
RunApi	RunNow	Post /run/job/{jobId}/runNow	Bypass scheduling cretirias and start the job
RunApi	SetToOK	Post /run/job/{jobId}/setToOk	set job end status to OK
RunApi	UndeleteJob	Post /run/job/{jobId}/undelete	recover a mark for deletion job
RunApi	UpdateAlert	Post /run/alerts	Update alert.
RunApi	UpdateAlertStatus	Post /run/alerts/status	Update alert status.
RunApi	UpdateResource	Post /run/resource/{server}/{name}	Update a pool resource.
SessionApi	DoLogin	Post /session/login	login user to Control-M
SessionApi	DoLogout	Post /session/logout	logout user from Control-M
SessionApi	UpdateMyPassword	Post /session/user/password/update	Change my password

Documentation For Models

Documentation For Authorization

Bearer

Type: API key

Example

auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
	Key: "APIKEY",
	Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)

Author

customer_support@bmc.com

Documentation ¶

Overview ¶

* Control-M Services * * Provides access to BMC Control-M Services * * API version: 9.20.115 * Contact: customer_support@bmc.com * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Variables
func CacheExpires(r *http.Response) time.Time
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
- func (c *APIClient) ChangeBasePath(path string)
type APIKey
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type ActionsAuthRecord
type ActiveServices
type AddAgentParams
type AddRemoteHostParams
type AddRemoveSuccessData
type AddServerParams
type AgentCertificateExpirationData
type AgentData
type AgentDetails
type AgentDetailsList
type AgentInGroupParams
type AgentInGroupParamsList
type AgentInHostgroup
type AgentMngAuth
type AgentThingProperties
type AgentsInGroupSuccessData
type AiDeployResponse
type AiError
type AiJobtype
type AiJobtypeList
type AlertParam
type AlertStatusParam
type AllowedJobActions
type AllowedJobs
type ApiGtwSession
type ApiThrowable
type App
type AppDeployResponse
type AppDeployed
type AppList
type AppPredeployResponse
type ArchiveApiSearchJobsOpts
type ArchiveApiService
- func (a *ArchiveApiService) GetArchiveJobLog(ctx context.Context, jobId string, runNo int64) (string, *http.Response, error)
- func (a *ArchiveApiService) GetArchiveJobOutput(ctx context.Context, jobId string, runNo int64) (string, *http.Response, error)
- func (a *ArchiveApiService) SearchJobs(ctx context.Context, localVarOptionals *ArchiveApiSearchJobsOpts) (ArchiveJobsList, *http.Response, error)
type ArchiveJobsList
type ArchiveRule
type ArchiveRulesList
type As2KeyData
type AssociateData
type AuthenticateCredentials
type AuthenticateCredentialsAdditionalAttributes
type AuthenticationData
type Availability
type BasicAuth
type Body
type Body1
type Body10
type Body11
type Body2
type Body3
type Body4
type Body5
type Body6
type Body7
type Body8
type Body9
type BuildApiService
- func (a *BuildApiService) BuildFile(ctx context.Context, definitionsFile *os.File, deployDescriptorFile *os.File) ([]DeploymentFileResults, *http.Response, error)
type CertificateSigningRequestData
type ClientAccessPrivilegeCategory
type Cluster
type ClusterAuthorizationData
type CommunicationAnalysisResponseType
type ComponentKeyWithStatusType
type ComponentMetaDataProperties
type ComponentMftKeyType
type ConditionProperties
type ConfigApiAddRemoteHostOpts
type ConfigApiAuthorizeMftSshHostOpts
type ConfigApiChangeUserPasswordOpts
type ConfigApiGetAgentParametersOpts
type ConfigApiGetAgentsOpts
type ConfigApiGetAllAuthorizationRolesOpts
type ConfigApiGetAllLdapGroupsOpts
type ConfigApiGetAllRolesAssociatedWithLdapOpts
type ConfigApiGetAllUsersOpts
type ConfigApiGetExternalUsersOpts
type ConfigApiGetMFTFoldersOpts
type ConfigApiGetMftUserGroupsOpts
type ConfigApiGetPgpTemplatesOpts
type ConfigApiGetRunAsUsersListOpts
type ConfigApiGetZosTemplatesOpts
type ConfigApiPingAgentOpts
type ConfigApiSendArchiveCleanupRequestOpts
type ConfigApiService
- func (a *ConfigApiService) AddArchiveRule(ctx context.Context, body ArchiveRule) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) AddExternalUser(ctx context.Context, body ExternalUserData) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) AddExternalUserOrUserGroupToMFTFolder(ctx context.Context, folderName string, userOrGroup string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) AddGateway(ctx context.Context, body GatewayData) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) AddHostToHostgroup(ctx context.Context, body AgentInHostgroup, server string, hostgroup string) (AgentsInGroupSuccessData, *http.Response, error)
- func (a *ConfigApiService) AddHubToCluster(ctx context.Context, agentname string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) AddMFTFolder(ctx context.Context, body FolderPropertiesData) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) AddMftUserGroup(ctx context.Context, body UserGroupPropertiesData) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) AddPgpTemplate(ctx context.Context, body PgpTemplateData, server string, agent string, ...) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) AddRemoteHost(ctx context.Context, server string, ...) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) AddRole(ctx context.Context, roleFile *os.File) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) AddRoleToLdapGroup(ctx context.Context, ldapgroup string, role string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) AddRoleToUser(ctx context.Context, user string, role string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) AddSecret(ctx context.Context, body SecretKeyValue) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) AddServer(ctx context.Context, body AddServerParams) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) AddUser(ctx context.Context, userFile *os.File) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) AddZosTemplate(ctx context.Context, body ZosTemplateData, server string, agent string, ...) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) AuthorizeMftSshCluster(ctx context.Context, body ClusterAuthorizationData, server string, ...) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) AuthorizeMftSshHost(ctx context.Context, server string, agent string, hostname string, ...) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) AuthorizeSshKnownRemotehost(ctx context.Context, server string, remotehost string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) ChangeUserPassword(ctx context.Context, user string, ...) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) CreateAgentCertificateSigningRequest(ctx context.Context, body CertificateSigningRequestData, server string, ...) (string, *http.Response, error)
- func (a *ConfigApiService) CreateRunAsUser(ctx context.Context, body RunAsUserData, server string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) DeleteAgent(ctx context.Context, server string, agent string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) DeleteArchiveRule(ctx context.Context, ruleName string, deleteRuleDataFlag string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) DeleteAuthorizationRole(ctx context.Context, role string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) DeleteExternalUser(ctx context.Context, username string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) DeleteExternalUserOrUserGroupFromMFTFolder(ctx context.Context, folderName string, userOrGroup string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) DeleteHostFromGroup(ctx context.Context, server string, hostgroup string, host string) (AgentsInGroupSuccessData, *http.Response, error)
- func (a *ConfigApiService) DeleteHostGroup(ctx context.Context, server string, hostgroup string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) DeleteMFTFolder(ctx context.Context, folderName string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) DeleteMftUserGroup(ctx context.Context, name string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) DeletePgpTemplate(ctx context.Context, server string, agent string, templateName string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) DeleteRemoteHost(ctx context.Context, server string, remotehost string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) DeleteRoleFromLdapGroup(ctx context.Context, ldapgroup string, role string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) DeleteRunAsUser(ctx context.Context, server string, agent string, user string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) DeleteSecret(ctx context.Context, name string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) DeleteUser(ctx context.Context, user string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) DeleteZosTemplate(ctx context.Context, server string, agent string, templateName string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) DeployAgentCertificate(ctx context.Context, crtFile *os.File, caChainFile *os.File, server string, ...) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) DisableAgent(ctx context.Context, server string, agent string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) EnableAgent(ctx context.Context, server string, agent string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) Failover(ctx context.Context, server string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) GenerateMftRsaSshKey(ctx context.Context, body SshKeyProperties, server string, agent string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) GetAgentCertificateExpirationDate(ctx context.Context, server string, agent string) (AgentCertificateExpirationData, *http.Response, error)
- func (a *ConfigApiService) GetAgentParameters(ctx context.Context, server string, agent string, ...) ([]KeyValue, *http.Response, error)
- func (a *ConfigApiService) GetAgents(ctx context.Context, server string, localVarOptionals *ConfigApiGetAgentsOpts) (AgentDetailsList, *http.Response, error)
- func (a *ConfigApiService) GetAllArchiveRules(ctx context.Context) (ArchiveRulesList, *http.Response, error)
- func (a *ConfigApiService) GetAllAuthorizationRoles(ctx context.Context, localVarOptionals *ConfigApiGetAllAuthorizationRolesOpts) ([]RoleHeader, *http.Response, error)
- func (a *ConfigApiService) GetAllLdapGroups(ctx context.Context, localVarOptionals *ConfigApiGetAllLdapGroupsOpts) ([]string, *http.Response, error)
- func (a *ConfigApiService) GetAllRolesAssociatedWithLdap(ctx context.Context, ldapgroup string, ...) ([]string, *http.Response, error)
- func (a *ConfigApiService) GetAllUsers(ctx context.Context, localVarOptionals *ConfigApiGetAllUsersOpts) ([]UserHeader, *http.Response, error)
- func (a *ConfigApiService) GetArchiveStatistics(ctx context.Context) (RulesStatisticListSummary, *http.Response, error)
- func (a *ConfigApiService) GetExternalUserAuthorizedFolders(ctx context.Context, name string) ([]string, *http.Response, error)
- func (a *ConfigApiService) GetExternalUsers(ctx context.Context, localVarOptionals *ConfigApiGetExternalUsersOpts) ([]ExternalUserData, *http.Response, error)
- func (a *ConfigApiService) GetFtsSettings(ctx context.Context, server string, agent string) (FtsSettingsData, *http.Response, error)
- func (a *ConfigApiService) GetHostgroups(ctx context.Context, server string) ([]string, *http.Response, error)
- func (a *ConfigApiService) GetHostsInGroup(ctx context.Context, server string, hostgroup string) ([]AgentInGroupParams, *http.Response, error)
- func (a *ConfigApiService) GetHubStatusDetails(ctx context.Context, nodeId string) (string, *http.Response, error)
- func (a *ConfigApiService) GetMFTFolders(ctx context.Context, localVarOptionals *ConfigApiGetMFTFoldersOpts) ([]FolderPropertiesData, *http.Response, error)
- func (a *ConfigApiService) GetMftConfiguration(ctx context.Context, server string, agent string) (MftConfigurationData, *http.Response, error)
- func (a *ConfigApiService) GetMftGateways(ctx context.Context) ([]GatewayData, *http.Response, error)
- func (a *ConfigApiService) GetMftUserGroups(ctx context.Context, localVarOptionals *ConfigApiGetMftUserGroupsOpts) ([]UserGroupPropertiesData, *http.Response, error)
- func (a *ConfigApiService) GetPgpTemplates(ctx context.Context, server string, agent string, ...) ([]PgpTemplateData, *http.Response, error)
- func (a *ConfigApiService) GetRemoteHostProperties(ctx context.Context, server string, remotehost string) (AddRemoteHostParams, *http.Response, error)
- func (a *ConfigApiService) GetRemoteHosts(ctx context.Context, server string) ([]string, *http.Response, error)
- func (a *ConfigApiService) GetRole(ctx context.Context, role string) (RoleData, *http.Response, error)
- func (a *ConfigApiService) GetRoleAssociates(ctx context.Context, role string) ([]AssociateData, *http.Response, error)
- func (a *ConfigApiService) GetRunAsUser(ctx context.Context, server string, agent string, user string) (RunAsUserData, *http.Response, error)
- func (a *ConfigApiService) GetRunAsUsersList(ctx context.Context, server string, ...) ([]RunAsUserData, *http.Response, error)
- func (a *ConfigApiService) GetServerParameters(ctx context.Context, server string) ([]KeyValue, *http.Response, error)
- func (a *ConfigApiService) GetServers(ctx context.Context) ([]CtmDetails, *http.Response, error)
- func (a *ConfigApiService) GetUser(ctx context.Context, user string) (UserData, *http.Response, error)
- func (a *ConfigApiService) GetUserEffectiveRights(ctx context.Context) (RoleData, *http.Response, error)
- func (a *ConfigApiService) GetZosTemplates(ctx context.Context, server string, agent string, ...) ([]ZosTemplateData, *http.Response, error)
- func (a *ConfigApiService) ListSecrets(ctx context.Context) ([]string, *http.Response, error)
- func (a *ConfigApiService) PingAgent(ctx context.Context, server string, agent string, ...) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) RecycleItem(ctx context.Context, id string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) RemoveControlmServer(ctx context.Context, server string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) RemoveGateway(ctx context.Context, gatewayName string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) RemoveHubFromCluster(ctx context.Context, agentname string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) RemoveRoleFromUser(ctx context.Context, user string, role string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) SendArchiveCleanupRequest(ctx context.Context, localVarOptionals *ConfigApiSendArchiveCleanupRequestOpts) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) SetAgentParameter(ctx context.Context, body Value, server string, agent string, name string) (KeyValue, *http.Response, error)
- func (a *ConfigApiService) SetSystemParam(ctx context.Context, body Value, name string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) Setasprimary(ctx context.Context, server string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) TestRunAsUser(ctx context.Context, server string, agent string, user string, ...) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) UpdateArchiveRule(ctx context.Context, body ArchiveRule, ruleName string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) UpdateExternalUser(ctx context.Context, body ExternalUserData, username string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) UpdateFtsSettings(ctx context.Context, body FtsSettingsData, server string, agent string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) UpdateHostsInHostgroup(ctx context.Context, body HostgroupProperties, server string, hostgroup string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) UpdateMFTFolder(ctx context.Context, body FolderPropertiesData, folderName string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) UpdateMftConfiguration(ctx context.Context, body MftConfigurationData, server string, agent string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) UpdateMftUserGroup(ctx context.Context, body UserGroupDetailsData, name string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) UpdatePgpTemplate(ctx context.Context, body PgpTemplateData, server string, agent string, ...) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) UpdateRole(ctx context.Context, roleFile *os.File, role string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) UpdateRunAsUser(ctx context.Context, body RunAsUserDetailsData, server string, agent string, ...) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) UpdateSecret(ctx context.Context, name string, localVarOptionals *ConfigApiUpdateSecretOpts) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) UpdateUser(ctx context.Context, userFile *os.File, user string) (SuccessData, *http.Response, error)
- func (a *ConfigApiService) UpdateZosTemplate(ctx context.Context, body ZosTemplateData, server string, agent string, ...) (SuccessData, *http.Response, error)
type ConfigApiTestRunAsUserOpts
type ConfigApiUpdateSecretOpts
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type ConfigurationManagerPrivilegeCategory
type ConnectionProfileDeploymentInfo
type ConnectionProfileStatus
type ConnectionProfilesDeploymentStatusResult
type ConnectionProfilesStatusResult
type ControlMAuthenticationData
type CpMngAuth
type CtmDetails
type CtmNameValueSw
type CtmagentBasicInfoType
type CtmagentCtmTestType
type CtmagentStateChangedType
type CtmvarDelResultItem
type CtmvarDelResults
type CtmvarErrorInfo
type CtmvarGetResultItem
type CtmvarGetResults
type CtmvarResultItem
type CtmvarResults
type CtmvarSetResultItem
type CtmvarSetResults
type DeployApiDeleteCalendarOpts
type DeployApiDeployJobtypeFileOpts
type DeployApiGetDeployedAiJobtypesOpts
type DeployApiGetDeployedCalendarsOpts
type DeployApiGetDeployedConnectionProfilesOpts
type DeployApiGetDeployedConnectionProfilesStatusOpts
type DeployApiGetDeployedFoldersNewOpts
type DeployApiGetLocalConnectionProfilesOpts
type DeployApiGetSharedConnectionProfilesOpts
type DeployApiService
- func (a *DeployApiService) DeleteCalendar(ctx context.Context, calendarName string, ...) (SuccessData, *http.Response, error)
- func (a *DeployApiService) DeleteConnectionProfile(ctx context.Context, server string, agent string, type_ string, name string) (SuccessData, *http.Response, error)
- func (a *DeployApiService) DeleteFolder(ctx context.Context, controlM string, folderName string) (SuccessData, *http.Response, error)
- func (a *DeployApiService) DeleteLocalConnectionProfile(ctx context.Context, server string, agent string, type_ string, name string) (SuccessData, *http.Response, error)
- func (a *DeployApiService) DeleteSharedConnectionProfile(ctx context.Context, type_ string, name string) (SuccessData, *http.Response, error)
- func (a *DeployApiService) DeployAiJobtype(ctx context.Context, ctm string, agent string, jobTypeId string) (AiDeployResponse, *http.Response, error)
- func (a *DeployApiService) DeployFile(ctx context.Context, definitionsFile *os.File, deployDescriptorFile *os.File, ...) ([]DeploymentFileResults, *http.Response, error)
- func (a *DeployApiService) DeployJobtypeFile(ctx context.Context, definitionsFile *os.File, payloadFile *os.File, ...) (DeployJobtypeResponse, *http.Response, error)
- func (a *DeployApiService) GetConnectionProfilesDeploymentStatus(ctx context.Context, type_ string, name string) (ConnectionProfilesDeploymentStatusResult, *http.Response, error)
- func (a *DeployApiService) GetDeployedAiJobtypes(ctx context.Context, localVarOptionals *DeployApiGetDeployedAiJobtypesOpts) (AiJobtypeList, *http.Response, error)
- func (a *DeployApiService) GetDeployedCalendars(ctx context.Context, localVarOptionals *DeployApiGetDeployedCalendarsOpts) (string, *http.Response, error)
- func (a *DeployApiService) GetDeployedConnectionProfiles(ctx context.Context, agent string, type_ string, ...) (string, *http.Response, error)
- func (a *DeployApiService) GetDeployedConnectionProfilesStatus(ctx context.Context, ...) (ConnectionProfilesStatusResult, *http.Response, error)
- func (a *DeployApiService) GetDeployedFoldersNew(ctx context.Context, localVarOptionals *DeployApiGetDeployedFoldersNewOpts) (string, *http.Response, error)
- func (a *DeployApiService) GetLocalConnectionProfiles(ctx context.Context, agent string, type_ string, ...) (string, *http.Response, error)
- func (a *DeployApiService) GetSharedConnectionProfiles(ctx context.Context, type_ string, ...) (string, *http.Response, error)
- func (a *DeployApiService) GetSiteStandardFieldRestrictions(ctx context.Context, standardName string, fieldName string) (string, *http.Response, error)
- func (a *DeployApiService) SetSiteStandardFieldRestrictions(ctx context.Context, body FieldValues, standardName string, fieldName string) (SuccessData, *http.Response, error)
- func (a *DeployApiService) TestConnectionProfile(ctx context.Context, definitionsFile *os.File, ...) (SuccessData, *http.Response, error)
- func (a *DeployApiService) TransformFile(ctx context.Context, definitionsFile *os.File, deployDescriptorFile *os.File) (string, *http.Response, error)
type DeployApiTestConnectionProfileOpts
type DeployJobtypeResponse
type DeploymentFileError
type DeploymentFileResults
type EmDefaultRequestParameters
type EmSystemParameter
type EncryptionMetadata
type ErrorData
type ErrorList
type Event
type EventParam
type ExternalProviderAuthenticationData
type ExternalUserData
type FieldMetadataProperties
type FieldValue
type FieldValues
type FolderAuth
type FolderProperties
type FolderPropertiesData
type FoldersUsersSettingsAndMetadataProperties
type FoldersUsersSettingsAndMetadataPropertiesFromB2B
type FtsAuthenticationDetails
type FtsFtpSettings
type FtsGeneralSettings
type FtsLdapAuthenticationDetails
type FtsPamAuthenticationDetails
type FtsSettingsData
type FtsSftpSettings
type FtsUserHomeDirectoryData
type GatewayData
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type GetAlertInfo
type GetManifestParams
type GroupsAllowedFoldersProperties
type HostGroupData
type HostProperties
type HostgroupAgentParticipation
type HostgroupProperties
type HostnamePortPair
type HubData
type HubStatus
type Job
type JobLevelAuth
type JobRunStatus
type JobStatusResult
type JobtypeAgent
type KeyValue
type KeyValueType
type KnownHosts
type Log
type LogDataArguments
type LogJobParameters
type LogJobResultItem
type LogJobResults
type LogParams
type LoginCredentials
type LoginResult
type ManifestGroupItemObject
type ManifestGroupObject
type MftConfigurationData
type MonitoringPrivilegeCategory
type NewSample
type Node
type OrderFolderParameters
type Output
type OutputParams
type PasswordsObject
type Performance
type PgpTemplateData
type PingAgentParams
type PlanningPrivilegeCategory
type PluginData
type PluginMngAuth
type PoolVariablesErrorInfo
type PoolVariablesName
type PoolVariablesNameValue
type PossibleValueProperties
type PrivilegeName
type PrivilegeNameControlm
type Privileges
type ProductDescription
type ProductSections
type ProvisionAdvanceParameters
type ProvisionApiGetAllUpgradeActivitiesStatusOpts
type ProvisionApiGetEligibleAgentsForUpgradeOpts
type ProvisionApiGetImagesOpts
type ProvisionApiService
- func (a *ProvisionApiService) CancelUpgradeActivity(ctx context.Context, upgradeId string) (SuccessData, *http.Response, error)
- func (a *ProvisionApiService) DeleteUpgradeActivity(ctx context.Context, upgradeId string) (SuccessData, *http.Response, error)
- func (a *ProvisionApiService) GetAllUpgradeActivitiesStatus(ctx context.Context, ...) (UpgradeRecordList, *http.Response, error)
- func (a *ProvisionApiService) GetDeployVersions(ctx context.Context) ([]UpgradeInfo, *http.Response, error)
- func (a *ProvisionApiService) GetEligibleAgentsForUpgrade(ctx context.Context, ...) ([]UpgradeAgentInfo, *http.Response, error)
- func (a *ProvisionApiService) GetImages(ctx context.Context, os string, localVarOptionals *ProvisionApiGetImagesOpts) ([]string, *http.Response, error)
- func (a *ProvisionApiService) GetUpgradeActivityLog(ctx context.Context, upgradeId string) (string, *http.Response, error)
- func (a *ProvisionApiService) GetUpgradeActivityStatusPerUpgradeId(ctx context.Context, upgradeId string) (UpgradeRecord, *http.Response, error)
- func (a *ProvisionApiService) RetryUpgradeActivity(ctx context.Context, upgradeId string) (SuccessData, *http.Response, error)
- func (a *ProvisionApiService) TransferAndInstallProduct(ctx context.Context, body UpgradeRequest) (UpgradeResponse, *http.Response, error)
- func (a *ProvisionApiService) UninstallProduct(ctx context.Context, body UpgradeRequest) (UpgradeResponse, *http.Response, error)
type RawCmsXmlRequest
type ReadOnlyStatus
type ReportDateTimeSettings
type ReportFilter
type ReportResult
type ReportingApiGetReportByNameOpts
type ReportingApiService
- func (a *ReportingApiService) GetReportByName(ctx context.Context, name string, ...) (ReportResult, *http.Response, error)
- func (a *ReportingApiService) GetReportFilters(ctx context.Context, name string) (RunReport, *http.Response, error)
- func (a *ReportingApiService) GetReportStatus(ctx context.Context, reportId string) (RunReportInfo, *http.Response, error)
- func (a *ReportingApiService) RunReport(ctx context.Context, body RunReport) (RunReportInfo, *http.Response, error)
type RequestParametersWrapperEmDefaultRequestParametersLogJobParameters
type RequestParametersWrapperEmDefaultRequestParametersWhyJobParameter
type RerunParameters
type RerunZosParameters
type ResourceMax
type ResourceObj
type ResourceParam
type RestartStep
type ResultsStatus
type RoleData
type RoleDataFull
type RoleHeader
type RuleCriteria
type RuleProjection
type RuleStatistics
type RulesStatisticList
type RulesStatisticListSummary
type RunApiActivateWorkloadPolicyOpts
type RunApiDeactivateWorkloadPolicyOpts
type RunApiGetEventsOpts
type RunApiGetJobOutputOpts
type RunApiGetJobsStatusByFilterOpts
type RunApiGetJobsStatusOpts
type RunApiGetResourcesOpts
type RunApiGetWorkloadPoliciesOpts
type RunApiOrderJobsInFolderOpts
type RunApiRerunJobOpts
type RunApiService
- func (a *RunApiService) ActivateWorkloadPolicy(ctx context.Context, policy string, ...) (WorkloadPolicyStateList, *http.Response, error)
- func (a *RunApiService) AddEvent(ctx context.Context, body EventParam, server string) (SuccessData, *http.Response, error)
- func (a *RunApiService) AddResource(ctx context.Context, body ResourceParam, server string) (SuccessData, *http.Response, error)
- func (a *RunApiService) ConfirmJob(ctx context.Context, jobId string) (SuccessData, *http.Response, error)
- func (a *RunApiService) DeactivateWorkloadPolicy(ctx context.Context, policy string, ...) (WorkloadPolicyStateList, *http.Response, error)
- func (a *RunApiService) DeleteEvent(ctx context.Context, server string, name string, date string) (SuccessData, *http.Response, error)
- func (a *RunApiService) DeleteJob(ctx context.Context, jobId string) (SuccessData, *http.Response, error)
- func (a *RunApiService) DeleteResource(ctx context.Context, server string, name string) (SuccessData, *http.Response, error)
- func (a *RunApiService) FreeJob(ctx context.Context, jobId string) (SuccessData, *http.Response, error)
- func (a *RunApiService) GetActiveJob(ctx context.Context, jobId string) (string, *http.Response, error)
- func (a *RunApiService) GetActiveServices(ctx context.Context) (ActiveServices, *http.Response, error)
- func (a *RunApiService) GetEvents(ctx context.Context, localVarOptionals *RunApiGetEventsOpts) ([]Event, *http.Response, error)
- func (a *RunApiService) GetJobLog(ctx context.Context, jobId string) (string, *http.Response, error)
- func (a *RunApiService) GetJobOutput(ctx context.Context, jobId string, localVarOptionals *RunApiGetJobOutputOpts) (string, *http.Response, error)
- func (a *RunApiService) GetJobStatistics(ctx context.Context, jobId string) (Statistics, *http.Response, error)
- func (a *RunApiService) GetJobStatus(ctx context.Context, jobId string) (JobRunStatus, *http.Response, error)
- func (a *RunApiService) GetJobsStatus(ctx context.Context, runId string, localVarOptionals *RunApiGetJobsStatusOpts) (JobStatusResult, *http.Response, error)
- func (a *RunApiService) GetJobsStatusByFilter(ctx context.Context, localVarOptionals *RunApiGetJobsStatusByFilterOpts) (JobStatusResult, *http.Response, error)
- func (a *RunApiService) GetResources(ctx context.Context, localVarOptionals *RunApiGetResourcesOpts) ([]ResourceObj, *http.Response, error)
- func (a *RunApiService) GetWaitingInfo(ctx context.Context, jobId string) ([]string, *http.Response, error)
- func (a *RunApiService) GetWorkloadPolicies(ctx context.Context, localVarOptionals *RunApiGetWorkloadPoliciesOpts) (WorkloadPolicyList, *http.Response, error)
- func (a *RunApiService) HoldJob(ctx context.Context, jobId string) (SuccessData, *http.Response, error)
- func (a *RunApiService) KillJob(ctx context.Context, jobId string) (SuccessData, *http.Response, error)
- func (a *RunApiService) ModifyJob(ctx context.Context, jobDefinitionsFile *os.File, jobId string) (SuccessData, *http.Response, error)
- func (a *RunApiService) OrderJobsInFolder(ctx context.Context, localVarOptionals *RunApiOrderJobsInFolderOpts) (RunResult, *http.Response, error)
- func (a *RunApiService) RerunJob(ctx context.Context, jobId string, localVarOptionals *RunApiRerunJobOpts) (JobRunStatus, *http.Response, error)
- func (a *RunApiService) RunJobs(ctx context.Context, jobDefinitionsFile *os.File, ...) (RunResult, *http.Response, error)
- func (a *RunApiService) RunNow(ctx context.Context, jobId string) (SuccessData, *http.Response, error)
- func (a *RunApiService) SetToOK(ctx context.Context, jobId string) (SuccessData, *http.Response, error)
- func (a *RunApiService) UndeleteJob(ctx context.Context, jobId string) (SuccessData, *http.Response, error)
- func (a *RunApiService) UpdateAlert(ctx context.Context, body AlertParam) (SuccessData, *http.Response, error)
- func (a *RunApiService) UpdateAlertStatus(ctx context.Context, body AlertStatusParam) (SuccessData, *http.Response, error)
- func (a *RunApiService) UpdateResource(ctx context.Context, body ResourceMax, server string, name string) (SuccessData, *http.Response, error)
type RunAsUserData
type RunAsUserDetailsData
type RunAsUserKeyData
type RunReport
type RunReportInfo
type RunResult
type RunasDefinitionAuth
type RunasUserAuth
type Saml2IdentityProvider
type SamlStatus
type Sample
type SearchParams
type SearchTagTuple
type SecretKeyValue
type SecretValue
type SectionMetadataProperties
type ServiceAuth
type ServiceAuthAction
type ServiceProviderInformation
type SessionApiService
- func (a *SessionApiService) DoLogin(ctx context.Context, body LoginCredentials) (LoginResult, *http.Response, error)
- func (a *SessionApiService) DoLogout(ctx context.Context) (SuccessData, *http.Response, error)
- func (a *SessionApiService) UpdateMyPassword(ctx context.Context, body PasswordsObject) (SuccessData, *http.Response, error)
type SetAgentParams
type SetAgentParamsList
type SettingKeyProperties
type SettingProperties
type SettingPropertiesObject
type SettingsMetadataProperties
type SettingsUpdateObject
type SlaService
type SlaServiceStatusByJobs
type SshKeyProperties
type Statistics
type StatisticsAverageInfo
type StatisticsPeriod
type StatisticsRunInfo
type StatisticsSingleRun
type SuccessData
type Summary
type SystemParameter
type SystemSetting
type SystemSettingKeyValue
type SystemSettingProperty
type TokenDataRequest
type TokenDataResponse
type TokenList
type ToolsPrivilegeCategory
type Topology
type UpgradeAgentInfo
type UpgradeInfo
type UpgradeNotification
type UpgradeRecord
type UpgradeRecordList
type UpgradeRequest
type UpgradeResponse
type UserAdditionalProperties
type UserAllowedFoldersProperties
type UserData
type UserGroupDetailsData
type UserGroupPropertiesData
type UserHeader
type UserPassword
type UserPreferences
type ValidationProperties
type Value
type VariableNameValue
type VariableNames
type Variables
type ViewpointManagerPrivilegeCategory
type WarningData
type WarningList
type WarningsCollection
type WhyJobParameters
type WhyJobResultItem
type WhyJobResults
type WorkflowInsightsStatus
type WorkloadPolicy
type WorkloadPolicyList
type WorkloadPolicyState
type WorkloadPolicyStateList
type WorkspaceFolder
type WorkspaceFolders
type ZooKeeper
type ZosTemplateData

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types ¶

type APIClient ¶

type APIClient struct {
	ArchiveApi *ArchiveApiService

	BuildApi *BuildApiService

	ConfigApi *ConfigApiService

	DeployApi *DeployApiService

	ProvisionApi *ProvisionApiService

	ReportingApi *ReportingApiService

	RunApi *RunApiService

	SessionApi *SessionApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Control-M Services API v9.20.115 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey ¶

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse ¶

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶

func NewAPIResponseWithError(errorMessage string) *APIResponse

type ActionsAuthRecord ¶

type ActionsAuthRecord struct {
	// component in which the action sent - Possible Values - EM, CTM_Server, CTM_Agent, CTM_CM
	Destination string `json:"destination,omitempty"`
	// action name unique list of actions' names as appear in the actions_auth em db table, along with the destination makes a unique action auth entry
	Action string `json:"action,omitempty"`
	// Privilege (Can be empty) Possible Values for categories fields  - OPER, DATABASE, CONFIG, CTMSEC, CPMAN, RAMAN, AGMAN, CMMAN, CCP, UNKNOWN
	Category string `json:"category,omitempty"`
	// required minimum authorization level - BROWSE, UPDATE, FULL
	AuthLevel string `json:"authLevel,omitempty"`
	// R - request always pass, authorization is done on the response; C - Connection Profile name will remain empty and will be ignored; E - Not related to authorization
	ActionType string `json:"actionType,omitempty"`
	// currently not in use regarding authorization
	AdditionalInfo string `json:"additionalInfo,omitempty"`
	Category2      string `json:"category2,omitempty"`
	// relation between Category and category2 - 1. Only category, 2. Only Category2, 3. Category AND Category2, 4. Category OR Category2
	Policy string `json:"policy,omitempty"`
	// In case that not all information for authorization exist in the header request, it contain path in the body for the missing field\\fields.
	AuthAttr string `json:"authAttr,omitempty"`
}

type ActiveServices ¶

type ActiveServices struct {
	ServiceLastUpdatedTime string       `json:"serviceLastUpdatedTime,omitempty"`
	ActiveServices         []SlaService `json:"activeServices,omitempty"`
}

type AddAgentParams ¶

type AddAgentParams struct {
	// The hostname or alias of the agent machine.
	Host string `json:"host"`
	// The agent's listening port.
	Port int32 `json:"port"`
	// The agent's tag.
	Tag string `json:"tag,omitempty"`
	// The agent's ssl State. HIDDEN.
	SslState string `json:"sslState,omitempty"`
	// Is the connection persistent or create each time it is needed. HIDDEN.
	PersistentConnection bool `json:"persistentConnection,omitempty"`
	// maximum time in seconds to wait (default 60). HIDDEN
	Timeout int32 `json:"timeout,omitempty"`
	// Suppress ping action to added agent (default false). HIDDEN.
	SuppressPing bool `json:"suppressPing,omitempty"`
}

type AddRemoteHostParams ¶

type AddRemoteHostParams struct {
	// The remote host (name) which will execute the commands. REQUIRED.
	Remotehost string `json:"remotehost,omitempty"`
	// The remote host SSH port.
	Port int32 `json:"port,omitempty"`
	// The SSH encrypt algorithm to be used. HIDDEN.
	EncryptAlgorithm string `json:"encryptAlgorithm,omitempty"`
	// Is compression used. HIDDEN.
	Compression bool `json:"compression,omitempty"`
	// authorize SSL remote host while creating the remote host. HIDDEN.
	Authorize bool `json:"authorize,omitempty"`
	// Agents to execute the commands on. HIDDEN.
	Agents []string `json:"agents,omitempty"`
}

type AddRemoveSuccessData ¶

type AddRemoveSuccessData struct {
	// The success message that describes the performed action.
	Message string `json:"message,omitempty"`
	// List of the items remained after the action.
	CurrentItems []string `json:"currentItems,omitempty"`
}

type AddServerParams ¶

type AddServerParams struct {
	// The Control-M Server host name.
	Host string `json:"host"`
	// The Control-M Server name.
	Ctm string `json:"ctm"`
	// The id of the Control-M Server, 3 digits id
	Id string `json:"id"`
	// The Control-M Server port number.
	Port int32 `json:"port,omitempty"`
}

type AgentCertificateExpirationData ¶

type AgentCertificateExpirationData struct {
	// The Certificate expiration date
	ExpirationDate string `json:"expirationDate,omitempty"`
}

type AgentData ¶

type AgentData struct {
	// The Agent name
	Name string `json:"name,omitempty"`
	// The Agent host
	Host string `json:"host,omitempty"`
	// The Agent nodeID
	NodeID string `json:"nodeID,omitempty"`
	// The Control-M name
	Ctm string `json:"ctm,omitempty"`
	// The Control-M Host
	CtmHost string `json:"ctmHost,omitempty"`
	// The Agent current state
	CurrentState string `json:"currentState,omitempty"`
	// The Agent status
	Status string `json:"status,omitempty"`
	// The Agent status message
	StatusMessage string `json:"statusMessage,omitempty"`
	// The Agent operating System
	OperatingSystem string `json:"operatingSystem,omitempty"`
	// The Agent platform
	Platform string `json:"platform,omitempty"`
	// The Agent version
	Version string `json:"version,omitempty"`
	// The Agent last update
	LastUpdate string `json:"lastUpdate,omitempty"`
	// The Agent communication version
	CommunicationVersion string `json:"communicationVersion,omitempty"`
	// The Agent tag
	Tag string `json:"tag,omitempty"`
	// The Agent ssl state
	SslState string `json:"sslState,omitempty"`
	// The Agent host groups
	HostGroups string       `json:"hostGroups,omitempty"`
	Plugins    []PluginData `json:"plugins,omitempty"`
}

type AgentDetails ¶

type AgentDetails struct {
	// agent machine
	Nodeid string `json:"nodeid,omitempty"`
	// agent status
	Status string `json:"status,omitempty"`
	// list of hostgroups names containing the agent
	Hostgroups []string `json:"hostgroups,omitempty"`
	// agent version string i.e. - 9.0.20.080
	Version string `json:"version,omitempty"`
	// agent operating system long name i.e - Microsoft Windows Server 2016  (Build 14393)
	OperatingSystem string `json:"operatingSystem,omitempty"`
}

type AgentDetailsList ¶

type AgentDetailsList struct {
	Agents []AgentDetails `json:"agents,omitempty"`
}

type AgentInGroupParams ¶

type AgentInGroupParams struct {
	// The hostname of the agent.
	Host                        string                       `json:"host"`
	HostgroupAgentParticipation *HostgroupAgentParticipation `json:"hostgroupAgentParticipation,omitempty"`
}

type AgentInGroupParamsList ¶

type AgentInGroupParamsList struct {
	Agentslist []AgentInGroupParams `json:"agentslist,omitempty"`
}

type AgentInHostgroup ¶

type AgentInHostgroup struct {
	// The hostname of the agent.
	Host string `json:"host"`
	// Host Group tag. HIDDEN.
	Tag                         string                       `json:"tag,omitempty"`
	HostgroupAgentParticipation *HostgroupAgentParticipation `json:"hostgroupAgentParticipation,omitempty"`
}

type AgentMngAuth ¶

type AgentMngAuth struct {
	// control-M server name
	ControlmServer string `json:"ControlmServer,omitempty"`
	// agent name
	Agent string `json:"Agent,omitempty"`
	// access level (full, update, browse)
	Privilege string `json:"Privilege,omitempty"`
}

type AgentThingProperties ¶

type AgentThingProperties struct {
	// the logical name to be used for new agent (equivilant to NodeId)
	Name string `json:"name,omitempty"`
	// the physical name of the thing the agent is installed on
	PhysicalName string `json:"physicalName,omitempty"`
	// the agent tag to be associated with the new agent (CMS RBA permissions tag that is)
	Tag string `json:"tag,omitempty"`
}

the properties of the new Control-M Agent installed thing to be connected to SaaS Control-M

type AgentsInGroupSuccessData ¶

type AgentsInGroupSuccessData struct {
	// The success message that describes the performed action.
	Message string `json:"message,omitempty"`
	// List of the items remained after the action.
	Agents []AgentInGroupParams `json:"agents,omitempty"`
}

type AiDeployResponse ¶

type AiDeployResponse struct {
	// response message
	Message string `json:"message,omitempty"`
}

Response of deploy and pre-deploy AI jobtype

type AiError ¶

type AiError struct {
	// Error message
	Message string `json:"message,omitempty"`
	// Http status code
	Status int32 `json:"status,omitempty"`
}

AI standard error object

type AiJobtype ¶

type AiJobtype struct {
	// Jobtype display name
	JobTypeName string `json:"jobTypeName,omitempty"`
	// Jobtype internal appname
	JobTypeId string `json:"jobTypeId,omitempty"`
	// Jobtype status ['ready to deploy', 'draft']
	Status string `json:"status,omitempty"`
	// Jobtype description
	Description string `json:"description,omitempty"`
}

Application integrator jobtype

type AiJobtypeList ¶

type AiJobtypeList struct {
	Jobtypes []AiJobtype `json:"jobtypes,omitempty"`
}

List of application integrator jobtypes

type AlertParam ¶

type AlertParam struct {
	// alertIds. HIDDEN.
	AlertIds []int32 `json:"alertIds"`
	// modify urgency. HIDDEN.
	Urgency string `json:"urgency,omitempty"`
	// modify comment. HIDDEN.
	Comment string `json:"comment,omitempty"`
}

type AlertStatusParam ¶

type AlertStatusParam struct {
	// alertIds. HIDDEN.
	AlertIds []int32 `json:"alertIds"`
	// modify status. HIDDEN.
	Status string `json:"status,omitempty"`
}

type AllowedJobActions ¶

type AllowedJobActions struct {
	// True if Properties action is allowed
	ViewProperties bool `json:"ViewProperties,omitempty"`
	// True if Documentation action is allowed
	Documentation bool `json:"Documentation,omitempty"`
	// True if Log action is allowed
	Log bool `json:"Log,omitempty"`
	// True if Statistics action is allowed
	Statistics bool `json:"Statistics,omitempty"`
	// True if ViewOutputList action is allowed
	ViewOutputList bool `json:"ViewOutputList,omitempty"`
	// True if ViewJcl action is allowed
	ViewJcl bool `json:"ViewJcl,omitempty"`
	// True if Why action is allowed
	Why bool `json:"Why,omitempty"`
	// True if Hold action is allowed
	Hold bool `json:"Hold,omitempty"`
	// True if Free action is allowed
	Free bool `json:"Free,omitempty"`
	// True if Confirm action is allowed
	Confirm bool `json:"Confirm,omitempty"`
	// True if Rerun action is allowed
	Rerun bool `json:"Rerun,omitempty"`
	// True if React action is allowed
	React bool `json:"React,omitempty"`
	// True if Restart action is allowed
	Restart bool `json:"Restart,omitempty"`
	// True if Kill action is allowed
	Kill bool `json:"Kill,omitempty"`
	// True if Bypass action is allowed
	Bypass bool `json:"Bypass,omitempty"`
	// True if Delete action is allowed
	Delete bool `json:"Delete,omitempty"`
	// True if Undelete action is allowed
	Undelete bool `json:"Undelete,omitempty"`
	// True if SetToOk action is allowed
	SetToOk bool `json:"SetToOk,omitempty"`
	// True if EditProperties action is allowed
	EditProperties bool `json:"EditProperties,omitempty"`
	// True if EditJcl action is allowed
	EditJcl bool `json:"EditJcl,omitempty"`
}

type AllowedJobs ¶

type AllowedJobs struct {
	// list of including term Groups, combined by OR
	Included [][][]string `json:"Included,omitempty"`
	// list of excluding term Groups, combined by OR
	Excluded [][][]string `json:"Excluded,omitempty"`
}

type ApiGtwSession ¶

type ApiGtwSession struct {
	SessionId string `json:"session_id,omitempty"`
}

type ApiThrowable ¶

type ApiThrowable struct {
	LocalizedMessage string `json:"localized_message,omitempty"`
	Message          string `json:"message,omitempty"`
}

type App ¶

type App struct {
	// job type display name
	Displayname string `json:"displayname,omitempty"`
	// job type name
	Name string `json:"name,omitempty"`
	// description
	Desc string `json:"desc,omitempty"`
	// default type
	DefaultType string `json:"defaultType,omitempty"`
	// last modification date
	LastModified string `json:"lastModified,omitempty"`
	// creation date
	CreatedOn string `json:"createdOn,omitempty"`
	// creation author
	CreatedBy string `json:"createdBy,omitempty"`
}

App (job type) object for AI deploy api

type AppDeployResponse ¶

type AppDeployResponse struct {
	// status
	Status string `json:"status,omitempty"`
	// message
	Message string `json:"message,omitempty"`
	// agent name
	AgentName string `json:"agentName,omitempty"`
}

Deployed App (job type) object response for AI deploy api

type AppDeployed ¶

type AppDeployed struct {
	// job type display name
	Displayname string `json:"displayname,omitempty"`
	// job type name
	Name string `json:"name,omitempty"`
	// version
	Version string `json:"version,omitempty"`
	// default type
	DefaultType string `json:"defaultType,omitempty"`
	// last deployment date
	LastDeployed string `json:"lastDeployed,omitempty"`
	// creation date
	CreatedOn string `json:"createdOn,omitempty"`
	// creation author
	CreatedBy string `json:"createdBy,omitempty"`
}

Deployed app (job type) object for AI deploy api

type AppList ¶

type AppList struct {
	AppNames      []App         `json:"appNames,omitempty"`
	DeployedNames []AppDeployed `json:"deployedNames,omitempty"`
}

App list object for AI deploy api

type AppPredeployResponse ¶

type AppPredeployResponse struct {
	// app name
	AppName string `json:"appName,omitempty"`
	// ready status
	ReadyStatus string `json:"readyStatus,omitempty"`
}

Pre-deployed App (job type) object response for AI deploy api

type ArchiveApiSearchJobsOpts ¶

type ArchiveApiSearchJobsOpts struct {
	Limit          optional.Int32
	Jobname        optional.String
	Jobid          optional.String
	Ctm            optional.String
	Server         optional.String
	Folder         optional.String
	FromTime       optional.String
	ToTime         optional.String
	LogContains    optional.String
	OutputContains optional.String
	Application    optional.String
	SubApplication optional.String
	Library        optional.String
	MemName        optional.String
	MemLibrary     optional.String
	Host           optional.String
	HostGroup      optional.String
	RunAs          optional.String
	OrderId        optional.String
	Status         optional.String
	OrderDateFrom  optional.String
	OrderDateTo    optional.String
	NumberOfRuns   optional.Int64
}

type ArchiveApiService ¶

type ArchiveApiService service

func (*ArchiveApiService) GetArchiveJobLog ¶

func (a *ArchiveApiService) GetArchiveJobLog(ctx context.Context, jobId string, runNo int64) (string, *http.Response, error)

ArchiveApiService Get job log Get job log by unique job key

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param jobId The job ID
@param runNo The execution number in case of multiple executions

@return string

func (*ArchiveApiService) GetArchiveJobOutput ¶

func (a *ArchiveApiService) GetArchiveJobOutput(ctx context.Context, jobId string, runNo int64) (string, *http.Response, error)

ArchiveApiService Get job output Get job output by unique job key

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param jobId The job ID
@param runNo The execution number in case of multiple executions

@return string

func (*ArchiveApiService) SearchJobs ¶

func (a *ArchiveApiService) SearchJobs(ctx context.Context, localVarOptionals *ArchiveApiSearchJobsOpts) (ArchiveJobsList, *http.Response, error)

type ArchiveJobsList ¶

type ArchiveJobsList struct {
	Jobs                              []Job `json:"jobs,omitempty"`
	Returned                          int32 `json:"returned,omitempty"`
	AdditionalJobsMatchSearchCriteria bool  `json:"additionalJobsMatchSearchCriteria,omitempty"`
}

type ArchiveRule ¶

type ArchiveRule struct {
	// The Control-M Workload Archiving rule name. REQUIRED. HIDDEN.
	Name string `json:"name,omitempty"`
	// The description of Control-M Workload Archiving rule. HIDDEN.
	Description string `json:"description,omitempty"`
	// The maximum job's output size to collect. HIDDEN.
	MaxOutputSize string `json:"maxOutputSize,omitempty"`
	// The maximum job's output size type to collect - KB or MB. The default is MB. HIDDEN.
	MaxOutputSizeType string `json:"maxOutputSizeType,omitempty"`
	// Trim in case the output exceed the maximum job's output - Omit , Beginning, End. The default is to Omit. HIDDEN.
	TrimType string `json:"trimType,omitempty"`
	// The retention period to keep archive job by rule. The default is 1. HIDDEN.
	Retention string `json:"retention,omitempty"`
	// The retention period type to keep archive job by rule- Years, Months and Days are available. The default is Years. HIDDEN.
	RetentionType string `json:"retentionType,omitempty"`
	// Is Control-M Workload Archiving rule is active. HIDDEN.
	IsActive string `json:"isActive,omitempty"`
	// The rule archived data - logs, output or both. The default is both. HIDDEN.
	ArchivedType string `json:"archivedType,omitempty"`
	// Rule parameters - ctm, type, jobName, jobType, application, subApplication, jobStatus, folder and library. HIDDEN.
	RuleParameters []RuleCriteria `json:"ruleParameters,omitempty"`
}

type ArchiveRulesList ¶

type ArchiveRulesList struct {
	Rules []ArchiveRule `json:"rules,omitempty"`
}

type As2KeyData ¶

type As2KeyData struct {
	// as2 id HIDDEN
	As2Id string `json:"as2Id,omitempty"`
	// partners certificate alias HIDDEN
	Certificate string `json:"certificate,omitempty"`
	// AS2 destination folder HIDDEN
	DestinationFolder string `json:"destinationFolder,omitempty"`
}

type AssociateData ¶

type AssociateData struct {
	// associate typed REQUIRED
	Type_ string `json:"type,omitempty"`
	// associate name REQUIRED
	Name string `json:"name,omitempty"`
}

type AuthenticateCredentials ¶

type AuthenticateCredentials struct {
	Username             string                                        `json:"username,omitempty"`
	Msg                  string                                        `json:"msg,omitempty"`
	Sessiontoken         string                                        `json:"sessiontoken,omitempty"`
	Groups               []string                                      `json:"groups,omitempty"`
	AdditionalAttributes []AuthenticateCredentialsAdditionalAttributes `json:"additionalAttributes,omitempty"`
}

type AuthenticateCredentialsAdditionalAttributes ¶

type AuthenticateCredentialsAdditionalAttributes struct {
	Attrname  string `json:"attrname,omitempty"`
	Attrvalue string `json:"attrvalue,omitempty"`
}

type AuthenticationData ¶

type AuthenticationData struct {
	ControlM         *ControlMAuthenticationData         `json:"ControlM,omitempty"`
	ExternalProvider *ExternalProviderAuthenticationData `json:"ExternalProvider,omitempty"`
}

type Availability ¶

type Availability struct {
	// the type of the availability stat
	Type_ string `json:"Type,omitempty"`
	// the name of the stat
	Name string `json:"Name,omitempty"`
	// the current status
	Status string `json:"Status,omitempty"`
	// A message representing the problem
	Message string `json:"Message,omitempty"`
}

type BasicAuth ¶

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Body ¶

type Body struct {
	// A file that contains definitions to be deployed to the server. Can be either a JSON definition file, an XML definition file, or a zip file that contains multiple JSON or XML definition files.
	DefinitionsFile **os.File `json:"definitionsFile"`
	// Deploy Descriptor JSON file.
	DeployDescriptorFile **os.File `json:"deployDescriptorFile,omitempty"`
	// additionalConfiguration to enable skip testing for local connection profile
	AdditionalConfiguration **os.File `json:"additionalConfiguration,omitempty"`
}

type Body1 ¶

type Body1 struct {
	// A file that contains definitions of the connection profile to be tested
	DefinitionsFile **os.File `json:"definitionsFile"`
}

type Body10 ¶

type Body10 struct {
	// File with contenet of user data.
	UserFile **os.File `json:"userFile"`
}

type Body11 ¶

type Body11 struct {
	// The CRT file path.
	CrtFile **os.File `json:"crtFile"`
	// The CA Chain file path.
	CaChainFile **os.File `json:"caChainFile"`
}

type Body2 ¶

type Body2 struct {
	// A file that contains definitions to be compiled. Can be either a JSON definition file, or a zip file that contains multiple JSON definition files.
	DefinitionsFile **os.File `json:"definitionsFile"`
	// Deploy Descriptor JSON file.
	DeployDescriptorFile **os.File `json:"deployDescriptorFile,omitempty"`
}

type Body3 ¶

type Body3 struct {
	// A .ctmai file that contains definitions of jobtype to be deployed to the server.
	DefinitionsFile **os.File `json:"definitionsFile"`
	// A JSON file that contains specifications of an agent.
	PayloadFile **os.File `json:"payloadFile,omitempty"`
}

type Body4 ¶

type Body4 struct {
	// A file that contains definitions to be deployed to the server. Can be either a JSON definition file, an XML definition file, or a zip file that contains multiple JSON or XML definition files.
	DefinitionsFile **os.File `json:"definitionsFile"`
	// Deploy Descriptor JSON file.
	DeployDescriptorFile **os.File `json:"deployDescriptorFile"`
}

type Body5 ¶

type Body5 struct {
	// File that contains the definitions of the jobs to run. It can be a JSON file, or a zip file that can contain one or more JSON files, as well as account(s) information.
	JobDefinitionsFile **os.File `json:"jobDefinitionsFile"`
	// Deploy Descriptor JSON file.
	DeployDescriptorFile **os.File `json:"deployDescriptorFile,omitempty"`
	// additionalConfiguration to enable skip testing for local connection profile
	AdditionalConfiguration **os.File `json:"additionalConfiguration,omitempty"`
}

type Body6 ¶

type Body6 struct {
	// File that contains the definitions of the job to modify. It should be a JSON file.
	JobDefinitionsFile **os.File `json:"jobDefinitionsFile"`
}

type Body7 ¶

type Body7 struct {
	// File with contenet of Role Data.
	RoleFile **os.File `json:"roleFile"`
}

type Body8 ¶

type Body8 struct {
	// File with contenet of Role Data.
	RoleFile **os.File `json:"roleFile"`
}

type Body9 ¶

type Body9 struct {
	// File with contenet of user data.
	UserFile **os.File `json:"userFile"`
}

type BuildApiService ¶

type BuildApiService service

func (*BuildApiService) BuildFile ¶

func (a *BuildApiService) BuildFile(ctx context.Context, definitionsFile *os.File, deployDescriptorFile *os.File) ([]DeploymentFileResults, *http.Response, error)

BuildApiService Compile definitions file to check its validity Compile the provided definition file (JSON or zip) to verify it is valid for Control-M.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param definitionsFile
@param deployDescriptorFile

@return []DeploymentFileResults

type CertificateSigningRequestData ¶

type CertificateSigningRequestData struct {
	// The organization HIDDEN
	Organization string `json:"organization,omitempty"`
	// The organizationUnit HIDDEN
	OrganizationUnit string `json:"organizationUnit,omitempty"`
	// The cityLocality HIDDEN
	CityLocality string `json:"cityLocality,omitempty"`
	// The stateProvince HIDDEN
	StateProvince string `json:"stateProvince,omitempty"`
	// The country HIDDEN
	Country string `json:"country,omitempty"`
	// The emailAddress HIDDEN
	EmailAddress string `json:"emailAddress,omitempty"`
}

type ClientAccessPrivilegeCategory ¶

type ClientAccessPrivilegeCategory struct {
	// Control-M Self Service access level (None, Full)
	SelfServiceAccess string `json:"SelfServiceAccess,omitempty"`
	// Control-M Workload Change Manager access level (None, Full)
	WorkloadChangeManagerAccess string `json:"WorkloadChangeManagerAccess,omitempty"`
	// Control-M, Utilitiesm EM API, BIM Web, UI access level (None, Full)
	UtilitiesAccess string `json:"UtilitiesAccess,omitempty"`
	// Control-M Application Integrator access level (None, Full)
	ApplicationIntegratorAccess string `json:"ApplicationIntegratorAccess,omitempty"`
	// Control-M Automation API access level (None, Full)
	AutomationAPIAccess string `json:"AutomationAPIAccess,omitempty"`
	// Control-M Workflow Insights access level (None, Full)
	WorkflowInsightsAccess string `json:"WorkflowInsightsAccess,omitempty"`
}

type Cluster ¶

type Cluster struct {
	Nodes        []Node         `json:"Nodes,omitempty"`
	Availability []Availability `json:"Availability,omitempty"`
	Performance  []Performance  `json:"Performance,omitempty"`
}

type ClusterAuthorizationData ¶

type ClusterAuthorizationData struct {
	// hostnames and ports list HIDDEN
	HostList []HostnamePortPair `json:"hostList,omitempty"`
}

type CommunicationAnalysisResponseType ¶

type CommunicationAnalysisResponseType struct {
	BasicInfo *CtmagentBasicInfoType `json:"basicInfo,omitempty"`
	// The list of 4 tests executed and their output
	CtmagentCtmTestsType []CtmagentCtmTestType `json:"ctmagentCtmTestsType,omitempty"`
	// The list of 10 latest Agent's state changed to Unavailable and timestamp
	CtmagentStatesChangedType []CtmagentStateChangedType `json:"ctmagentStatesChangedType,omitempty"`
}

type ComponentKeyWithStatusType ¶

type ComponentKeyWithStatusType struct {
	ComponentKey *ComponentMftKeyType `json:"componentKey,omitempty"`
	// Component status
	Status int32 `json:"status,omitempty"`
}

type ComponentMetaDataProperties ¶

type ComponentMetaDataProperties struct {
	DisplayName   string                      `json:"displayName,omitempty"`
	DisplayNameID string                      `json:"displayNameID,omitempty"`
	Name          string                      `json:"name,omitempty"`
	Sections      []SectionMetadataProperties `json:"sections,omitempty"`
}

type ComponentMftKeyType ¶

type ComponentMftKeyType struct {
	// type
	Type_ string `json:"type,omitempty"`
	// name
	Name string `json:"name,omitempty"`
	// host
	Host string `json:"host,omitempty"`
	// node id
	NodeId string `json:"nodeId,omitempty"`
	// application type
	ApplType string `json:"applType,omitempty"`
	// application version
	ApplVer string `json:"applVer,omitempty"`
	// cm version
	CmVer string `json:"cmVer,omitempty"`
}

type ConditionProperties ¶

type ConditionProperties struct {
	Key      *SettingKeyProperties `json:"key,omitempty"`
	Operator string                `json:"operator,omitempty"`
	Value    string                `json:"value,omitempty"`
}

type ConfigApiAddRemoteHostOpts ¶

type ConfigApiAddRemoteHostOpts struct {
	Body optional.Interface
}

type ConfigApiAuthorizeMftSshHostOpts ¶

type ConfigApiAuthorizeMftSshHostOpts struct {
	Port optional.String
}

type ConfigApiChangeUserPasswordOpts ¶

type ConfigApiChangeUserPasswordOpts struct {
	Body optional.Interface
}

type ConfigApiGetAgentParametersOpts ¶

type ConfigApiGetAgentParametersOpts struct {
	ExtendedData optional.Bool
}

type ConfigApiGetAgentsOpts ¶

type ConfigApiGetAgentsOpts struct {
	Agent optional.String
}

type ConfigApiGetAllAuthorizationRolesOpts ¶

type ConfigApiGetAllAuthorizationRolesOpts struct {
	Role        optional.String
	Description optional.String
}

type ConfigApiGetAllLdapGroupsOpts ¶

type ConfigApiGetAllLdapGroupsOpts struct {
	Ldap optional.String
}

type ConfigApiGetAllRolesAssociatedWithLdapOpts ¶

type ConfigApiGetAllRolesAssociatedWithLdapOpts struct {
	Role optional.String
}

type ConfigApiGetAllUsersOpts ¶

type ConfigApiGetAllUsersOpts struct {
	Name        optional.String
	FullName    optional.String
	Description optional.String
}

type ConfigApiGetExternalUsersOpts ¶

type ConfigApiGetExternalUsersOpts struct {
	Name        optional.String
	Email       optional.String
	Description optional.String
	Company     optional.String
	PhoneNumber optional.String
}

type ConfigApiGetMFTFoldersOpts ¶

type ConfigApiGetMFTFoldersOpts struct {
	Name optional.String
}

type ConfigApiGetMftUserGroupsOpts ¶

type ConfigApiGetMftUserGroupsOpts struct {
	Name          optional.String
	ExternalUsers optional.String
	LdapGroups    optional.String
}

type ConfigApiGetPgpTemplatesOpts ¶

type ConfigApiGetPgpTemplatesOpts struct {
	Name optional.String
}

type ConfigApiGetRunAsUsersListOpts ¶

type ConfigApiGetRunAsUsersListOpts struct {
	User  optional.String
	Agent optional.String
}

type ConfigApiGetZosTemplatesOpts ¶

type ConfigApiGetZosTemplatesOpts struct {
	Name optional.String
}

type ConfigApiPingAgentOpts ¶

type ConfigApiPingAgentOpts struct {
	Body optional.Interface
}

type ConfigApiSendArchiveCleanupRequestOpts ¶

type ConfigApiSendArchiveCleanupRequestOpts struct {
	Application              optional.String
	ApplicationExceptions    optional.String
	SubApplication           optional.String
	SubApplicationExceptions optional.String
	Ctm                      optional.String
	Server                   optional.String
	CtmExceptions            optional.String
	ServerExceptions         optional.String
	Folder                   optional.String
	FolderExceptions         optional.String
	Jobname                  optional.String
	JobnameExceptions        optional.String
	Library                  optional.String
	LibraryExceptions        optional.String
	RuleName                 optional.String
	JobStatus                optional.String
}

type ConfigApiService ¶

type ConfigApiService service

func (*ConfigApiService) AddArchiveRule ¶

func (a *ConfigApiService) AddArchiveRule(ctx context.Context, body ArchiveRule) (SuccessData, *http.Response, error)

ConfigApiService Add Workload Archiving rule Add a new Workload Archiving rule

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body archive rule details to add

@return SuccessData

func (*ConfigApiService) AddExternalUser ¶

func (a *ConfigApiService) AddExternalUser(ctx context.Context, body ExternalUserData) (SuccessData, *http.Response, error)

ConfigApiService Add and external user Add and external user for b2b

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body External user data

@return SuccessData

func (*ConfigApiService) AddExternalUserOrUserGroupToMFTFolder ¶

func (a *ConfigApiService) AddExternalUserOrUserGroupToMFTFolder(ctx context.Context, folderName string, userOrGroup string) (SuccessData, *http.Response, error)

ConfigApiService Add external user or user groups to virtual folder external users list. Add external user user groups to virtual folder external users list.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param folderName Name of folder
@param userOrGroup The user name or group name

@return SuccessData

func (*ConfigApiService) AddGateway ¶

func (a *ConfigApiService) AddGateway(ctx context.Context, body GatewayData) (SuccessData, *http.Response, error)

ConfigApiService add gateway. add gateway.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body gateway data

@return SuccessData

func (*ConfigApiService) AddHostToHostgroup ¶

func (a *ConfigApiService) AddHostToHostgroup(ctx context.Context, body AgentInHostgroup, server string, hostgroup string) (AgentsInGroupSuccessData, *http.Response, error)

ConfigApiService add agent to hostgroup Add an agent to hostgroup. Create the the hostgroup if it does not exist.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body The hostname of the new agent
@param server The Server the hostgroup belongs to.
@param hostgroup The hostgroup name

@return AgentsInGroupSuccessData

func (*ConfigApiService) AddHubToCluster ¶

func (a *ConfigApiService) AddHubToCluster(ctx context.Context, agentname string) (SuccessData, *http.Response, error)

ConfigApiService add hub to cluster. add hub to cluster.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param agentname Agent name

@return SuccessData

func (*ConfigApiService) AddMFTFolder ¶

func (a *ConfigApiService) AddMFTFolder(ctx context.Context, body FolderPropertiesData) (SuccessData, *http.Response, error)

ConfigApiService Add virtual folder Add virtual folder

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body virtual folder data

@return SuccessData

func (*ConfigApiService) AddMftUserGroup ¶

func (a *ConfigApiService) AddMftUserGroup(ctx context.Context, body UserGroupPropertiesData) (SuccessData, *http.Response, error)

ConfigApiService Add user group. Add user group.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body User group object properites

@return SuccessData

func (*ConfigApiService) AddPgpTemplate ¶

func (a *ConfigApiService) AddPgpTemplate(ctx context.Context, body PgpTemplateData, server string, agent string, templateName string) (SuccessData, *http.Response, error)

ConfigApiService Add PGP Template Add PGP Template

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body PGP Template Data
@param server The Server
@param agent The Agent
@param templateName The PGP Template Name

@return SuccessData

func (*ConfigApiService) AddRemoteHost ¶

func (a *ConfigApiService) AddRemoteHost(ctx context.Context, server string, localVarOptionals *ConfigApiAddRemoteHostOpts) (SuccessData, *http.Response, error)

func (*ConfigApiService) AddRole ¶

func (a *ConfigApiService) AddRole(ctx context.Context, roleFile *os.File) (SuccessData, *http.Response, error)

ConfigApiService Add Authorization Role Add Authorization Role

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param roleFile

@return SuccessData

func (*ConfigApiService) AddRoleToLdapGroup ¶

func (a *ConfigApiService) AddRoleToLdapGroup(ctx context.Context, ldapgroup string, role string) (SuccessData, *http.Response, error)

ConfigApiService Add a role to LDAP group Add a role to LDAP group so any user belong to the LDAP group will get all permissions defined in the role

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ldapgroup Name of LDAP group
@param role Name of role

@return SuccessData

func (*ConfigApiService) AddRoleToUser ¶

func (a *ConfigApiService) AddRoleToUser(ctx context.Context, user string, role string) (SuccessData, *http.Response, error)

ConfigApiService Add a role to user Add a role to user so that user will inherit role authorization

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param user Name of user
@param role Name of role

@return SuccessData

func (*ConfigApiService) AddSecret ¶

func (a *ConfigApiService) AddSecret(ctx context.Context, body SecretKeyValue) (SuccessData, *http.Response, error)

ConfigApiService Add a new secret Add a new secret to the secrets vault.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body The new secret value

@return SuccessData

func (*ConfigApiService) AddServer ¶

func (a *ConfigApiService) AddServer(ctx context.Context, body AddServerParams) (SuccessData, *http.Response, error)

ConfigApiService add server to the system Add a Server. This command setting up new server in the system

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body

@return SuccessData

func (*ConfigApiService) AddUser ¶

func (a *ConfigApiService) AddUser(ctx context.Context, userFile *os.File) (SuccessData, *http.Response, error)

ConfigApiService Add user Add user

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param userFile

@return SuccessData

func (*ConfigApiService) AddZosTemplate ¶

func (a *ConfigApiService) AddZosTemplate(ctx context.Context, body ZosTemplateData, server string, agent string, templateName string) (SuccessData, *http.Response, error)

ConfigApiService Add z/OS Template Add z/OS Template

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body z/OS Template Data
@param server The Server
@param agent The Agent
@param templateName The z/OS Template Name

@return SuccessData

func (*ConfigApiService) AuthorizeMftSshCluster ¶

func (a *ConfigApiService) AuthorizeMftSshCluster(ctx context.Context, body ClusterAuthorizationData, server string, agent string, clusterName string) (SuccessData, *http.Response, error)

ConfigApiService Authorize SSH Cluster Authorize SSH Cluster

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body File with content of hostnames and ports
@param server The Server
@param agent The Agent
@param clusterName Ssh Cluster Name

@return SuccessData

func (*ConfigApiService) AuthorizeMftSshHost ¶

func (a *ConfigApiService) AuthorizeMftSshHost(ctx context.Context, server string, agent string, hostname string, localVarOptionals *ConfigApiAuthorizeMftSshHostOpts) (SuccessData, *http.Response, error)

func (*ConfigApiService) AuthorizeSshKnownRemotehost ¶

func (a *ConfigApiService) AuthorizeSshKnownRemotehost(ctx context.Context, server string, remotehost string) (SuccessData, *http.Response, error)

ConfigApiService Authorize Authorized known ssh remote host.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param server The Server the remote host is connected to.
@param remotehost The name of the remote host.

@return SuccessData

func (*ConfigApiService) ChangeUserPassword ¶

func (a *ConfigApiService) ChangeUserPassword(ctx context.Context, user string, localVarOptionals *ConfigApiChangeUserPasswordOpts) (SuccessData, *http.Response, error)

func (*ConfigApiService) CreateAgentCertificateSigningRequest ¶

func (a *ConfigApiService) CreateAgentCertificateSigningRequest(ctx context.Context, body CertificateSigningRequestData, server string, agent string) (string, *http.Response, error)

ConfigApiService Create certificate signing request (CSR). Create certificate signing request (CSR) on SSL configured Agent.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Certificate Signing Request (CSR) data
@param server The Server.
@param agent The Agent.

@return string

func (*ConfigApiService) CreateRunAsUser ¶

func (a *ConfigApiService) CreateRunAsUser(ctx context.Context, body RunAsUserData, server string) (SuccessData, *http.Response, error)

ConfigApiService Add a new Run-as user Add a new Run-as user to server.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Run as user data
@param server The Server.

@return SuccessData

func (*ConfigApiService) DeleteAgent ¶

func (a *ConfigApiService) DeleteAgent(ctx context.Context, server string, agent string) (SuccessData, *http.Response, error)

ConfigApiService delete an agent from Server Delete an agent from a Server. This will not shut the agent down. It only disconnects and removes it from the list.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param server The Server the agent is connected to.
@param agent The name of the agent to delete.

@return SuccessData

func (*ConfigApiService) DeleteArchiveRule ¶

func (a *ConfigApiService) DeleteArchiveRule(ctx context.Context, ruleName string, deleteRuleDataFlag string) (SuccessData, *http.Response, error)

ConfigApiService Delete Workload Archiving rule Deletes Workload Archiving rule by name. It is required to send deleteRuleData flag to specify if rule need to be deleted with all the collected data or deleteRuleWithoutData otherwise.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ruleName Rule name to delete
@param deleteRuleDataFlag Remove rule with collected data or without. REQUIRED.

@return SuccessData

func (*ConfigApiService) DeleteAuthorizationRole ¶

func (a *ConfigApiService) DeleteAuthorizationRole(ctx context.Context, role string) (SuccessData, *http.Response, error)

ConfigApiService Delete Authorization Role Delete Authorization Role

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param role The Role name.

@return SuccessData

func (*ConfigApiService) DeleteExternalUser ¶

func (a *ConfigApiService) DeleteExternalUser(ctx context.Context, username string) (SuccessData, *http.Response, error)

ConfigApiService Delete an external user Delete an existing external user in MFT

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param username The name of the external user to delete

@return SuccessData

func (*ConfigApiService) DeleteExternalUserOrUserGroupFromMFTFolder ¶

func (a *ConfigApiService) DeleteExternalUserOrUserGroupFromMFTFolder(ctx context.Context, folderName string, userOrGroup string) (SuccessData, *http.Response, error)

ConfigApiService Remove an external user or user group from an existing virtual folder in MFT. Remove an external user or user group from an existing virtual folder in MFT.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param folderName Name of folder
@param userOrGroup The user name

@return SuccessData

func (*ConfigApiService) DeleteHostFromGroup ¶

func (a *ConfigApiService) DeleteHostFromGroup(ctx context.Context, server string, hostgroup string, host string) (AgentsInGroupSuccessData, *http.Response, error)

ConfigApiService delete an agent from a hostgroup Delete an agent from the specified hostgroup. If the group is empty it will also be deleted.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param server The Server the hostgroup belongs to.
@param hostgroup The hostgroup name
@param host The agent to be deleted

@return AgentsInGroupSuccessData

func (*ConfigApiService) DeleteHostGroup ¶

func (a *ConfigApiService) DeleteHostGroup(ctx context.Context, server string, hostgroup string) (SuccessData, *http.Response, error)

ConfigApiService delete host group delete host group

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param server The Server the agent is connected to.
@param hostgroup The hostgroup name

@return SuccessData

func (*ConfigApiService) DeleteMFTFolder ¶

func (a *ConfigApiService) DeleteMFTFolder(ctx context.Context, folderName string) (SuccessData, *http.Response, error)

ConfigApiService Delete a virtual folder. Delete an existing virtual folder in MFT.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param folderName Name of folder

@return SuccessData

func (*ConfigApiService) DeleteMftUserGroup ¶

func (a *ConfigApiService) DeleteMftUserGroup(ctx context.Context, name string) (SuccessData, *http.Response, error)

ConfigApiService Delete user group. Delete user group.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param name User group name

@return SuccessData

func (*ConfigApiService) DeletePgpTemplate ¶

func (a *ConfigApiService) DeletePgpTemplate(ctx context.Context, server string, agent string, templateName string) (SuccessData, *http.Response, error)

ConfigApiService Delete PGP Template Delete PGP Template

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param server The Server
@param agent The Agent
@param templateName The PGP Template Name

@return SuccessData

func (*ConfigApiService) DeleteRemoteHost ¶

func (a *ConfigApiService) DeleteRemoteHost(ctx context.Context, server string, remotehost string) (SuccessData, *http.Response, error)

ConfigApiService delete a remote host from Server Delete a remote host from a Server.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param server The Server the remote host is connected to.
@param remotehost The name of the remote host to delete.

@return SuccessData

func (*ConfigApiService) DeleteRoleFromLdapGroup ¶

func (a *ConfigApiService) DeleteRoleFromLdapGroup(ctx context.Context, ldapgroup string, role string) (SuccessData, *http.Response, error)

ConfigApiService Delete a role from LDAP group Delete a role from LDAP group

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ldapgroup Name of LDAP group
@param role Name of role

@return SuccessData

func (*ConfigApiService) DeleteRunAsUser ¶

func (a *ConfigApiService) DeleteRunAsUser(ctx context.Context, server string, agent string, user string) (SuccessData, *http.Response, error)

ConfigApiService delete Run-as user Delete Run-as user from server

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param server The Server.
@param agent The Agent
@param user The user name

@return SuccessData

func (*ConfigApiService) DeleteSecret ¶

func (a *ConfigApiService) DeleteSecret(ctx context.Context, name string) (SuccessData, *http.Response, error)

ConfigApiService Delete an existing secret Delete an existing secret from the secrets vault.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param name The name of the secret to update

@return SuccessData

func (*ConfigApiService) DeleteUser ¶

func (a *ConfigApiService) DeleteUser(ctx context.Context, user string) (SuccessData, *http.Response, error)

ConfigApiService Delete user Delete user

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param user The user name.

@return SuccessData

func (*ConfigApiService) DeleteZosTemplate ¶

func (a *ConfigApiService) DeleteZosTemplate(ctx context.Context, server string, agent string, templateName string) (SuccessData, *http.Response, error)

ConfigApiService Delete z/OS Template Delete z/OS Template

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param server The Server
@param agent The Agent
@param templateName The z/OS Template Name

@return SuccessData

func (*ConfigApiService) DeployAgentCertificate ¶

func (a *ConfigApiService) DeployAgentCertificate(ctx context.Context, crtFile *os.File, caChainFile *os.File, server string, agent string) (SuccessData, *http.Response, error)

ConfigApiService Deploy certificate (CRT). Deploy certificate (CRT) on SSL configured Agent.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param crtFile
@param caChainFile
@param server The Server.
@param agent The Agent.

@return SuccessData

func (*ConfigApiService) DisableAgent ¶

func (a *ConfigApiService) DisableAgent(ctx context.Context, server string, agent string) (SuccessData, *http.Response, error)

ConfigApiService disable agent from the Server Disable an Agent.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param server The Server the agent is connected too.
@param agent The Agent to be disabled.

@return SuccessData

func (*ConfigApiService) EnableAgent ¶

func (a *ConfigApiService) EnableAgent(ctx context.Context, server string, agent string) (SuccessData, *http.Response, error)

ConfigApiService enable agent from the Server Enable an Agent. This command does not install or configure the agent. It only enable existing agent in the system.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param server The Server the agent is connected too.
@param agent The Agent to be enabled.

@return SuccessData

func (*ConfigApiService) Failover ¶

func (a *ConfigApiService) Failover(ctx context.Context, server string) (SuccessData, *http.Response, error)

ConfigApiService Perform Manual Failover on a specified Server Perform Manual Failover on a specified Server

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param server

@return SuccessData

func (*ConfigApiService) GenerateMftRsaSshKey ¶

func (a *ConfigApiService) GenerateMftRsaSshKey(ctx context.Context, body SshKeyProperties, server string, agent string) (SuccessData, *http.Response, error)

ConfigApiService Generate RSA SSH Key Generate RSA SSH Key pair for SFTP account authentication

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Ssh Key pair properites
@param server The Server
@param agent The Agent

@return SuccessData

func (*ConfigApiService) GetAgentCertificateExpirationDate ¶

func (a *ConfigApiService) GetAgentCertificateExpirationDate(ctx context.Context, server string, agent string) (AgentCertificateExpirationData, *http.Response, error)

ConfigApiService Get certificate expiration date. Get the certificate expiration date of SSL configured Agent.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param server The Server.
@param agent The Agent.

@return AgentCertificateExpirationData

func (*ConfigApiService) GetAgentParameters ¶

func (a *ConfigApiService) GetAgentParameters(ctx context.Context, server string, agent string, localVarOptionals *ConfigApiGetAgentParametersOpts) ([]KeyValue, *http.Response, error)

func (*ConfigApiService) GetAgents ¶

func (a *ConfigApiService) GetAgents(ctx context.Context, server string, localVarOptionals *ConfigApiGetAgentsOpts) (AgentDetailsList, *http.Response, error)

func (*ConfigApiService) GetAllArchiveRules ¶

func (a *ConfigApiService) GetAllArchiveRules(ctx context.Context) (ArchiveRulesList, *http.Response, error)

ConfigApiService Get all Workload Archiving rules Get all the Archiving rules

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ArchiveRulesList

func (*ConfigApiService) GetAllAuthorizationRoles ¶

func (a *ConfigApiService) GetAllAuthorizationRoles(ctx context.Context, localVarOptionals *ConfigApiGetAllAuthorizationRolesOpts) ([]RoleHeader, *http.Response, error)

func (*ConfigApiService) GetAllLdapGroups ¶

func (a *ConfigApiService) GetAllLdapGroups(ctx context.Context, localVarOptionals *ConfigApiGetAllLdapGroupsOpts) ([]string, *http.Response, error)

func (*ConfigApiService) GetAllRolesAssociatedWithLdap ¶

func (a *ConfigApiService) GetAllRolesAssociatedWithLdap(ctx context.Context, ldapgroup string, localVarOptionals *ConfigApiGetAllRolesAssociatedWithLdapOpts) ([]string, *http.Response, error)

func (*ConfigApiService) GetAllUsers ¶

func (a *ConfigApiService) GetAllUsers(ctx context.Context, localVarOptionals *ConfigApiGetAllUsersOpts) ([]UserHeader, *http.Response, error)

func (*ConfigApiService) GetArchiveStatistics ¶

func (a *ConfigApiService) GetArchiveStatistics(ctx context.Context) (RulesStatisticListSummary, *http.Response, error)

ConfigApiService Get Workload Archiving statistics Get list of statistical information for each Archiving rule and total information about the number of jobs that have been archived, data size of all job logs and outputs that have been archived, size of the Workload Archiving database including all tables and indexes and percentage of disk space used on the Workload Archiving server

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return RulesStatisticListSummary

func (*ConfigApiService) GetExternalUserAuthorizedFolders ¶

func (a *ConfigApiService) GetExternalUserAuthorizedFolders(ctx context.Context, name string) ([]string, *http.Response, error)

ConfigApiService Get MFT external user authorized folders Get MFT external user authorized folders

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param name The external user name.

@return []string

func (*ConfigApiService) GetExternalUsers ¶

func (a *ConfigApiService) GetExternalUsers(ctx context.Context, localVarOptionals *ConfigApiGetExternalUsersOpts) ([]ExternalUserData, *http.Response, error)

func (*ConfigApiService) GetFtsSettings ¶

func (a *ConfigApiService) GetFtsSettings(ctx context.Context, server string, agent string) (FtsSettingsData, *http.Response, error)

ConfigApiService Get File Transfer Server (FTS) configuration data. Get File Transfer Server (FTS) configuration data.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param server The Server
@param agent The Agent

@return FtsSettingsData

func (*ConfigApiService) GetHostgroups ¶

func (a *ConfigApiService) GetHostgroups(ctx context.Context, server string) ([]string, *http.Response, error)

ConfigApiService get Server hostgroups Get all the hostgroups of the specified Server.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param server The Server the hostgroups belong to.

@return []string

func (*ConfigApiService) GetHostsInGroup ¶

func (a *ConfigApiService) GetHostsInGroup(ctx context.Context, server string, hostgroup string) ([]AgentInGroupParams, *http.Response, error)

ConfigApiService get hostgroup agents Get the agents that compose the specified hostgroup

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param server The Server the hostgroup belongs to.
@param hostgroup The hostgroup name

@return []AgentInGroupParams

func (*ConfigApiService) GetHubStatusDetails ¶

func (a *ConfigApiService) GetHubStatusDetails(ctx context.Context, nodeId string) (string, *http.Response, error)

ConfigApiService Get hub status. Get hub status.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param nodeId Node ID of the hub

@return string

func (*ConfigApiService) GetMFTFolders ¶

func (a *ConfigApiService) GetMFTFolders(ctx context.Context, localVarOptionals *ConfigApiGetMFTFoldersOpts) ([]FolderPropertiesData, *http.Response, error)

func (*ConfigApiService) GetMftConfiguration ¶

func (a *ConfigApiService) GetMftConfiguration(ctx context.Context, server string, agent string) (MftConfigurationData, *http.Response, error)

ConfigApiService Get MFT Configuration Get MFT Configuration

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param server The Server
@param agent The Agent

@return MftConfigurationData

func (*ConfigApiService) GetMftGateways ¶

func (a *ConfigApiService) GetMftGateways(ctx context.Context) ([]GatewayData, *http.Response, error)

ConfigApiService Get MFT gateways Get MFT gateways

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []GatewayData

func (*ConfigApiService) GetMftUserGroups ¶

func (a *ConfigApiService) GetMftUserGroups(ctx context.Context, localVarOptionals *ConfigApiGetMftUserGroupsOpts) ([]UserGroupPropertiesData, *http.Response, error)

func (*ConfigApiService) GetPgpTemplates ¶

func (a *ConfigApiService) GetPgpTemplates(ctx context.Context, server string, agent string, localVarOptionals *ConfigApiGetPgpTemplatesOpts) ([]PgpTemplateData, *http.Response, error)

func (*ConfigApiService) GetRemoteHostProperties ¶

func (a *ConfigApiService) GetRemoteHostProperties(ctx context.Context, server string, remotehost string) (AddRemoteHostParams, *http.Response, error)

ConfigApiService get a remote host configuration from Server Get the remote host configuration properties from the Server

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param server The Server the remote host is connected to.
@param remotehost The name of the remote host.

@return AddRemoteHostParams

func (*ConfigApiService) GetRemoteHosts ¶

func (a *ConfigApiService) GetRemoteHosts(ctx context.Context, server string) ([]string, *http.Response, error)

ConfigApiService get Server remote hosts Get all the remote hosts of the specified Server.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param server The Server to query.

@return []string

func (*ConfigApiService) GetRole ¶

func (a *ConfigApiService) GetRole(ctx context.Context, role string) (RoleData, *http.Response, error)

ConfigApiService Get Authorization Role Get Authorization Role

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param role The Role name.

@return RoleData

func (*ConfigApiService) GetRoleAssociates ¶

func (a *ConfigApiService) GetRoleAssociates(ctx context.Context, role string) ([]AssociateData, *http.Response, error)

ConfigApiService Get all authorization entities associated with role Get all authorization entities associated with role

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param role role name.

@return []AssociateData

func (*ConfigApiService) GetRunAsUser ¶

func (a *ConfigApiService) GetRunAsUser(ctx context.Context, server string, agent string, user string) (RunAsUserData, *http.Response, error)

ConfigApiService Get Run-as user Get Run-as user details from server.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param server The Server.
@param agent The Agent
@param user The user name

@return RunAsUserData

func (*ConfigApiService) GetRunAsUsersList ¶

func (a *ConfigApiService) GetRunAsUsersList(ctx context.Context, server string, localVarOptionals *ConfigApiGetRunAsUsersListOpts) ([]RunAsUserData, *http.Response, error)

func (*ConfigApiService) GetServerParameters ¶

func (a *ConfigApiService) GetServerParameters(ctx context.Context, server string) ([]KeyValue, *http.Response, error)

ConfigApiService get Server parameters Get all the parameters of the specified Server.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param server The Server to query.

@return []KeyValue

func (*ConfigApiService) GetServers ¶

func (a *ConfigApiService) GetServers(ctx context.Context) ([]CtmDetails, *http.Response, error)

ConfigApiService get all the Servers name and hostname in the system Get the names and hostnames of all Servers in the system.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []CtmDetails

func (*ConfigApiService) GetUser ¶

func (a *ConfigApiService) GetUser(ctx context.Context, user string) (UserData, *http.Response, error)

ConfigApiService Get user Get user

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param user The user name.

@return UserData

func (*ConfigApiService) GetUserEffectiveRights ¶

func (a *ConfigApiService) GetUserEffectiveRights(ctx context.Context) (RoleData, *http.Response, error)

ConfigApiService Get user real effective authorizations Get user real effective authorizations by all his roles

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return RoleData

func (*ConfigApiService) GetZosTemplates ¶

func (a *ConfigApiService) GetZosTemplates(ctx context.Context, server string, agent string, localVarOptionals *ConfigApiGetZosTemplatesOpts) ([]ZosTemplateData, *http.Response, error)

func (*ConfigApiService) ListSecrets ¶

func (a *ConfigApiService) ListSecrets(ctx context.Context) ([]string, *http.Response, error)

ConfigApiService Get list of secret names Get the list of names of all the secrets in the vault

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []string

func (*ConfigApiService) PingAgent ¶

func (a *ConfigApiService) PingAgent(ctx context.Context, server string, agent string, localVarOptionals *ConfigApiPingAgentOpts) (SuccessData, *http.Response, error)

func (*ConfigApiService) RecycleItem ¶

func (a *ConfigApiService) RecycleItem(ctx context.Context, id string) (SuccessData, *http.Response, error)

ConfigApiService recycle item Recycle an item

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param id item data

@return SuccessData

func (*ConfigApiService) RemoveControlmServer ¶

func (a *ConfigApiService) RemoveControlmServer(ctx context.Context, server string) (SuccessData, *http.Response, error)

ConfigApiService Delete Server Delete Server

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param server Server host name.

@return SuccessData

func (*ConfigApiService) RemoveGateway ¶

func (a *ConfigApiService) RemoveGateway(ctx context.Context, gatewayName string) (SuccessData, *http.Response, error)

ConfigApiService remove gateway. remove gateway.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param gatewayName gateway name

@return SuccessData

func (*ConfigApiService) RemoveHubFromCluster ¶

func (a *ConfigApiService) RemoveHubFromCluster(ctx context.Context, agentname string) (SuccessData, *http.Response, error)

ConfigApiService remove hub from cluster. remove hub from cluster.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param agentname Agent name

@return SuccessData

func (*ConfigApiService) RemoveRoleFromUser ¶

func (a *ConfigApiService) RemoveRoleFromUser(ctx context.Context, user string, role string) (SuccessData, *http.Response, error)

ConfigApiService Remove a role from a user Remove a role from a user

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param user Name of user
@param role Name of role

@return SuccessData

func (*ConfigApiService) SendArchiveCleanupRequest ¶

func (a *ConfigApiService) SendArchiveCleanupRequest(ctx context.Context, localVarOptionals *ConfigApiSendArchiveCleanupRequestOpts) (SuccessData, *http.Response, error)

func (*ConfigApiService) SetAgentParameter ¶

func (a *ConfigApiService) SetAgentParameter(ctx context.Context, body Value, server string, agent string, name string) (KeyValue, *http.Response, error)

ConfigApiService set agent parameter Set the value of the specified parameter in the specified agent.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body The new parameter value.
@param server The Server the agent is connected to.
@param agent The name of the agent to update.
@param name The parameter name.

@return KeyValue

func (*ConfigApiService) SetSystemParam ¶

func (a *ConfigApiService) SetSystemParam(ctx context.Context, body Value, name string) (SuccessData, *http.Response, error)

ConfigApiService set value of a an em system parameter Set value of an enterprise management system parameter

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Param new value
@param name Parameter name

@return SuccessData

func (*ConfigApiService) Setasprimary ¶

func (a *ConfigApiService) Setasprimary(ctx context.Context, server string) (SuccessData, *http.Response, error)

ConfigApiService Set secondary server as Primary on a specified Server Set secondary server as Primary on a specified Server

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param server

@return SuccessData

func (*ConfigApiService) TestRunAsUser ¶

func (a *ConfigApiService) TestRunAsUser(ctx context.Context, server string, agent string, user string, localVarOptionals *ConfigApiTestRunAsUserOpts) (SuccessData, *http.Response, error)

func (*ConfigApiService) UpdateArchiveRule ¶

func (a *ConfigApiService) UpdateArchiveRule(ctx context.Context, body ArchiveRule, ruleName string) (SuccessData, *http.Response, error)

ConfigApiService Edit Workload Archiving rule Edit Workload Archiving rule details

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Edit Workload Archiving rule details
@param ruleName Rule name to update

@return SuccessData

func (*ConfigApiService) UpdateExternalUser ¶

func (a *ConfigApiService) UpdateExternalUser(ctx context.Context, body ExternalUserData, username string) (SuccessData, *http.Response, error)

ConfigApiService Update an external user Update an external user for b2b

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body External user data
@param username The external user name

@return SuccessData

func (*ConfigApiService) UpdateFtsSettings ¶

func (a *ConfigApiService) UpdateFtsSettings(ctx context.Context, body FtsSettingsData, server string, agent string) (SuccessData, *http.Response, error)

ConfigApiService Update File Transfer Server (FTS) configuration data. Update File Transfer Server (FTS) configuration data.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body File Transfer Server (FTS) configuration data
@param server The Server
@param agent The Agent

@return SuccessData

func (*ConfigApiService) UpdateHostsInHostgroup ¶

func (a *ConfigApiService) UpdateHostsInHostgroup(ctx context.Context, body HostgroupProperties, server string, hostgroup string) (SuccessData, *http.Response, error)

ConfigApiService update agents in hostgroup. update agents in hostgroup.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Agent list to update in a hostgroup
@param server The Server the agent is connected to.
@param hostgroup The hostgroup name

@return SuccessData

func (*ConfigApiService) UpdateMFTFolder ¶

func (a *ConfigApiService) UpdateMFTFolder(ctx context.Context, body FolderPropertiesData, folderName string) (SuccessData, *http.Response, error)

ConfigApiService Update an existing virtual folder in MFT. Update an existing virtual folder in MFT.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body virtual folder data
@param folderName Name of folder

@return SuccessData

func (*ConfigApiService) UpdateMftConfiguration ¶

func (a *ConfigApiService) UpdateMftConfiguration(ctx context.Context, body MftConfigurationData, server string, agent string) (SuccessData, *http.Response, error)

ConfigApiService Update MFT Configuration Update MFT Configuration

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body MFT Configuration Data
@param server The Server
@param agent The Agent

@return SuccessData

func (*ConfigApiService) UpdateMftUserGroup ¶

func (a *ConfigApiService) UpdateMftUserGroup(ctx context.Context, body UserGroupDetailsData, name string) (SuccessData, *http.Response, error)

ConfigApiService Update user group. Update user group.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body User group details
@param name User group name

@return SuccessData

func (*ConfigApiService) UpdatePgpTemplate ¶

func (a *ConfigApiService) UpdatePgpTemplate(ctx context.Context, body PgpTemplateData, server string, agent string, templateName string) (SuccessData, *http.Response, error)

ConfigApiService Update PGP Template Update PGP Template

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body PGP Template Data
@param server The Server
@param agent The Agent
@param templateName The PGP Template Name

@return SuccessData

func (*ConfigApiService) UpdateRole ¶

func (a *ConfigApiService) UpdateRole(ctx context.Context, roleFile *os.File, role string) (SuccessData, *http.Response, error)

ConfigApiService Update Authorization Role Update Authorization Role

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param roleFile
@param role The Role name.

@return SuccessData

func (*ConfigApiService) UpdateRunAsUser ¶

func (a *ConfigApiService) UpdateRunAsUser(ctx context.Context, body RunAsUserDetailsData, server string, agent string, user string) (SuccessData, *http.Response, error)

ConfigApiService Update Run-as user Update Run-as user details in server.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Run as user details data
@param server The Server.
@param agent The Agent
@param user The user name

@return SuccessData

func (*ConfigApiService) UpdateSecret ¶

func (a *ConfigApiService) UpdateSecret(ctx context.Context, name string, localVarOptionals *ConfigApiUpdateSecretOpts) (SuccessData, *http.Response, error)

func (*ConfigApiService) UpdateUser ¶

func (a *ConfigApiService) UpdateUser(ctx context.Context, userFile *os.File, user string) (SuccessData, *http.Response, error)

ConfigApiService Update user Update user

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param userFile
@param user The user name.

@return SuccessData

func (*ConfigApiService) UpdateZosTemplate ¶

func (a *ConfigApiService) UpdateZosTemplate(ctx context.Context, body ZosTemplateData, server string, agent string, templateName string) (SuccessData, *http.Response, error)

ConfigApiService Update z/OS Template Update z/OS Template

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body z/OS Template Data
@param server The Server
@param agent The Agent
@param templateName The z/OS Template Name

@return SuccessData

type ConfigApiTestRunAsUserOpts ¶

type ConfigApiTestRunAsUserOpts struct {
	Body optional.Interface
}

type ConfigApiUpdateSecretOpts ¶

type ConfigApiUpdateSecretOpts struct {
	Body optional.Interface
}

type Configuration ¶

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration ¶

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

type ConfigurationManagerPrivilegeCategory ¶

type ConfigurationManagerPrivilegeCategory struct {
	// Authorization access level (None, Browse, Update, Full)
	Authorization string `json:"Authorization,omitempty"`
	// Control-M Configuration Manager access level (None, Full)
	ConfigurationManagerAccess string `json:"ConfigurationManagerAccess,omitempty"`
	// Configuration access level (None, Browse, Update, Full)
	Configuration string `json:"Configuration,omitempty"`
	// Operation access level (None, Browse, Update, Full)
	Operation string `json:"Operation,omitempty"`
	// Database Maintenance access level (None, Browse, Update, Full)
	Database string `json:"Database,omitempty"`
	// Security access level (None, Browse, Update, Full)
	ControlmSecurity string `json:"ControlmSecurity,omitempty"`
}

type ConnectionProfileDeploymentInfo ¶

type ConnectionProfileDeploymentInfo struct {
	// The logical name of Control-M/Server
	CtmName string `json:"ctmName,omitempty"`
	// The deployment status of connection profile
	Status string `json:"status,omitempty"`
	// The deployment status code of connection profile
	StatusCode int32 `json:"statusCode,omitempty"`
	// UTC date of the modification
	LastUpdate string `json:"lastUpdate,omitempty"`
	// Status information
	Message string `json:"message,omitempty"`
}

type ConnectionProfileStatus ¶

type ConnectionProfileStatus struct {
	// connection profile name
	Name string `json:"name,omitempty"`
	// connection profile type
	Type_ string `json:"type,omitempty"`
	// connection profile description
	Description string `json:"description,omitempty"`
	// UTC date of the modification
	TimeModified string `json:"timeModified,omitempty"`
	// UTC date of the creation
	TimeCreated string `json:"timeCreated,omitempty"`
	// creator's name
	CreatorName string `json:"creatorName,omitempty"`
	// modifier's name
	ModifierName string `json:"modifierName,omitempty"`
	// Status calculated by the server according to the list of statuses with each server
	SyncStatus string `json:"syncStatus,omitempty"`
}

type ConnectionProfilesDeploymentStatusResult ¶

type ConnectionProfilesDeploymentStatusResult struct {
	// Deployment status calculated by the server according to the list of statuses with each Control-M/Server
	DeploymentStatus string `json:"deploymentStatus,omitempty"`
	// The detailed deployment status per Control-M/Server
	DeploymentInfo []ConnectionProfileDeploymentInfo `json:"deploymentInfo,omitempty"`
}

type ConnectionProfilesStatusResult ¶

type ConnectionProfilesStatusResult struct {
	// The list of statuses tracked by the given runId.
	Statuses []ConnectionProfileStatus `json:"statuses,omitempty"`
	// The number of the return items by the search.
	Returned int64 `json:"returned,omitempty"`
	// The total number of items.
	Total int64 `json:"total,omitempty"`
}

type ControlMAuthenticationData ¶

type ControlMAuthenticationData struct {
	// password or secret
	Password string `json:"Password,omitempty"`
	// number of days until the password expires
	PasswordExpirationDays int32 `json:"PasswordExpirationDays,omitempty"`
	// should password be changed in next login
	ChangePasswordAtNextLogin bool `json:"ChangePasswordAtNextLogin,omitempty"`
	// lock account
	LockAccount bool `json:"LockAccount,omitempty"`
}

type CpMngAuth ¶

type CpMngAuth struct {
	// control-M server name
	ControlmServer string `json:"ControlmServer,omitempty"`
	// agent name
	Agent string `json:"Agent,omitempty"`
	// plugin type
	PluginType string `json:"PluginType,omitempty"`
	// connection profile name
	Name string `json:"Name,omitempty"`
	// access level (full, update, browse)
	Privilege string `json:"Privilege,omitempty"`
}

type CtmDetails ¶

type CtmDetails struct {
	// The unique name of the Control-M Server.
	Name string `json:"name,omitempty"`
	// The hostname of the Control-M Server is running on.
	Host string `json:"host,omitempty"`
	// Control-M Server state [up|down].
	State string `json:"state,omitempty"`
	// Control-M Server message describing the communication status.
	Message string `json:"message,omitempty"`
	// Control-M Server version.
	Version string `json:"version,omitempty"`
}

type CtmNameValueSw ¶

type CtmNameValueSw struct {
	CTMAttrName  string `json:"cTMAttrName,omitempty"`
	CTMAttrValue string `json:"cTMAttrValue,omitempty"`
}

type CtmagentBasicInfoType ¶

type CtmagentBasicInfoType struct {
	// server to agent port number
	ServerToAgentPortNumber int32 `json:"serverToAgentPortNumber,omitempty"`
	// agent to server port number
	AgentToServerPortNumber int32 `json:"agentToServerPortNumber,omitempty"`
	// is Server-Agent connection transient or perssistent
	PersistentConnection string `json:"persistentConnection,omitempty"`
	// is connection TCP or SSL
	TcpsslServerMode string `json:"tcpsslServerMode,omitempty"`
	// communication protocol version of the Server-Agent
	ProtocolVersion string `json:"protocolVersion,omitempty"`
	// the Agent's status message
	AgentStatus     string   `json:"agentStatus,omitempty"`
	IpAddressesList []string `json:"ipAddressesList,omitempty"`
}

type CtmagentCtmTestType ¶

type CtmagentCtmTestType struct {
	// the test title
	Title string `json:"title,omitempty"`
	// the test result
	Result string `json:"result,omitempty"`
	// the test message
	Message string `json:"message,omitempty"`
	// the action user initiated
	UserAction string `json:"userAction,omitempty"`
	// the test's command
	Command string `json:"command,omitempty"`
	// the command's output
	CommandOutput string `json:"commandOutput,omitempty"`
	// the test advanced option
	Advanced int32 `json:"advanced,omitempty"`
	// the test oridnal
	Ordinal int32 `json:"ordinal,omitempty"`
}

type CtmagentStateChangedType ¶

type CtmagentStateChangedType struct {
	// the Agent state change timestamp
	Timestamp string `json:"timestamp,omitempty"`
	// the Agent state change status
	Status string `json:"status,omitempty"`
	// the Agent state change message
	Message string `json:"message,omitempty"`
	// the state change ordinal
	Ordinal int32 `json:"ordinal,omitempty"`
}

type CtmvarDelResultItem ¶

type CtmvarDelResultItem struct {
	DelPoolVariablesErrorInfo *PoolVariablesErrorInfo `json:"del_pool_variables_error_info,omitempty"`
}

type CtmvarDelResults ¶

type CtmvarDelResults struct {
	CompletedStatus *ResultsStatus        `json:"completed_status,omitempty"`
	Error_          *ApiThrowable         `json:"error,omitempty"`
	From            int64                 `json:"from,omitempty"`
	Results         []CtmvarDelResultItem `json:"results,omitempty"`
	To              int64                 `json:"to,omitempty"`
}

type CtmvarErrorInfo ¶

type CtmvarErrorInfo struct {
	CtmvarDelErrorCode string `json:"ctmvar_del_error_code,omitempty"`
	CtmvarGetErrorCode string `json:"ctmvar_get_error_code,omitempty"`
	CtmvarSetErrorCode string `json:"ctmvar_set_error_code,omitempty"`
	VariableName       string `json:"variable_name,omitempty"`
}

type CtmvarGetResultItem ¶

type CtmvarGetResultItem struct {
	GetPoolVariablesErrorInfo *PoolVariablesErrorInfo `json:"get_pool_variables_error_info,omitempty"`
	PoolVariablesNameValue    *PoolVariablesNameValue `json:"pool_variables_name_value,omitempty"`
}

type CtmvarGetResults ¶

type CtmvarGetResults struct {
	CompletedStatus *ResultsStatus        `json:"completed_status,omitempty"`
	Error_          *ApiThrowable         `json:"error,omitempty"`
	From            int64                 `json:"from,omitempty"`
	Results         []CtmvarGetResultItem `json:"results,omitempty"`
	To              int64                 `json:"to,omitempty"`
}

type CtmvarResultItem ¶

type CtmvarResultItem struct {
	FullLine      string `json:"full_line,omitempty"`
	Type_         string `json:"type,omitempty"`
	VariableName  string `json:"variable_name,omitempty"`
	VariableValue string `json:"variable_value,omitempty"`
}

type CtmvarResults ¶

type CtmvarResults struct {
	CompletedStatus *ResultsStatus     `json:"completed_status,omitempty"`
	Error_          *ApiThrowable      `json:"error,omitempty"`
	From            int64              `json:"from,omitempty"`
	Results         []CtmvarResultItem `json:"results,omitempty"`
	To              int64              `json:"to,omitempty"`
}

type CtmvarSetResultItem ¶

type CtmvarSetResultItem struct {
	SetPoolVariablesErrorInfo *PoolVariablesErrorInfo `json:"set_pool_variables_error_info,omitempty"`
}

type CtmvarSetResults ¶

type CtmvarSetResults struct {
	CompletedStatus *ResultsStatus        `json:"completed_status,omitempty"`
	Error_          *ApiThrowable         `json:"error,omitempty"`
	From            int64                 `json:"from,omitempty"`
	Results         []CtmvarSetResultItem `json:"results,omitempty"`
	To              int64                 `json:"to,omitempty"`
}

type DeployApiDeleteCalendarOpts ¶

type DeployApiDeleteCalendarOpts struct {
	Server optional.String
}

type DeployApiDeployJobtypeFileOpts ¶

type DeployApiDeployJobtypeFileOpts struct {
	Agent  optional.String
	Server optional.String
}

type DeployApiGetDeployedAiJobtypesOpts ¶

type DeployApiGetDeployedAiJobtypesOpts struct {
	JobTypeName optional.String
	JobTypeId   optional.String
}

type DeployApiGetDeployedCalendarsOpts ¶

type DeployApiGetDeployedCalendarsOpts struct {
	Name   optional.String
	Server optional.String
	Type_  optional.String
	Alias  optional.String
}

type DeployApiGetDeployedConnectionProfilesOpts ¶

type DeployApiGetDeployedConnectionProfilesOpts struct {
	Ctm    optional.String
	Server optional.String
}

type DeployApiGetDeployedConnectionProfilesStatusOpts ¶

type DeployApiGetDeployedConnectionProfilesStatusOpts struct {
	Limit optional.Int64
	Name  optional.String
	Type_ optional.String
}

type DeployApiGetDeployedFoldersNewOpts ¶

type DeployApiGetDeployedFoldersNewOpts struct {
	Format optional.String
	Folder optional.String
	Ctm    optional.String
	Server optional.String
}

type DeployApiGetLocalConnectionProfilesOpts ¶

type DeployApiGetLocalConnectionProfilesOpts struct {
	Ctm    optional.String
	Server optional.String
}

type DeployApiGetSharedConnectionProfilesOpts ¶

type DeployApiGetSharedConnectionProfilesOpts struct {
	Name optional.String
}

type DeployApiService ¶

type DeployApiService service

func (*DeployApiService) DeleteCalendar ¶

func (a *DeployApiService) DeleteCalendar(ctx context.Context, calendarName string, localVarOptionals *DeployApiDeleteCalendarOpts) (SuccessData, *http.Response, error)

func (*DeployApiService) DeleteConnectionProfile ¶

func (a *DeployApiService) DeleteConnectionProfile(ctx context.Context, server string, agent string, type_ string, name string) (SuccessData, *http.Response, error)

DeployApiService Delete Local Connection Profile Delete Local Connection Profile.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param server The name of the Control-M in which the connection profile is deployed.
@param agent The name of the agent the connection profile is deployed on.
@param type_ The type of connection profile to delete.
@param name Name of the Connection Profile

@return SuccessData

func (*DeployApiService) DeleteFolder ¶

func (a *DeployApiService) DeleteFolder(ctx context.Context, controlM string, folderName string) (SuccessData, *http.Response, error)

DeployApiService delete a folder Delete a folder

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param controlM The name of the Control-M in which the folder(s) are deployed.
@param folderName The name of the required folder(s).

@return SuccessData

func (*DeployApiService) DeleteLocalConnectionProfile ¶

func (a *DeployApiService) DeleteLocalConnectionProfile(ctx context.Context, server string, agent string, type_ string, name string) (SuccessData, *http.Response, error)

DeployApiService Delete Local Connection Profile Delete Local Connection Profile

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param server The name of the Control-M in which the connection profile is deployed.
@param agent The name of the agent the connection profile is deployed on.
@param type_ The type of connection profile to delete.
@param name Name of the Connection Profile

@return SuccessData

func (*DeployApiService) DeleteSharedConnectionProfile ¶

func (a *DeployApiService) DeleteSharedConnectionProfile(ctx context.Context, type_ string, name string) (SuccessData, *http.Response, error)

DeployApiService Delete centralized Connection Profile Delete centralized Connection Profile

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param type_ The type of connection profile to delete.
@param name Name of the Connection Profile

@return SuccessData

func (*DeployApiService) DeployAiJobtype ¶

func (a *DeployApiService) DeployAiJobtype(ctx context.Context, ctm string, agent string, jobTypeId string) (AiDeployResponse, *http.Response, error)

DeployApiService Deploy of Application Integrator job type. Deploy an exsiting Application Integrator job type to agent in order to allow it to run

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param ctm
@param agent
@param jobTypeId

@return AiDeployResponse

func (*DeployApiService) DeployFile ¶

func (a *DeployApiService) DeployFile(ctx context.Context, definitionsFile *os.File, deployDescriptorFile *os.File, additionalConfiguration *os.File) ([]DeploymentFileResults, *http.Response, error)

DeployApiService Deploy definitions file Deploy the provided definition file (JSON, XML or zip) to Control-M

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param definitionsFile
@param deployDescriptorFile
@param additionalConfiguration

@return []DeploymentFileResults

func (*DeployApiService) DeployJobtypeFile ¶

func (a *DeployApiService) DeployJobtypeFile(ctx context.Context, definitionsFile *os.File, payloadFile *os.File, localVarOptionals *DeployApiDeployJobtypeFileOpts) (DeployJobtypeResponse, *http.Response, error)

func (*DeployApiService) GetConnectionProfilesDeploymentStatus ¶

func (a *DeployApiService) GetConnectionProfilesDeploymentStatus(ctx context.Context, type_ string, name string) (ConnectionProfilesDeploymentStatusResult, *http.Response, error)

DeployApiService Get deployed connection profiles deployment status Get currently deployed connection profiles deployment status according to the search query as JSON.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param type_ The type of connection profile such as Database, FileTransfer, Hadoop, Informatica, SAP.
@param name Name of the Connection Profile

@return ConnectionProfilesDeploymentStatusResult

func (*DeployApiService) GetDeployedAiJobtypes ¶

func (a *DeployApiService) GetDeployedAiJobtypes(ctx context.Context, localVarOptionals *DeployApiGetDeployedAiJobtypesOpts) (AiJobtypeList, *http.Response, error)

func (*DeployApiService) GetDeployedCalendars ¶

func (a *DeployApiService) GetDeployedCalendars(ctx context.Context, localVarOptionals *DeployApiGetDeployedCalendarsOpts) (string, *http.Response, error)

func (*DeployApiService) GetDeployedConnectionProfiles ¶

func (a *DeployApiService) GetDeployedConnectionProfiles(ctx context.Context, agent string, type_ string, localVarOptionals *DeployApiGetDeployedConnectionProfilesOpts) (string, *http.Response, error)

func (*DeployApiService) GetDeployedConnectionProfilesStatus ¶

func (a *DeployApiService) GetDeployedConnectionProfilesStatus(ctx context.Context, localVarOptionals *DeployApiGetDeployedConnectionProfilesStatusOpts) (ConnectionProfilesStatusResult, *http.Response, error)

func (*DeployApiService) GetDeployedFoldersNew ¶

func (a *DeployApiService) GetDeployedFoldersNew(ctx context.Context, localVarOptionals *DeployApiGetDeployedFoldersNewOpts) (string, *http.Response, error)

func (*DeployApiService) GetLocalConnectionProfiles ¶

func (a *DeployApiService) GetLocalConnectionProfiles(ctx context.Context, agent string, type_ string, localVarOptionals *DeployApiGetLocalConnectionProfilesOpts) (string, *http.Response, error)

func (*DeployApiService) GetSharedConnectionProfiles ¶

func (a *DeployApiService) GetSharedConnectionProfiles(ctx context.Context, type_ string, localVarOptionals *DeployApiGetSharedConnectionProfilesOpts) (string, *http.Response, error)

func (*DeployApiService) GetSiteStandardFieldRestrictions ¶

func (a *DeployApiService) GetSiteStandardFieldRestrictions(ctx context.Context, standardName string, fieldName string) (string, *http.Response, error)

DeployApiService Get the allowed values for the specified field in the specified site standard. Get the allowed values for the specified field in the specified site standard.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param standardName
@param fieldName

@return string

func (*DeployApiService) SetSiteStandardFieldRestrictions ¶

func (a *DeployApiService) SetSiteStandardFieldRestrictions(ctx context.Context, body FieldValues, standardName string, fieldName string) (SuccessData, *http.Response, error)

DeployApiService Replace the allowed values for the specified field in the specified site standard. Replace the allowed values for the specified field in the specified site standard.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body The JSON file with the allowed values
@param standardName
@param fieldName

@return SuccessData

func (*DeployApiService) TestConnectionProfile ¶

func (a *DeployApiService) TestConnectionProfile(ctx context.Context, definitionsFile *os.File, localVarOptionals *DeployApiTestConnectionProfileOpts) (SuccessData, *http.Response, error)

func (*DeployApiService) TransformFile ¶

func (a *DeployApiService) TransformFile(ctx context.Context, definitionsFile *os.File, deployDescriptorFile *os.File) (string, *http.Response, error)

DeployApiService Transform a definitions file Transform the provided definitions file (JSON) according to the provided Deploy Descriptor file (JSON).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param definitionsFile
@param deployDescriptorFile

@return string

type DeployApiTestConnectionProfileOpts ¶

type DeployApiTestConnectionProfileOpts struct {
	Ctm   optional.String
	Agent optional.String
}

type DeployJobtypeResponse ¶

type DeployJobtypeResponse struct {
	// The name of the deployed .ctmai file
	DeploymentFile    string         `json:"deploymentFile,omitempty"`
	SuccessfulDeploys []JobtypeAgent `json:"successfulDeploys,omitempty"`
}

Response of deployed jobtype

type DeploymentFileError ¶

type DeploymentFileError struct {
	Lines []string `json:"lines,omitempty"`
}

type DeploymentFileResults ¶

type DeploymentFileResults struct {
	// The name of a specific deployment file.
	DeploymentFile string `json:"deploymentFile,omitempty"`
	// Determines the number of successfully deployed simple folders.
	SuccessfulFoldersCount int32 `json:"successfulFoldersCount,omitempty"`
	// Determines the number of successfully deployed smart folders.
	SuccessfulSmartFoldersCount int32 `json:"successfulSmartFoldersCount,omitempty"`
	// Determines the number of successfully deployed sub folders.
	SuccessfulSubFoldersCount int32 `json:"successfulSubFoldersCount,omitempty"`
	// Determines the number of successfully deployed sub folders.
	SuccessfulJobsCount int32 `json:"successfulJobsCount,omitempty"`
	// Determines the number of successfully deployed sub folders.
	SuccessfulConnectionProfilesCount int32 `json:"successfulConnectionProfilesCount,omitempty"`
	// Determines the number of successfully deployed sub folders.
	SuccessfulDriversCount int32 `json:"successfulDriversCount,omitempty"`
	// Determines the number of successfully deployed sub folders.
	SuccessfulCalendarsCount int32 `json:"successfulCalendarsCount,omitempty"`
	// Determines if the deployment file is a valid deploy descriptor file.
	IsDeployDescriptorValid    bool                  `json:"isDeployDescriptorValid,omitempty"`
	DeployedFolders            []string              `json:"deployedFolders,omitempty"`
	DeployedJobs               []string              `json:"deployedJobs,omitempty"`
	DeployedDrivers            []string              `json:"deployedDrivers,omitempty"`
	DeployedConnectionProfiles []string              `json:"deployedConnectionProfiles,omitempty"`
	DeployedCalendars          []string              `json:"deployedCalendars,omitempty"`
	Errors                     []DeploymentFileError `json:"errors,omitempty"`
	Warnings                   []WarningList         `json:"warnings,omitempty"`
}

type EmDefaultRequestParameters ¶

type EmDefaultRequestParameters struct {
	AnnotationCategory string `json:"annotation_category,omitempty"`
	AnnotationNotes    string `json:"annotation_notes,omitempty"`
	CtmName            string `json:"ctm_name,omitempty"`
	NetName            string `json:"net_name,omitempty"`
}

type EmSystemParameter ¶

type EmSystemParameter struct {
	// EM System parameter
	Value string `json:"value,omitempty"`
}

type EncryptionMetadata ¶

type EncryptionMetadata struct {
	// The type of encryption algorithm to be used to de/encrypt the fields (AES256 or Blowfish)
	EncryptionType string `json:"encryptionType,omitempty"`
	// The list of XML tag names identifying the fields to be de/encrypted in the request XML
	FieldsToEncrypt []string `json:"fieldsToEncrypt,omitempty"`
}

type ErrorData ¶

type ErrorData struct {
	// The error message that describes the problem.
	Message string `json:"message,omitempty"`
	// An internal identifier of the error.
	Id string `json:"id,omitempty"`
	// Reference to the item this error is referring to.
	Item string `json:"item,omitempty"`
	// The file this error occurred in.
	File string `json:"file,omitempty"`
	// The number of line in the file this error occurred in.
	Line int32 `json:"line,omitempty"`
	// The number of column in the file this error occurred in.
	Col int32 `json:"col,omitempty"`
}

type ErrorList ¶

type ErrorList struct {
	Errors []ErrorData `json:"errors,omitempty"`
}

type Event ¶

type Event struct {
	// Event name
	Name string `json:"name,omitempty"`
	// Control-M Server hosting the event
	Ctm string `json:"ctm,omitempty"`
	// The event date, either date in format dd/mm/yy or a string \"orderdate\"
	Date string `json:"date,omitempty"`
}

type EventParam ¶

type EventParam struct {
	Name string `json:"name"`
	Date string `json:"date"`
}

type ExternalProviderAuthenticationData ¶

type ExternalProviderAuthenticationData struct {
	// ldap user and domain
	LdapUserAndDomain string `json:"LdapUserAndDomain,omitempty"`
}

type ExternalUserData ¶

type ExternalUserData struct {
	// external user name REQUIRED:addExternalUser | HIDDEN
	Name string `json:"name,omitempty"`
	// user email REQUIRED:addExternalUser | HIDDEN
	Email string `json:"email,omitempty"`
	// user's company REQUIRED:addExternalUser | HIDDEN
	Company string `json:"company,omitempty"`
	// user password HIDDEN:updateExternalUser
	Password string `json:"password,omitempty"`
	// user description HIDDEN
	Description string `json:"description,omitempty"`
	// external user phone number HIDDEN
	PhoneNumber string `json:"phoneNumber,omitempty"`
	// SSH key string HIDDEN
	SshKey string      `json:"sshKey,omitempty"`
	As2Key *As2KeyData `json:"as2Key,omitempty"`
	// indicates whether the user account is locked HIDDEN
	IsLocked bool `json:"isLocked,omitempty"`
	// provides the reason for locking the user account HIDDEN
	LockReason string `json:"lockReason,omitempty"`
	// indicates whether a password change is required at next login HIDDEN
	ChangePasswordAtNextLogin bool `json:"changePasswordAtNextLogin,omitempty"`
	// indicates whether the user's password is set to never expire HIDDEN
	PasswordNeverExpires bool `json:"passwordNeverExpires,omitempty"`
}

type FieldMetadataProperties ¶

type FieldMetadataProperties struct {
	ControlType              string                    `json:"controlType,omitempty"`
	DataType                 string                    `json:"dataType,omitempty"`
	DisplayName              string                    `json:"displayName,omitempty"`
	DisplayNameID            string                    `json:"displayNameID,omitempty"`
	FalseValue               string                    `json:"falseValue,omitempty"`
	HashedPassword           bool                      `json:"hashedPassword,omitempty"`
	HideIf                   *ConditionProperties      `json:"hideIf,omitempty"`
	Key                      *SettingKeyProperties     `json:"key,omitempty"`
	Name                     string                    `json:"name,omitempty"`
	NeedRestart              bool                      `json:"needRestart,omitempty"`
	NeedRestartMessage       string                    `json:"needRestartMessage,omitempty"`
	NeedRestartMessageID     string                    `json:"needRestartMessageID,omitempty"`
	Placeholder              string                    `json:"placeholder,omitempty"`
	PlaceholderID            string                    `json:"placeholderID,omitempty"`
	PossibleValues           []PossibleValueProperties `json:"possibleValues,omitempty"`
	Profiles                 []string                  `json:"profiles,omitempty"`
	SettingChangedEventTypes []string                  `json:"settingChangedEventTypes,omitempty"`
	ShowIf                   *ConditionProperties      `json:"showIf,omitempty"`
	Tooltip                  string                    `json:"tooltip,omitempty"`
	TooltipID                string                    `json:"tooltipID,omitempty"`
	TrueValue                string                    `json:"trueValue,omitempty"`
	UnitsLabel               string                    `json:"unitsLabel,omitempty"`
	UnitsLabelID             string                    `json:"unitsLabelID,omitempty"`
	Validations              *ValidationProperties     `json:"validations,omitempty"`
}

type FieldValue ¶

type FieldValue struct {
	Value       string `json:"value"`
	Description string `json:"description,omitempty"`
}

type FieldValues ¶

type FieldValues struct {
	Values *[]FieldValue `json:"values"`
}

type FolderAuth ¶

type FolderAuth struct {
	// access level (Full, Update, Browse)
	Privilege string `json:"Privilege,omitempty"`
	// control-M server name
	ControlmServer string `json:"ControlmServer,omitempty"`
	// job application
	Library string `json:"Library,omitempty"`
	// job sub application
	Folder string `json:"Folder,omitempty"`
	// Allow ordering
	Order bool `json:"Order,omitempty"`
	// Allow ordering
	Run  bool          `json:"Run,omitempty"`
	Jobs *JobLevelAuth `json:"Jobs,omitempty"`
}

type FolderProperties ¶

type FolderProperties struct {
	// The name of the folder. REQUIRED:addMFTFolder | HIDDEN
	Name string `json:"name,omitempty"`
	// Authorized Internal Users. HIDDEN
	AllowedInternalUserNames []string `json:"allowedInternalUserNames,omitempty"`
	// Authorized External Users And User Groups. HIDDEN
	AllowedUserNames []string `json:"allowedUserNames,omitempty"`
	// Array of allowed group names. HIDDEN
	AllowedGroupNames []string `json:"allowedGroupNames,omitempty"`
	// Delete file after downloaded from incoming folder. HIDDEN
	DeleteFilesAfterProcessing bool `json:"deleteFilesAfterProcessing,omitempty"`
	// Send email notification to external users when a new file arrives. HIDDEN
	NotifyByEmailWhenFileArrived bool `json:"notifyByEmailWhenFileArrived,omitempty"`
	// Retention Time in hours. HIDDEN
	RetentionHours int64 `json:"retentionHours,omitempty"`
	// Size limit for folder (in Gigabyte). HIDDEN
	SizeLimit int64 `json:"sizeLimit,omitempty"`
	// allowed file pattern wildcard. HIDDEN
	AllowedFilePattern string `json:"allowedFilePattern,omitempty"`
	// blocked file pattern wildcard. HIDDEN
	ExcludeFilePattern string `json:"excludeFilePattern,omitempty"`
	// Folder's access type (Limited, Unlimited). HIDDEN
	AccessType string `json:"accessType,omitempty"`
}

type FolderPropertiesData ¶

type FolderPropertiesData struct {
	// The name of the folder. REQUIRED:addMFTFolder | HIDDEN
	Name string `json:"name,omitempty"`
	// Authorized Internal Users. HIDDEN
	AuthorizedInternalUsers []string `json:"authorizedInternalUsers,omitempty"`
	// Authorized External Users And User Groups. HIDDEN
	AuthorizedExternalUsersAndGroups []string `json:"authorizedExternalUsersAndGroups,omitempty"`
	// Delete file after downloaded from incoming folder. HIDDEN
	DeleteFilesAfterDownload bool `json:"deleteFilesAfterDownload,omitempty"`
	// Send email notification to external users when a new file arrives. HIDDEN
	NotifyByEmailWhenFileArrive bool `json:"notifyByEmailWhenFileArrive,omitempty"`
	// Retention Time in hours. HIDDEN
	RetentionPolicy int64 `json:"retentionPolicy,omitempty"`
	// Size limit for folder (in Gigabyte). HIDDEN
	SizeLimit int64 `json:"sizeLimit,omitempty"`
	// allowed file pattern wildcard. HIDDEN
	AllowedFilePattern string `json:"allowedFilePattern,omitempty"`
	// blocked file pattern wildcard. HIDDEN
	BlockedFilePattern string `json:"blockedFilePattern,omitempty"`
	// Folder's access type (Limited, Unlimited). HIDDEN
	AccessType string `json:"accessType,omitempty"`
}

type FoldersUsersSettingsAndMetadataProperties ¶

type FoldersUsersSettingsAndMetadataProperties struct {
	Folders          []FolderPropertiesData           `json:"folders,omitempty"`
	Settings         []SettingProperties              `json:"settings,omitempty"`
	SettingsMetadata *SettingsMetadataProperties      `json:"settingsMetadata,omitempty"`
	Users            []UserAllowedFoldersProperties   `json:"users,omitempty"`
	Groups           []GroupsAllowedFoldersProperties `json:"groups,omitempty"`
}

type FoldersUsersSettingsAndMetadataPropertiesFromB2B ¶

type FoldersUsersSettingsAndMetadataPropertiesFromB2B struct {
	Folders          []FolderProperties               `json:"folders,omitempty"`
	Settings         []SettingProperties              `json:"settings,omitempty"`
	SettingsMetadata *SettingsMetadataProperties      `json:"settingsMetadata,omitempty"`
	Users            []UserAllowedFoldersProperties   `json:"users,omitempty"`
	Groups           []GroupsAllowedFoldersProperties `json:"groups,omitempty"`
}

type FtsAuthenticationDetails ¶

type FtsAuthenticationDetails struct {
	LdapAuthenticationDetails *FtsLdapAuthenticationDetails `json:"ldapAuthenticationDetails,omitempty"`
	PamAuthenticationDetails  *FtsPamAuthenticationDetails  `json:"pamAuthenticationDetails,omitempty"`
}

File Transfer Server authentication parameters

type FtsFtpSettings ¶

type FtsFtpSettings struct {
	// Enable/Disable listening for FTP/S connection
	ServerEnabled bool `json:"serverEnabled,omitempty"`
	// FTP server port
	Port int32 `json:"port,omitempty"`
	// Authentication method being used to connect FTP server
	AuthenticationMethod string `json:"authenticationMethod,omitempty"`
	// Use FTP secure connection (SSL/TLS)
	Secured bool `json:"secured,omitempty"`
	// FTPS keystore file location
	KeystoreFilePath string `json:"keystoreFilePath,omitempty"`
	// Password being used to access the FTPS keystore
	KeystoreFilePassword string `json:"keystoreFilePassword,omitempty"`
	// Ftps server allowed cipher suites (comma-separated). Leave empty to allow all supported cipher suites.
	Ciphers string `json:"ciphers,omitempty"`
	// Implicit negotiation mode - requires that the entire FTP session must be encrypted
	ListenForImplicitConnection bool `json:"listenForImplicitConnection,omitempty"`
	// Passive FTP ports range - for PASV connections, the server will open a random port in this range for client to connect to
	PassivePorts string `json:"passivePorts,omitempty"`
}

FTP/FTPS server parameters

type FtsGeneralSettings ¶

type FtsGeneralSettings struct {
	// Root path where transferred files are stored. If you want to use a different directory for each logged in user, you must add /${userName} to the path.
	HomeDirectory string `json:"homeDirectory,omitempty"`
	// Allow multiple open sessions
	MultipleLoginAllowed bool `json:"multipleLoginAllowed,omitempty"`
	// Maximum concurrent open sessions
	MaxOpenSessions int32 `json:"maxOpenSessions,omitempty"`
	// Number of retries before the server closes the connection
	MaxLoginFailures int32 `json:"maxLoginFailures,omitempty"`
	// Time of waiting before letting the user to do another login in seconds
	DelayAfterLoginFailure int32 `json:"delayAfterLoginFailure,omitempty"`
	// Allow bandwidth throttling
	ThrottlingActivated bool `json:"throttlingActivated,omitempty"`
	// Maximum simultaneos uploads
	MaxSimultaneousUploads int32 `json:"maxSimultaneousUploads,omitempty"`
	// Maximum simultaneos downloads
	MaxSimultaneousDownloads int32 `json:"maxSimultaneousDownloads,omitempty"`
}

File Transfer Server general parameters

type FtsLdapAuthenticationDetails ¶

type FtsLdapAuthenticationDetails struct {
	// Name of the user that runs the search action for users that log on
	SearchUserName string `json:"searchUserName,omitempty"`
	// Password of the user that runs the search action for users that log on
	SearchUserPassword string `json:"searchUserPassword,omitempty"`
	// URL of the LDAP Directory server
	ServerUrl string `json:"serverUrl,omitempty"`
	// Base DN (the point from where the server will search for users)
	BaseDn string `json:"baseDn,omitempty"`
	// Name of the LDAP attribute containing the username
	UsernameAttributeName string `json:"usernameAttributeName,omitempty"`
	// Name of the LDAP attribute containing the distinguished name
	DnAttributeName string `json:"dnAttributeName,omitempty"`
	// LDAP server connection timeout in milliseconds
	ConnectionTimeout int32 `json:"connectionTimeout,omitempty"`
}

File Transfer Server LDAP authentication parameters

type FtsPamAuthenticationDetails ¶

type FtsPamAuthenticationDetails struct {
	// Name of PAM service
	ServiceName string `json:"serviceName,omitempty"`
}

File Transfer Server PAM authentication parameters

type FtsSettingsData ¶

type FtsSettingsData struct {
	GeneralSettings       *FtsGeneralSettings       `json:"generalSettings,omitempty"`
	FtpSettings           *FtsFtpSettings           `json:"ftpSettings,omitempty"`
	SftpSettings          *FtsSftpSettings          `json:"sftpSettings,omitempty"`
	AuthenticationDetails *FtsAuthenticationDetails `json:"authenticationDetails,omitempty"`
}

File Transfer Server (FTS) configuration data

type FtsSftpSettings ¶

type FtsSftpSettings struct {
	// Enable/Disable listening for SFTP connection
	ServerEnabled bool `json:"serverEnabled,omitempty"`
	// SFTP server port
	Port int32 `json:"port,omitempty"`
	// Authentication method being used to connect FTP server
	AuthenticationMethod string `json:"authenticationMethod,omitempty"`
	// SFTP keystore file location
	KeystoreFilePath string `json:"keystoreFilePath,omitempty"`
	// Password being used to access the SFTP keystore
	KeystoreFilePassword string `json:"keystoreFilePassword,omitempty"`
	// Ftps server allowed cipher suites (comma-separated). Leave empty to allow all supported cipher suites.
	Ciphers string `json:"ciphers,omitempty"`
	// Known users file location
	KnownUsersFilePath string `json:"knownUsersFilePath,omitempty"`
	// Overridden home directories for specific internal users
	OverriddenUsersHomeDirectories []FtsUserHomeDirectoryData `json:"overriddenUsersHomeDirectories,omitempty"`
}

SFTP server parameters

type FtsUserHomeDirectoryData ¶

type FtsUserHomeDirectoryData struct {
	// User name
	UserName string `json:"userName,omitempty"`
	// Home directory
	HomeDirectory string `json:"homeDirectory,omitempty"`
}

Home directory for specific user

type GatewayData ¶

type GatewayData struct {
	// gateway host name REQUIRED
	Host string `json:"host,omitempty"`
	// gateway port REQUIRED
	Port string `json:"port,omitempty"`
	// gateway status HIDDEN
	Status string `json:"status,omitempty"`
	// general message HIDDEN
	Message string `json:"message,omitempty"`
}

type GenericSwaggerError ¶

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

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body ¶

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶

func (e GenericSwaggerError) Error() string

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

func (GenericSwaggerError) Model ¶

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type GetAlertInfo ¶

type GetAlertInfo struct {
	Id       int32  `json:"id,omitempty"`
	Notes    string `json:"notes,omitempty"`
	Severity string `json:"severity,omitempty"`
	Status   string `json:"status,omitempty"`
}

type GetManifestParams ¶

type GetManifestParams struct {
	// Holds the category of the entry
	Category string `json:"category,omitempty"`
	// Order of appearance
	Order int32 `json:"order,omitempty"`
	// Three letters that are the product unique identifier
	ProductCode string `json:"productCode,omitempty"`
	// The full official name of the product
	Name string `json:"name,omitempty"`
	// Specifies the path to the installation file
	InstallUri string `json:"installUri,omitempty"`
	// Determines whether or not the product should be visible in the web page
	Visible bool `json:"visible,omitempty"`
	// Base64 representaion of image file
	IconBase64 string `json:"iconBase64,omitempty"`
	// Description of the specific error
	Error_ string `json:"error,omitempty"`
	// Http response status code
	ErrorCode string `json:"errorCode,omitempty"`
	// The full name
	FullName string `json:"fullName,omitempty"`
	// The short name
	ShortName string `json:"shortName,omitempty"`
	// List of words that user can use when searching for a plugin
	Keywords []string `json:"keywords,omitempty"`
	// Includes all the versions numbers of the product that exist in the repository
	Versions []string             `json:"versions,omitempty"`
	Group    *ManifestGroupObject `json:"group,omitempty"`
}

type GroupsAllowedFoldersProperties ¶

type GroupsAllowedFoldersProperties struct {
	AllowedFoldersNames []string `json:"allowedFoldersNames,omitempty"`
	// external users
	ExternalUsers []string `json:"externalUsers,omitempty"`
	// ldap groups
	LdapGroups []string `json:"ldapGroups,omitempty"`
	Name       string   `json:"name,omitempty"`
}

type HostGroupData ¶

type HostGroupData struct {
	// Host Group name
	Hostgroup string `json:"hostgroup,omitempty"`
	// Host Group tag
	Tag string `json:"tag,omitempty"`
	// Agents list
	Agentslist []AgentInGroupParams `json:"agentslist,omitempty"`
}

Host group data

type HostProperties ¶

type HostProperties struct {
	// Host Name HIDDEN
	HostName string `json:"hostName,omitempty"`
	// OS Type (Windows/Unix/MVS/OS400/Tandem/OpenVMS/OS2200) HIDDEN
	OsType string `json:"osType,omitempty"`
	// User Name HIDDEN
	User string `json:"user,omitempty"`
	// Password HIDDEN
	Password string `json:"password,omitempty"`
	// Protocol Name (Local/FTP/SFTP) HIDDEN
	Protocol string `json:"protocol,omitempty"`
	// Port HIDDEN
	Port int32 `json:"port,omitempty"`
	// FTP Over SSL/TLS HIDDEN
	Ssl bool `json:"ssl,omitempty"`
	// SSL Implicit HIDDEN
	SslImplicit bool `json:"sslImplicit,omitempty"`
	// Clear Command Channel (CCC) HIDDEN
	CccCommand bool `json:"cccCommand,omitempty"`
	// Clear Data Channel (CDC) HIDDEN
	CdcCommand bool `json:"cdcCommand,omitempty"`
	// SSL Security Level (No Authentication/Server Authentication/Client-Server Authentication) HIDDEN
	SslLevel string `json:"sslLevel,omitempty"`
	// FTP Passive HIDDEN
	Passive bool `json:"passive,omitempty"`
	// Substitute IP Address HIDDEN
	SubstituteIpAddress bool `json:"substituteIpAddress,omitempty"`
	// Extrernded Passive Mode (EPSV) HIDDEN
	ExtendedPassiveMode bool `json:"extendedPassiveMode,omitempty"`
	// SSH Compression HIDDEN
	SshCompression bool `json:"sshCompression,omitempty"`
	// Private Key Name HIDDEN
	LogicalKeyName string `json:"logicalKeyName,omitempty"`
	// Key Passphrase HIDDEN
	Passphrase string `json:"passphrase,omitempty"`
}

type HostgroupAgentParticipation ¶

type HostgroupAgentParticipation struct {
	// The event name.
	Event string `json:"event"`
	// Odate dd-mm-yy or ******
	OrderDate string `json:"orderDate,omitempty"`
}

type HostgroupProperties ¶

type HostgroupProperties struct {
	// Agents list. HIDDEN.
	Agentslist []AgentInGroupParams `json:"agentslist,omitempty"`
	// Host Group tag. HIDDEN.
	Tag string `json:"tag,omitempty"`
}

type HostnamePortPair ¶

type HostnamePortPair struct {
	// host name
	PhysicalHostname string `json:"physicalHostname,omitempty"`
	// port
	Port string `json:"port,omitempty"`
}

type HubData ¶

type HubData struct {
	// Hub state
	Status string `json:"status,omitempty"`
	// Hub sync status
	SyncStatus string `json:"syncStatus,omitempty"`
	// Agent name
	Name string `json:"name,omitempty"`
	// CPU
	Cpu string `json:"cpu,omitempty"`
	// memory usage
	Memory string `json:"memory,omitempty"`
	// Hub Health Message
	Message string `json:"message,omitempty"`
}

type HubStatus ¶

type HubStatus struct {
	// Hub status
	Status string `json:"status,omitempty"`
}

type Job ¶

type Job struct {
	// Order ID of the job.
	JobId string `json:"jobId"`
	// Order ID of the folder containing this job.
	FolderId string `json:"folderId,omitempty"`
	// The run number (in case of cyclic jobs or reruns)
	NumberOfRuns int64 `json:"numberOfRuns,omitempty"`
	// The name of the run job.
	Name string `json:"name,omitempty"`
	// The name of the run job.
	Folder string `json:"folder,omitempty"`
	// The type of the run job.
	Type_ string `json:"type,omitempty"`
	// The status of the run job.
	Status string `json:"status,omitempty"`
	// Is job held.
	Held bool `json:"held,omitempty"`
	// Is job held.
	Deleted bool `json:"deleted,omitempty"`
	// Is it a cyclic job.
	Cyclic bool `json:"cyclic,omitempty"`
	// The start time of the job run.
	StartTime string `json:"startTime,omitempty"`
	// The end time of the job run.
	EndTime string `json:"endTime,omitempty"`
	// The estimated start time of the jobs.
	EstimatedStartTime []string `json:"estimatedStartTime,omitempty"`
	// The estimated end time of the jobs.
	EstimatedEndTime []string `json:"estimatedEndTime,omitempty"`
	// The order date.
	OrderDate string `json:"orderDate,omitempty"`
	// The controlm server.
	Ctm string `json:"ctm,omitempty"`
	// The job description.
	Description string `json:"description,omitempty"`
	// host machine where the job runs.
	Host string `json:"host,omitempty"`
	// job application.
	Application string `json:"application,omitempty"`
	// job subApplication.
	SubApplication string `json:"subApplication,omitempty"`
	// The JSON string that describes the job.
	JobJSON string `json:"jobJSON,omitempty"`
	// A URI that can be used to get the output of the run job
	OutputURI string `json:"outputURI,omitempty"`
	// A URI that can be used to get the log of the run job
	LogURI      string `json:"logURI,omitempty"`
	Duration    int32  `json:"duration,omitempty"`
	RunAs       string `json:"runAs,omitempty"`
	ArchiveRule string `json:"archiveRule,omitempty"`
}

type JobLevelAuth ¶

type JobLevelAuth struct {
	// access level (Full, Update, Browse)
	Privilege string `json:"Privilege,omitempty"`
	// job application
	Application string `json:"Application,omitempty"`
	// job sub application
	SubApplication string `json:"SubApplication,omitempty"`
}

type JobRunStatus ¶

type JobRunStatus struct {
	// Order ID of the job.
	JobId string `json:"jobId"`
	// Order ID of the folder containing this job.
	FolderId string `json:"folderId,omitempty"`
	// The run number (in case of cyclic jobs or reruns)
	NumberOfRuns int64 `json:"numberOfRuns,omitempty"`
	// The name of the run job.
	Name string `json:"name,omitempty"`
	// The name of the run job.
	Folder string `json:"folder,omitempty"`
	// The type of the run job.
	Type_ string `json:"type,omitempty"`
	// The status of the run job.
	Status string `json:"status,omitempty"`
	// Is job held.
	Held bool `json:"held,omitempty"`
	// Is job held.
	Deleted bool `json:"deleted,omitempty"`
	// Is it a cyclic job.
	Cyclic bool `json:"cyclic,omitempty"`
	// The start time of the job run.
	StartTime string `json:"startTime,omitempty"`
	// The end time of the job run.
	EndTime string `json:"endTime,omitempty"`
	// The estimated start time of the jobs.
	EstimatedStartTime []string `json:"estimatedStartTime,omitempty"`
	// The estimated end time of the jobs.
	EstimatedEndTime []string `json:"estimatedEndTime,omitempty"`
	// The order date.
	OrderDate string `json:"orderDate,omitempty"`
	// The controlm server.
	Ctm string `json:"ctm,omitempty"`
	// The job description.
	Description string `json:"description,omitempty"`
	// host machine where the job runs.
	Host string `json:"host,omitempty"`
	// job application.
	Application string `json:"application,omitempty"`
	// job subApplication.
	SubApplication string `json:"subApplication,omitempty"`
	// The JSON string that describes the job.
	JobJSON string `json:"jobJSON,omitempty"`
	// A URI that can be used to get the output of the run job
	OutputURI string `json:"outputURI,omitempty"`
	// A URI that can be used to get the log of the run job
	LogURI string `json:"logURI,omitempty"`
}

type JobStatusResult ¶

type JobStatusResult struct {
	// The list of statuses tracked by the given runId.
	Statuses []JobRunStatus `json:"statuses,omitempty"`
	// The index of the first item in the list.
	StartIndex int64 `json:"startIndex,omitempty"`
	// The maximum number of items returned by each status request.
	ItemsPerPage int64 `json:"itemsPerPage,omitempty"`
	// The number of the return items by the search.
	Returned int64 `json:"returned,omitempty"`
	// The total number of items.
	Total int64 `json:"total,omitempty"`
	// The field the list is sorted by.
	Sort string `json:"sort,omitempty"`
	// URI to get the next items in the list, if any.
	NextURI string `json:"nextURI,omitempty"`
	// URI to get the previous items in the list, if any.
	PrevURI string `json:"prevURI,omitempty"`
	// A URI to a page displaying the workflow run live.
	MonitorPageURI string `json:"monitorPageURI,omitempty"`
}

type JobtypeAgent ¶

type JobtypeAgent struct {
	// Server name
	Server string `json:"server,omitempty"`
	// Agent name
	Agent string `json:"agent,omitempty"`
}

Specifications of an agent

type KeyValue ¶

type KeyValue struct {
	// Unique key
	Name string `json:"name"`
	// Any value in string form.
	Value string `json:"value"`
	// The default value if exist.
	DefaultValue string `json:"defaultValue,omitempty"`
	// The validation type number.
	Validation string `json:"validation,omitempty"`
	// The category of the parameter.
	Category string `json:"category,omitempty"`
	// The description of the parameter.
	Description string `json:"description,omitempty"`
	// The error message of the parameter.
	ErrMsg string `json:"errMsg,omitempty"`
	// The verification type of the parameter.
	Verification string `json:"verification,omitempty"`
	// The table the parameter belongs to.
	Table string `json:"table,omitempty"`
	// The parameter type.
	Type_ string `json:"type,omitempty"`
	// The validation limits of the parameter.
	Limits string `json:"limits,omitempty"`
}

type KeyValueType ¶

type KeyValueType struct {
	// Unique key
	Name string `json:"name"`
	// Any value in string form.
	Value string `json:"value"`
	// The default value if exist.
	DefaultValue string `json:"defaultValue,omitempty"`
	// the type of the request.
	Type_ string `json:"type,omitempty"`
}

type KnownHosts ¶

type KnownHosts struct {
	Hosts    []string `json:"hosts,omitempty"`
	Clusters []string `json:"clusters,omitempty"`
}

type Log ¶

type Log struct {
	Log string `json:"log,omitempty"`
}

type LogDataArguments ¶

type LogDataArguments struct {
	ValueStr string `json:"value_str,omitempty"`
}

type LogJobParameters ¶

type LogJobParameters struct {
	FromRerunCount string `json:"from_rerun_count,omitempty"`
	OrderId        string `json:"order_id,omitempty"`
	ToRerunCount   string `json:"to_rerun_count,omitempty"`
}

type LogJobResultItem ¶

type LogJobResultItem struct {
	DataArguments         []LogDataArguments `json:"data_arguments,omitempty"`
	FormattedMessage      string             `json:"formatted_message,omitempty"`
	FullLine              string             `json:"full_line,omitempty"`
	LocalTimestampIso8601 string             `json:"local_timestamp_iso8601,omitempty"`
	Message               string             `json:"message,omitempty"`
	MessageCode           string             `json:"message_code,omitempty"`
}

type LogJobResults ¶

type LogJobResults struct {
	CompletedStatus *ResultsStatus     `json:"completed_status,omitempty"`
	Error_          *ApiThrowable      `json:"error,omitempty"`
	From            int64              `json:"from,omitempty"`
	Results         []LogJobResultItem `json:"results,omitempty"`
	To              int64              `json:"to,omitempty"`
}

type LogParams ¶

type LogParams struct {
	// The name of the Control-M server in which the job was ordered from. HIDDEN.
	Ctm string `json:"ctm,omitempty"`
	// Job's order id. HIDDEN.
	OrderId string `json:"orderId,omitempty"`
	// Job's rerun number. HIDDEN.
	NumberOfRuns int32 `json:"numberOfRuns,omitempty"`
	// Job's log table name, accepted as a value in search request. HIDDEN.
	LogTable string `json:"logTable,omitempty"`
}

type LoginCredentials ¶

type LoginCredentials struct {
	Username string `json:"username"`
	Password string `json:"password"`
}

type LoginResult ¶

type LoginResult struct {
	Username string `json:"username,omitempty"`
	Token    string `json:"token,omitempty"`
	Version  string `json:"version,omitempty"`
}

type ManifestGroupItemObject ¶

type ManifestGroupItemObject struct {
	Name       string `json:"name,omitempty"`
	IconBase64 string `json:"iconBase64,omitempty"`
}

type ManifestGroupObject ¶

type ManifestGroupObject struct {
	Item []ManifestGroupItemObject `json:"item,omitempty"`
}

type MftConfigurationData ¶

type MftConfigurationData struct {
	// Connection timeout (seconds) HIDDEN
	ConnectionTimeoutInSeconds int32 `json:"connectionTimeoutInSeconds,omitempty"`
	// Number of connection retries HIDDEN
	ConnectionRetries int32 `json:"connectionRetries,omitempty"`
	// Time between connection retries (seconds) HIDDEN
	ConnectionTimeBetweenRetriesInSeconds int32 `json:"connectionTimeBetweenRetriesInSeconds,omitempty"`
	// MFT debug level (0-5) HIDDEN
	DebugLevel int32 `json:"debugLevel,omitempty"`
	// PGP temporary directory HIDDEN
	PgpTempDir string `json:"pgpTempDir,omitempty"`
	// Enable SSL debug trace HIDDEN
	SslDebugTrace bool `json:"sslDebugTrace,omitempty"`
	// Use PAM password authentication HIDDEN
	PamAuthentication bool `json:"pamAuthentication,omitempty"`
	// Use web proxy HIDDEN
	ProxyIsInUse bool `json:"proxyIsInUse,omitempty"`
	// Proxy host HIDDEN
	ProxyHost string `json:"proxyHost,omitempty"`
	// Proxy port HIDDEN
	ProxyPort int32 `json:"proxyPort,omitempty"`
	// Proxy user HIDDEN
	ProxyUser string `json:"proxyUser,omitempty"`
	// Proxy password HIDDEN
	ProxyPassword string `json:"proxyPassword,omitempty"`
	// File watch search interval (seconds) HIDDEN
	FileWatcherSearchInterval int32 `json:"fileWatcherSearchInterval,omitempty"`
	// Number of iterations while file is static HIDDEN
	FileWatcherStaticIterations int32 `json:"fileWatcherStaticIterations,omitempty"`
	// Check that file is not in use HIDDEN
	FileWatcherCheckFileIsInUse bool `json:"fileWatcherCheckFileIsInUse,omitempty"`
	// File action retry interval (seconds) HIDDEN
	FileActionsRetriesIntervalInSeconds int32 `json:"fileActionsRetriesIntervalInSeconds,omitempty"`
	// Number of file action retries HIDDEN
	FileActionsRetriesNum int32 `json:"fileActionsRetriesNum,omitempty"`
}

type MonitoringPrivilegeCategory ¶

type MonitoringPrivilegeCategory struct {
	// Alerts access level (None, Browse, Update, Full)
	Alert string `json:"Alert,omitempty"`
	// Archived Viewpoints access level (None, Browse, Update, Full)
	ViewpointArchive string `json:"ViewpointArchive,omitempty"`
}

type NewSample ¶

type NewSample struct {
	Title       string `json:"title"`
	Description string `json:"description,omitempty"`
}

type Node ¶

type Node struct {
	// Node Name
	Name string `json:"Name,omitempty"`
	// A unique id of the node
	Id           string         `json:"Id,omitempty"`
	Availability []Availability `json:"Availability,omitempty"`
	Performance  []Performance  `json:"Performance,omitempty"`
}

type OrderFolderParameters ¶

type OrderFolderParameters struct {
	// The Control-M Server to order from. REQUIRED.
	Ctm string `json:"ctm,omitempty"`
	// The folder to order. REQUIRED.
	Folder string `json:"folder,omitempty"`
	// Filter the jobs to order.
	Jobs string `json:"jobs,omitempty"`
	// The z/os library that contains the job (only for MF).
	Library string `json:"library,omitempty"`
	// Is it allowed to order the same jobs more than once to the same SMART folder. HIDDEN.
	CreateDuplicate bool `json:"createDuplicate,omitempty"`
	// Are jobs ordered in a HOLD state. HIDDEN.
	Hold bool `json:"hold,omitempty"`
	// Is scheduling criteria to be ignored. HIDDEN.
	IgnoreCriteria bool `json:"ignoreCriteria,omitempty"`
	// Whether to generate new flow in this order. HIDDEN.
	IndependentFlow bool `json:"independentFlow,omitempty"`
	// The order date that is attached to this order command. HIDDEN.
	OrderDate string `json:"orderDate,omitempty"`
	// Policy for placing the jobs in a SMART folder. HIDDEN.
	OrderIntoFolder string `json:"orderIntoFolder,omitempty"`
	// Whether to wait for the order date when running the jobs. HIDDEN.
	WaitForOrderDate bool `json:"waitForOrderDate,omitempty"`
	// Job Variables for this run. HIDDEN.
	Variables []map[string]string `json:"variables,omitempty"`
}

type Output ¶

type Output struct {
	Output string `json:"output,omitempty"`
}

type OutputParams ¶

type OutputParams struct {
	// The name of the Control-M server in which the job was ordered from. HIDDEN.
	Ctm string `json:"ctm,omitempty"`
	// Job's order id. HIDDEN.
	OrderId string `json:"orderId,omitempty"`
	// Job's rerun number. HIDDEN.
	NumberOfRuns int32 `json:"numberOfRuns,omitempty"`
	// Job's output table name, accepted as a value in search request. HIDDEN.
	OutputTable string `json:"outputTable,omitempty"`
}

type PasswordsObject ¶

type PasswordsObject struct {
	// user name HIDDEN
	User string `json:"user,omitempty"`
	// current password
	CurrentPassword string `json:"currentPassword,omitempty"`
	// new password
	NewPassword string `json:"newPassword,omitempty"`
}

type Performance ¶

type Performance struct {
	// the type of the availability metric
	Type_ string `json:"Type,omitempty"`
	// the name of the metric
	Name string `json:"Name,omitempty"`
	// the unit of measurement
	Unit string `json:"Unit,omitempty"`
	// the value of the metric
	Value int32 `json:"Value,omitempty"`
}

type PgpTemplateData ¶

type PgpTemplateData struct {
	// Template name HIDDEN
	Name string `json:"name,omitempty"`
	// Executable Full Path HIDDEN
	ExecutableFullPath string `json:"executableFullPath,omitempty"`
	// Exit code (default 0) HIDDEN
	ExitCode int32 `json:"exitCode,omitempty"`
	// passphrase HIDDEN
	Passphrase string `json:"passphrase,omitempty"`
	// Recipient HIDDEN
	Recipient string `json:"recipient,omitempty"`
	// Encryption Attributes HIDDEN
	EncryptionAttributes string `json:"encryptionAttributes,omitempty"`
	// Decryption Attributes HIDDEN
	DecryptionAttributes string `json:"decryptionAttributes,omitempty"`
}

type PingAgentParams ¶

type PingAgentParams struct {
	// Discover parameter when true the agent will be added to the Control-M. HIDDEN
	Discover bool `json:"discover"`
	// maximum time in seconds to wait (default 60). HIDDEN
	Timeout int32 `json:"timeout"`
}

type PlanningPrivilegeCategory ¶

type PlanningPrivilegeCategory struct {
	// Periodical Statistics access level (None, Browse, Update, Full)
	PeriodicalStatistics string `json:"PeriodicalStatistics,omitempty"`
	// Forecast/BIM Configuration access level (None, Browse, Update, Full)
	ForecastOrBatchImpactManagerConfig string `json:"ForecastOrBatchImpactManagerConfig,omitempty"`
	// Promotion Rules access level (None, Browse, Update, Full)
	PromotionRules string `json:"PromotionRules,omitempty"`
	// Promote Action access level (None, Browse, Update, Full)
	PromoteAction string `json:"PromoteAction,omitempty"`
}

type PluginData ¶

type PluginData struct {
	// The application type
	ApplicationType string `json:"applicationType,omitempty"`
	// The application version
	ApplicationVersion string `json:"applicationVersion,omitempty"`
	// The plugin version
	PluginVersion string `json:"pluginVersion,omitempty"`
	// The version
	Version string `json:"version,omitempty"`
	// The current state
	CurrentState string `json:"currentState,omitempty"`
	// The status
	Status string `json:"status,omitempty"`
	// The status message
	StatusMessage string `json:"statusMessage,omitempty"`
	// The last update
	LastUpdate string `json:"lastUpdate,omitempty"`
	// The B2B activated indication
	B2bActivated string `json:"b2bActivated,omitempty"`
}

type PluginMngAuth ¶

type PluginMngAuth struct {
	// control-M server name
	ControlmServer string `json:"ControlmServer,omitempty"`
	// agent name
	Agent string `json:"Agent,omitempty"`
	// plugin type
	PluginType string `json:"PluginType,omitempty"`
	// access level (full, update, browse)
	Privilege string `json:"Privilege,omitempty"`
}

type PoolVariablesErrorInfo ¶

type PoolVariablesErrorInfo struct {
	CtmvarErrorInfo []CtmvarErrorInfo `json:"ctmvar_error_info,omitempty"`
	PoolName        string            `json:"pool_name,omitempty"`
}

type PoolVariablesName ¶

type PoolVariablesName struct {
	PoolName     string   `json:"pool_name,omitempty"`
	VariableName []string `json:"variable_name,omitempty"`
}

type PoolVariablesNameValue ¶

type PoolVariablesNameValue struct {
	PoolName          string              `json:"pool_name,omitempty"`
	VariableNameValue []VariableNameValue `json:"variable_name_value,omitempty"`
}

type PossibleValueProperties ¶

type PossibleValueProperties struct {
	Label   string `json:"label,omitempty"`
	LabelID string `json:"labelID,omitempty"`
	Value   string `json:"value,omitempty"`
}

type PrivilegeName ¶

type PrivilegeName struct {
	// access level (none, full, update, browse)
	Privilege string `json:"Privilege,omitempty"`
	// pattern value
	Name string `json:"Name,omitempty"`
}

type PrivilegeNameControlm ¶

type PrivilegeNameControlm struct {
	// access level (Full, Update, Browse)
	Privilege string `json:"Privilege,omitempty"`
	// control-M server name
	ControlmServer string `json:"ControlmServer,omitempty"`
	// property name
	Name string `json:"Name,omitempty"`
}

type Privileges ¶

type Privileges struct {
	ClientAccess         *ClientAccessPrivilegeCategory         `json:"ClientAccess,omitempty"`
	ConfigurationManager *ConfigurationManagerPrivilegeCategory `json:"ConfigurationManager,omitempty"`
	Monitoring           *MonitoringPrivilegeCategory           `json:"Monitoring,omitempty"`
	Planning             *PlanningPrivilegeCategory             `json:"Planning,omitempty"`
	Tools                *ToolsPrivilegeCategory                `json:"Tools,omitempty"`
	ViewpointManager     *ViewpointManagerPrivilegeCategory     `json:"ViewpointManager,omitempty"`
}

type ProductDescription ¶

type ProductDescription struct {
	// The product name.
	ProductName string `json:"productName,omitempty"`
	// The product description.
	ProductDescription string `json:"productDescription,omitempty"`
	// is Section open.
	IsSectionOpen bool `json:"isSectionOpen,omitempty"`
	// is static text section.
	StaticText bool `json:"staticText,omitempty"`
	// is token component added.
	TokenComponent bool `json:"tokenComponent,omitempty"`
}

type ProductSections ¶

type ProductSections struct {
	Sections []ProductDescription `json:"sections,omitempty"`
	// The product description. HIDDEN
	ProductDescriptionUrl string `json:"productDescriptionUrl,omitempty"`
}

type ProvisionAdvanceParameters ¶

type ProvisionAdvanceParameters struct {
	// Which component is allowed to initiate the connection [ServerToAgent | AgentToServer | BothAllowed]. Parameters start with capital letter.  HIDDEN.
	ConnectionInitiator string `json:"connectionInitiator,omitempty"`
	// Logical name that is used to label specific Control-M/Agents into a group with a specific authorization level.  HIDDEN.
	Tag string `json:"tag,omitempty"`
	// Control-M/Server name (in case it has an alias or multiple network interfaces).  HIDDEN.
	ServerHostName string `json:"serverHostName,omitempty"`
	// Control-M/Server port to communicate with the agent.  HIDDEN.
	ServerPort int32 `json:"serverPort,omitempty"`
}

type ProvisionApiGetAllUpgradeActivitiesStatusOpts ¶

type ProvisionApiGetAllUpgradeActivitiesStatusOpts struct {
	Ctm          optional.String
	Server       optional.String
	Agent        optional.String
	FromVersion  optional.String
	ToVersion    optional.String
	Activity     optional.String
	Status       optional.String
	ActivityName optional.String
}

type ProvisionApiGetEligibleAgentsForUpgradeOpts ¶

type ProvisionApiGetEligibleAgentsForUpgradeOpts struct {
	Type_   optional.String
	Version optional.String
}

type ProvisionApiGetImagesOpts ¶

type ProvisionApiGetImagesOpts struct {
	Version optional.String
}

type ProvisionApiService ¶

type ProvisionApiService service

func (*ProvisionApiService) CancelUpgradeActivity ¶

func (a *ProvisionApiService) CancelUpgradeActivity(ctx context.Context, upgradeId string) (SuccessData, *http.Response, error)

ProvisionApiService Cancel upgrade activity Cancel upgrade activity

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param upgradeId Id of upgrade to cancel

@return SuccessData

func (*ProvisionApiService) DeleteUpgradeActivity ¶

func (a *ProvisionApiService) DeleteUpgradeActivity(ctx context.Context, upgradeId string) (SuccessData, *http.Response, error)

ProvisionApiService Delete upgrade activity status for specific upgrade id. Delete upgrade activity status for specific upgrade id.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param upgradeId The upgrade id.

@return SuccessData

func (*ProvisionApiService) GetAllUpgradeActivitiesStatus ¶

func (a *ProvisionApiService) GetAllUpgradeActivitiesStatus(ctx context.Context, localVarOptionals *ProvisionApiGetAllUpgradeActivitiesStatusOpts) (UpgradeRecordList, *http.Response, error)

func (*ProvisionApiService) GetDeployVersions ¶

func (a *ProvisionApiService) GetDeployVersions(ctx context.Context) ([]UpgradeInfo, *http.Response, error)

ProvisionApiService Get available versions for upgrade. Get available versions for upgrade

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []UpgradeInfo

func (*ProvisionApiService) GetEligibleAgentsForUpgrade ¶

func (a *ProvisionApiService) GetEligibleAgentsForUpgrade(ctx context.Context, localVarOptionals *ProvisionApiGetEligibleAgentsForUpgradeOpts) ([]UpgradeAgentInfo, *http.Response, error)

func (*ProvisionApiService) GetImages ¶

func (a *ProvisionApiService) GetImages(ctx context.Context, os string, localVarOptionals *ProvisionApiGetImagesOpts) ([]string, *http.Response, error)

func (*ProvisionApiService) GetUpgradeActivityLog ¶

func (a *ProvisionApiService) GetUpgradeActivityLog(ctx context.Context, upgradeId string) (string, *http.Response, error)

ProvisionApiService Returns log of upgrade activity. Returns log of upgrade activity

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param upgradeId The upgrade id.

@return string

func (*ProvisionApiService) GetUpgradeActivityStatusPerUpgradeId ¶

func (a *ProvisionApiService) GetUpgradeActivityStatusPerUpgradeId(ctx context.Context, upgradeId string) (UpgradeRecord, *http.Response, error)

ProvisionApiService Get upgrade activity status for specific upgrade id. Get upgrade activity status for specific upgrade id.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param upgradeId The upgrade id.

@return UpgradeRecord

func (*ProvisionApiService) RetryUpgradeActivity ¶

func (a *ProvisionApiService) RetryUpgradeActivity(ctx context.Context, upgradeId string) (SuccessData, *http.Response, error)

ProvisionApiService Retry upgrade activity Retry upgrade activity

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param upgradeId Id of upgrade to retry

@return SuccessData

func (*ProvisionApiService) TransferAndInstallProduct ¶

func (a *ProvisionApiService) TransferAndInstallProduct(ctx context.Context, body UpgradeRequest) (UpgradeResponse, *http.Response, error)

ProvisionApiService Transfer and install a product on an agent Transfer and install a product on an agent

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Upgrade request details

@return UpgradeResponse

func (*ProvisionApiService) UninstallProduct ¶

func (a *ProvisionApiService) UninstallProduct(ctx context.Context, body UpgradeRequest) (UpgradeResponse, *http.Response, error)

ProvisionApiService Uninstall a product from an agent Uninstall a product from an agent

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body Rollback request details

@return UpgradeResponse

type RawCmsXmlRequest ¶

type RawCmsXmlRequest struct {
	// The raw XML request string
	RawXmlRequest      string              `json:"rawXmlRequest,omitempty"`
	EncryptionMetadata *EncryptionMetadata `json:"encryptionMetadata,omitempty"`
}

type ReadOnlyStatus ¶

type ReadOnlyStatus struct {
	// The status of readOnly
	Mode bool `json:"mode,omitempty"`
}

type ReportDateTimeSettings ¶

type ReportDateTimeSettings struct {
	DateFormat     string `json:"dateFormat,omitempty"`
	TimeFormat     string `json:"timeFormat,omitempty"`
	DateTimeFormat string `json:"dateTimeFormat,omitempty"`
}

type ReportFilter ¶

type ReportFilter struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type ReportResult ¶

type ReportResult struct {
	// A URL to the report.
	ReportURL string `json:"reportURL"`
}

type ReportingApiGetReportByNameOpts ¶

type ReportingApiGetReportByNameOpts struct {
	Format optional.String
}

type ReportingApiService ¶

type ReportingApiService service

func (*ReportingApiService) GetReportByName ¶

func (a *ReportingApiService) GetReportByName(ctx context.Context, name string, localVarOptionals *ReportingApiGetReportByNameOpts) (ReportResult, *http.Response, error)

func (*ReportingApiService) GetReportFilters ¶

func (a *ReportingApiService) GetReportFilters(ctx context.Context, name string) (RunReport, *http.Response, error)

ReportingApiService Retrieves report filters Retrieves report filters

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param name The report name

@return RunReport

func (*ReportingApiService) GetReportStatus ¶

func (a *ReportingApiService) GetReportStatus(ctx context.Context, reportId string) (RunReportInfo, *http.Response, error)

ReportingApiService Retrieves status information for a report generation request based on the report ID Retrieves status information for a report generation request based on the report ID

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param reportId The ID of the report

@return RunReportInfo

func (*ReportingApiService) RunReport ¶

func (a *ReportingApiService) RunReport(ctx context.Context, body RunReport) (RunReportInfo, *http.Response, error)

ReportingApiService Run a report Sends a request to generate a report asynchronously and returns the request status. If the report is shared, add [shared:] before the name.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body The report generation parameters

@return RunReportInfo

type RequestParametersWrapperEmDefaultRequestParametersLogJobParameters ¶

type RequestParametersWrapperEmDefaultRequestParametersLogJobParameters struct {
	CtmParameters *LogJobParameters           `json:"ctm_parameters,omitempty"`
	EmParameters  *EmDefaultRequestParameters `json:"em_parameters,omitempty"`
}

type RequestParametersWrapperEmDefaultRequestParametersWhyJobParameter ¶

type RequestParametersWrapperEmDefaultRequestParametersWhyJobParameter struct {
	CtmParameters *WhyJobParameters           `json:"ctm_parameters,omitempty"`
	EmParameters  *EmDefaultRequestParameters `json:"em_parameters,omitempty"`
}

type RerunParameters ¶

type RerunParameters struct {
	ZosParameters *RerunZosParameters `json:"zosParameters,omitempty"`
}

type RerunZosParameters ¶

type RerunZosParameters struct {
	From *RestartStep `json:"from,omitempty"`
	To   *RestartStep `json:"to,omitempty"`
	// cleanup instead of running specific steps. HIDDEN.
	Cleanup bool `json:"cleanup,omitempty"`
	// TO BE ADDED. HIDDEN.
	RecaptureAbend string `json:"recaptureAbend,omitempty"`
	// TO BE ADDED. HIDDEN.
	RecaptureConditionCode string `json:"recaptureConditionCode,omitempty"`
	// TO BE ADDED. HIDDEN.
	StepAdjustment bool `json:"stepAdjustment,omitempty"`
	// TO BE ADDED. HIDDEN.
	RestartParmMemberName string `json:"restartParmMemberName,omitempty"`
}

type ResourceMax ¶

type ResourceMax struct {
	Max int32 `json:"max"`
}

type ResourceObj ¶

type ResourceObj struct {
	// Resource name
	Name string `json:"name,omitempty"`
	// Control-M Server hosting the resource
	Ctm string `json:"ctm,omitempty"`
	// The resource q current quantity.
	Available string `json:"available,omitempty"`
	// The resource q max usage value.
	Max int32 `json:"max,omitempty"`
	// Workload Policy.
	WorkloadPolicy string `json:"workloadPolicy,omitempty"`
}

type ResourceParam ¶

type ResourceParam struct {
	Name string `json:"name"`
	Max  string `json:"max"`
}

type RestartStep ¶

type RestartStep struct {
	// program step
	Pgm string `json:"pgm,omitempty"`
	// proc step
	Proc string `json:"proc,omitempty"`
}

type ResultsStatus ¶

type ResultsStatus struct {
	DisplayUsage bool     `json:"display_usage,omitempty"`
	Message      string   `json:"message,omitempty"`
	Messages     []string `json:"messages,omitempty"`
	ReturnCode   int32    `json:"return_code,omitempty"`
}

type RoleData ¶

type RoleData struct {
	// role name
	Name string `json:"Name,omitempty"`
	// role description
	Description string `json:"Description,omitempty"`
	// organization groups
	OrganizationGroups          []string                `json:"OrganizationGroups,omitempty"`
	AllowedJobs                 *AllowedJobs            `json:"AllowedJobs,omitempty"`
	AllowedJobActions           *AllowedJobActions      `json:"AllowedJobActions,omitempty"`
	Privileges                  *Privileges             `json:"Privileges,omitempty"`
	Folders                     []FolderAuth            `json:"Folders,omitempty"`
	Calendars                   []PrivilegeNameControlm `json:"Calendars,omitempty"`
	RunasUsers                  []RunasUserAuth         `json:"RunasUsers,omitempty"`
	WorkloadPolicies            []PrivilegeName         `json:"WorkloadPolicies,omitempty"`
	SiteStandard                []PrivilegeName         `json:"SiteStandard,omitempty"`
	SiteCustomization           []PrivilegeName         `json:"SiteCustomization,omitempty"`
	Services                    []ServiceAuth           `json:"Services,omitempty"`
	Events                      []PrivilegeNameControlm `json:"Events,omitempty"`
	Mutexes                     []PrivilegeNameControlm `json:"Mutexes,omitempty"`
	Locks                       []PrivilegeNameControlm `json:"Locks,omitempty"`
	Semaphores                  []PrivilegeNameControlm `json:"Semaphores,omitempty"`
	Pools                       []PrivilegeNameControlm `json:"Pools,omitempty"`
	Variables                   []PrivilegeNameControlm `json:"Variables,omitempty"`
	GlobalEvents                []PrivilegeName         `json:"GlobalEvents,omitempty"`
	AgentManagement             []AgentMngAuth          `json:"AgentManagement,omitempty"`
	PluginManagement            []PluginMngAuth         `json:"PluginManagement,omitempty"`
	ConnectionProfileManagement []CpMngAuth             `json:"ConnectionProfileManagement,omitempty"`
	RunasDefinitionManagement   []RunasDefinitionAuth   `json:"RunasDefinitionManagement,omitempty"`
}

type RoleDataFull ¶

type RoleDataFull struct {
	// can overwrtie existing role
	Overwrite bool `json:"Overwrite,omitempty"`
	// organization groups
	OrganizationGroups []string  `json:"OrganizationGroups,omitempty"`
	RoleData           *RoleData `json:"RoleData,omitempty"`
}

type RoleHeader ¶

type RoleHeader struct {
	// role name
	Name string `json:"name,omitempty"`
	// role description
	Description string `json:"description,omitempty"`
}

type RuleCriteria ¶

type RuleCriteria struct {
	// Rule parameters fields can be one of the options - ctm, type, jobName, jobType, application, subApplication, jobStatus, folder and library. HIDDEN.
	Field      string   `json:"field,omitempty"`
	Criteria   string   `json:"criteria,omitempty"`
	Exceptions []string `json:"exceptions,omitempty"`
}

type RuleProjection ¶

type RuleProjection struct {
	Description          string           `json:"description,omitempty"`
	LastUpdatedTimestamp int64            `json:"lastUpdatedTimestamp,omitempty"`
	Name                 string           `json:"name,omitempty"`
	Priority             int32            `json:"priority,omitempty"`
	SearchTags           []SearchTagTuple `json:"searchTags,omitempty"`
	Status               string           `json:"status,omitempty"`
}

type RuleStatistics ¶

type RuleStatistics struct {
	RuleName      string `json:"ruleName,omitempty"`
	Retention     int32  `json:"retention,omitempty"`
	RetentionType string `json:"retentionType,omitempty"`
	OldestItem    string `json:"oldestItem,omitempty"`
	NewestItem    string `json:"newestItem,omitempty"`
	TotalJobs     int32  `json:"totalJobs,omitempty"`
	DataSize      string `json:"dataSize,omitempty"`
}

type RulesStatisticList ¶

type RulesStatisticList struct {
	RuleStatistics []RuleStatistics `json:"ruleStatistics,omitempty"`
}

type RulesStatisticListSummary ¶

type RulesStatisticListSummary struct {
	RulesStatisticList *RulesStatisticList `json:"rulesStatisticList,omitempty"`
	Summary            *Summary            `json:"summary,omitempty"`
}

type RunApiActivateWorkloadPolicyOpts ¶

type RunApiActivateWorkloadPolicyOpts struct {
	Ctm    optional.String
	Server optional.String
}

type RunApiDeactivateWorkloadPolicyOpts ¶

type RunApiDeactivateWorkloadPolicyOpts struct {
	Ctm    optional.String
	Server optional.String
}

type RunApiGetEventsOpts ¶

type RunApiGetEventsOpts struct {
	Ctm    optional.String
	Server optional.String
	Name   optional.String
	Date   optional.String
	Limit  optional.Int64
}

type RunApiGetJobOutputOpts ¶

type RunApiGetJobOutputOpts struct {
	RunNo optional.Int64
}

type RunApiGetJobsStatusByFilterOpts ¶

type RunApiGetJobsStatusByFilterOpts struct {
	Limit             optional.Int64
	Jobname           optional.String
	Ctm               optional.String
	Server            optional.String
	Application       optional.String
	SubApplication    optional.String
	Host              optional.String
	Status            optional.String
	Folder            optional.String
	Description       optional.String
	Jobid             optional.String
	Neighborhood      optional.String
	Depth             optional.Int32
	Direction         optional.String
	OrderDateFrom     optional.String
	OrderDateTo       optional.String
	FromTime          optional.String
	ToTime            optional.String
	FolderLibrary     optional.String
	HostGroup         optional.String
	RunAs             optional.String
	Command           optional.String
	FilePath          optional.String
	FileName          optional.String
	WorkloadPolicy    optional.String
	RuleBasedCalendar optional.String
	ResourceMutex     optional.String
	ResourceSemaphore optional.String
	ResourceLock      optional.String
	ResourcePool      optional.String
	Held              optional.Bool
	FolderHeld        optional.Bool
	Cyclic            optional.Bool
	Deleted           optional.Bool
}

type RunApiGetJobsStatusOpts ¶

type RunApiGetJobsStatusOpts struct {
	StartIndex optional.Int64
}

type RunApiGetResourcesOpts ¶

type RunApiGetResourcesOpts struct {
	Ctm    optional.String
	Server optional.String
	Name   optional.String
}

type RunApiGetWorkloadPoliciesOpts ¶

type RunApiGetWorkloadPoliciesOpts struct {
	State optional.String
}

type RunApiOrderJobsInFolderOpts ¶

type RunApiOrderJobsInFolderOpts struct {
	Body optional.Interface
}

type RunApiRerunJobOpts ¶

type RunApiRerunJobOpts struct {
	Body optional.Interface
}

type RunApiService ¶

type RunApiService service

func (*RunApiService) ActivateWorkloadPolicy ¶

func (a *RunApiService) ActivateWorkloadPolicy(ctx context.Context, policy string, localVarOptionals *RunApiActivateWorkloadPolicyOpts) (WorkloadPolicyStateList, *http.Response, error)

func (*RunApiService) AddEvent ¶

func (a *RunApiService) AddEvent(ctx context.Context, body EventParam, server string) (SuccessData, *http.Response, error)

RunApiService Add a new event. Add a new event. date may be of format MMDD, ODAT to set current controlm date, STAT to set no date. default value is ODAT.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body The defined event name.
@param server The Control-M Server hosting the event.

@return SuccessData

func (*RunApiService) AddResource ¶

func (a *RunApiService) AddResource(ctx context.Context, body ResourceParam, server string) (SuccessData, *http.Response, error)

RunApiService Add a new pool resource. Add a new pool resource.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body The defined resource name.
@param server The Control-M Server hosting the resource.

@return SuccessData

func (*RunApiService) ConfirmJob ¶

func (a *RunApiService) ConfirmJob(ctx context.Context, jobId string) (SuccessData, *http.Response, error)

RunApiService confirm a job confirm a job that waits for confirmation

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param jobId The job ID

@return SuccessData

func (*RunApiService) DeactivateWorkloadPolicy ¶

func (a *RunApiService) DeactivateWorkloadPolicy(ctx context.Context, policy string, localVarOptionals *RunApiDeactivateWorkloadPolicyOpts) (WorkloadPolicyStateList, *http.Response, error)

func (*RunApiService) DeleteEvent ¶

func (a *RunApiService) DeleteEvent(ctx context.Context, server string, name string, date string) (SuccessData, *http.Response, error)

RunApiService Delete a event. Delete a event.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param server The Control-M Server hosting the event.
@param name event name
@param date event date

@return SuccessData

func (*RunApiService) DeleteJob ¶

func (a *RunApiService) DeleteJob(ctx context.Context, jobId string) (SuccessData, *http.Response, error)

RunApiService mark job as deleted mark delete as deleted

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param jobId The job ID

@return SuccessData

func (*RunApiService) DeleteResource ¶

func (a *RunApiService) DeleteResource(ctx context.Context, server string, name string) (SuccessData, *http.Response, error)

RunApiService Delete a pool resource. Delete a pool resource.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param server The Control-M Server hosting the resource.
@param name Resource name

@return SuccessData

func (*RunApiService) FreeJob ¶

func (a *RunApiService) FreeJob(ctx context.Context, jobId string) (SuccessData, *http.Response, error)

RunApiService free an already held the job free the job

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param jobId The job ID

@return SuccessData

func (*RunApiService) GetActiveJob ¶

func (a *RunApiService) GetActiveJob(ctx context.Context, jobId string) (string, *http.Response, error)

RunApiService get active job get the active job's data by job's order ID

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param jobId The job ID

@return string

func (*RunApiService) GetActiveServices ¶

func (a *RunApiService) GetActiveServices(ctx context.Context) (ActiveServices, *http.Response, error)

RunApiService Get SLA active services Get all SLA active services

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ActiveServices

func (*RunApiService) GetEvents ¶

func (a *RunApiService) GetEvents(ctx context.Context, localVarOptionals *RunApiGetEventsOpts) ([]Event, *http.Response, error)

func (*RunApiService) GetJobLog ¶

func (a *RunApiService) GetJobLog(ctx context.Context, jobId string) (string, *http.Response, error)

RunApiService Get job's log Get the job execution log.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param jobId The job ID

@return string

func (*RunApiService) GetJobOutput ¶

func (a *RunApiService) GetJobOutput(ctx context.Context, jobId string, localVarOptionals *RunApiGetJobOutputOpts) (string, *http.Response, error)

func (*RunApiService) GetJobStatistics ¶

func (a *RunApiService) GetJobStatistics(ctx context.Context, jobId string) (Statistics, *http.Response, error)

RunApiService Get job statistics Get the statistics from a job.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param jobId The job ID

@return Statistics

func (*RunApiService) GetJobStatus ¶

func (a *RunApiService) GetJobStatus(ctx context.Context, jobId string) (JobRunStatus, *http.Response, error)

RunApiService Get status of a job Get the job status.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param jobId Job ID returned from the run status action.

@return JobRunStatus

func (*RunApiService) GetJobsStatus ¶

func (a *RunApiService) GetJobsStatus(ctx context.Context, runId string, localVarOptionals *RunApiGetJobsStatusOpts) (JobStatusResult, *http.Response, error)

func (*RunApiService) GetJobsStatusByFilter ¶

func (a *RunApiService) GetJobsStatusByFilter(ctx context.Context, localVarOptionals *RunApiGetJobsStatusByFilterOpts) (JobStatusResult, *http.Response, error)

func (*RunApiService) GetResources ¶

func (a *RunApiService) GetResources(ctx context.Context, localVarOptionals *RunApiGetResourcesOpts) ([]ResourceObj, *http.Response, error)

func (*RunApiService) GetWaitingInfo ¶

func (a *RunApiService) GetWaitingInfo(ctx context.Context, jobId string) ([]string, *http.Response, error)

RunApiService get job's waiting information get the reason why the job is in waiting status

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param jobId The job ID

@return []string

func (*RunApiService) GetWorkloadPolicies ¶

func (a *RunApiService) GetWorkloadPolicies(ctx context.Context, localVarOptionals *RunApiGetWorkloadPoliciesOpts) (WorkloadPolicyList, *http.Response, error)

func (*RunApiService) HoldJob ¶

func (a *RunApiService) HoldJob(ctx context.Context, jobId string) (SuccessData, *http.Response, error)

RunApiService hold the job so it will not start untill it is freed hold the job

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param jobId The job ID

@return SuccessData

func (*RunApiService) KillJob ¶

func (a *RunApiService) KillJob(ctx context.Context, jobId string) (SuccessData, *http.Response, error)

RunApiService Cancel running job Abort job execution.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param jobId The job ID

@return SuccessData

func (*RunApiService) ModifyJob ¶

func (a *RunApiService) ModifyJob(ctx context.Context, jobDefinitionsFile *os.File, jobId string) (SuccessData, *http.Response, error)

RunApiService Modify active job Modify active job, specified by order id according to given definitions file (JSON).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param jobDefinitionsFile
@param jobId The job ID

@return SuccessData

func (*RunApiService) OrderJobsInFolder ¶

func (a *RunApiService) OrderJobsInFolder(ctx context.Context, localVarOptionals *RunApiOrderJobsInFolderOpts) (RunResult, *http.Response, error)

func (*RunApiService) RerunJob ¶

func (a *RunApiService) RerunJob(ctx context.Context, jobId string, localVarOptionals *RunApiRerunJobOpts) (JobRunStatus, *http.Response, error)

func (*RunApiService) RunJobs ¶

func (a *RunApiService) RunJobs(ctx context.Context, jobDefinitionsFile *os.File, deployDescriptorFile *os.File, additionalConfiguration *os.File) (RunResult, *http.Response, error)

RunApiService Run jobs Run jobs according to given definitions file (JSON or zip).

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param jobDefinitionsFile
@param deployDescriptorFile
@param additionalConfiguration

@return RunResult

func (*RunApiService) RunNow ¶

func (a *RunApiService) RunNow(ctx context.Context, jobId string) (SuccessData, *http.Response, error)

RunApiService Bypass scheduling cretirias and start the job start a job immediately

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param jobId The job ID

@return SuccessData

func (*RunApiService) SetToOK ¶

func (a *RunApiService) SetToOK(ctx context.Context, jobId string) (SuccessData, *http.Response, error)

RunApiService set job end status to OK set job status to OK, post processing action

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param jobId The job ID

@return SuccessData

func (*RunApiService) UndeleteJob ¶

func (a *RunApiService) UndeleteJob(ctx context.Context, jobId string) (SuccessData, *http.Response, error)

RunApiService recover a mark for deletion job recover a mark for deletion job

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param jobId The job ID

@return SuccessData

func (*RunApiService) UpdateAlert ¶

func (a *RunApiService) UpdateAlert(ctx context.Context, body AlertParam) (SuccessData, *http.Response, error)

RunApiService Update alert. Update alert.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body File that contains the alert propery that want to be update.

@return SuccessData

func (*RunApiService) UpdateAlertStatus ¶

func (a *RunApiService) UpdateAlertStatus(ctx context.Context, body AlertStatusParam) (SuccessData, *http.Response, error)

RunApiService Update alert status. Update alert status.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body File that contains the alert status propery that want to be update.

@return SuccessData

func (*RunApiService) UpdateResource ¶

func (a *RunApiService) UpdateResource(ctx context.Context, body ResourceMax, server string, name string) (SuccessData, *http.Response, error)

RunApiService Update a pool resource. Update a pool resource.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body The defined resource name.
@param server The Control-M Server hosting the resource.
@param name Resource name

@return SuccessData

type RunAsUserData ¶

type RunAsUserData struct {
	// agent name, can ended by wildcard REQUIRED
	Agent string `json:"agent,omitempty"`
	// user name REQUIRED
	User string `json:"user,omitempty"`
	// Password
	Password string            `json:"password,omitempty"`
	Key      *RunAsUserKeyData `json:"key,omitempty"`
}

type RunAsUserDetailsData ¶

type RunAsUserDetailsData struct {
	// Password
	Password string            `json:"password,omitempty"`
	Key      *RunAsUserKeyData `json:"key,omitempty"`
}

type RunAsUserKeyData ¶

type RunAsUserKeyData struct {
	// ssh key
	Keyname string `json:"keyname,omitempty"`
	// SSH key passphrase
	Passphrase string `json:"passphrase,omitempty"`
}

type RunReport ¶

type RunReport struct {
	Name             string                  `json:"name"`
	Format           string                  `json:"format,omitempty"`
	Filters          *[]ReportFilter         `json:"filters,omitempty"`
	DateTimeSettings *ReportDateTimeSettings `json:"dateTimeSettings,omitempty"`
}

type RunReportInfo ¶

type RunReportInfo struct {
	ReportId string `json:"reportId,omitempty"`
	Name     string `json:"name,omitempty"`
	Format   string `json:"format,omitempty"`
	Status   string `json:"status,omitempty"`
	Url      string `json:"url,omitempty"`
	WebUrl   string `json:"webUrl,omitempty"`
}

type RunResult ¶

type RunResult struct {
	// An ID that identifies running jobs and can be used to track their status.
	RunId string `json:"runId"`
	// A URI that can be used to get the status of the run jobs.
	StatusURI string `json:"statusURI,omitempty"`
	// A URI to a page displaying the workflow run live.
	MonitorPageURI string `json:"monitorPageURI,omitempty"`
}

type RunasDefinitionAuth ¶

type RunasDefinitionAuth struct {
	// control-M server name
	ControlmServer string `json:"ControlmServer,omitempty"`
	// access level (full, update, browse)
	Privilege string `json:"Privilege,omitempty"`
}

type RunasUserAuth ¶

type RunasUserAuth struct {
	// control-M server name
	ControlmServer string `json:"ControlmServer,omitempty"`
	// runas user
	RunasUser string `json:"RunasUser,omitempty"`
	// HOst or host group value
	Host string `json:"Host,omitempty"`
}

type Saml2IdentityProvider ¶

type Saml2IdentityProvider struct {
	MetadataUrl                string                      `json:"metadataUrl"`
	Enabled                    bool                        `json:"enabled"`
	ServiceProviderInformation *ServiceProviderInformation `json:"serviceProviderInformation,omitempty"`
}

type SamlStatus ¶

type SamlStatus struct {
	// The value of saml mode
	Enabled bool `json:"enabled,omitempty"`
}

type Sample ¶

type Sample struct {
	Id          int64  `json:"id"`
	Title       string `json:"title"`
	Description string `json:"description,omitempty"`
}

type SearchParams ¶

type SearchParams struct {
	// The name of sthe Control-M server in which the job was ordered from. HIDDEN.
	Ctm string `json:"ctm,omitempty"`
	// The name of the job. HIDDEN.
	JobName string `json:"jobName,omitempty"`
	// The name of the application the jobs belong to. HIDDEN.
	App string `json:"app,omitempty"`
	// The name of the sub-application the jobs belong to. HIDDEN.
	SubApp string `json:"subApp,omitempty"`
	// The name of the parent folder. HIDDEN.
	Folder string `json:"folder,omitempty"`
	// The job's end status. HIDDEN.
	Status string `json:"status,omitempty"`
	// The job's library name. HIDDEN.
	Lib string `json:"lib,omitempty"`
	// Maximum archived Jobs to display. HIDDEN.
	Limit int32 `json:"limit,omitempty"`
	// Job log must contain the given phrase. HIDDEN.
	LogContains string `json:"logContains,omitempty"`
	// Job output must contain the given phrase. HIDDEN.
	OutputContains string `json:"outputContains,omitempty"`
	// Member's library. HIDDEN.
	MemLib string `json:"memLib,omitempty"`
	// Member name. HIDDEN.
	MemName string `json:"memName,omitempty"`
	// Job's node group. HIDDEN.
	NodeGroup string `json:"nodeGroup,omitempty"`
	// Job's node id (agent). HIDDEN.
	NodeId string `json:"nodeId,omitempty"`
	// Indicating a date by which will look for jobs that their order date started afterwards. Date format - YYYY-MM-DD. HIDDEN.
	FromOrderDate string `json:"fromOrderDate,omitempty"`
	// Indicating a date by which will look for jobs that their order date ended before. Date format - YYYY-MM-DD. HIDDEN.
	ToOrderDate string `json:"toOrderDate,omitempty"`
	// Job's order id. HIDDEN.
	OrderId string `json:"orderId,omitempty"`
	// Runs as (username on agent machine). HIDDEN.
	RunAs string `json:"runAs,omitempty"`
	// Job execution start date. Date format - YYYY-MM-DD. HIDDEN.
	StartDate string `json:"startDate,omitempty"`
	// Job execution end date. Date format - YYYY-MM-DD. HIDDEN.
	EndDate string `json:"endDate,omitempty"`
}

type SearchTagTuple ¶

type SearchTagTuple struct {
	Key    string   `json:"key,omitempty"`
	Values []string `json:"values,omitempty"`
}

type SecretKeyValue ¶

type SecretKeyValue struct {
	// Unique key
	Name string `json:"name"`
	// Any value in string form.
	Value string `json:"value,omitempty"`
}

type SecretValue ¶

type SecretValue struct {
	// The parameter value
	Value string `json:"value,omitempty"`
}

type SectionMetadataProperties ¶

type SectionMetadataProperties struct {
	DisplayName   string                    `json:"displayName,omitempty"`
	DisplayName1  string                    `json:"displayName1,omitempty"`
	DisplayNameID string                    `json:"displayNameID,omitempty"`
	Fields        []FieldMetadataProperties `json:"fields,omitempty"`
	Name          string                    `json:"name,omitempty"`
}

type ServiceAuth ¶

type ServiceAuth struct {
	// access level (Full, Update, Browse, None)
	Privilege string `json:"Privilege,omitempty"`
	// service name
	Name           string             `json:"Name,omitempty"`
	AllowedActions *ServiceAuthAction `json:"AllowedActions,omitempty"`
}

type ServiceAuthAction ¶

type ServiceAuthAction struct {
	// Is DrillDown allowed in service
	DrillDown bool `json:"DrillDown,omitempty"`
	// Is Run allowed in service
	Run bool `json:"Run,omitempty"`
	// Is Hold allowed in service
	Hold bool `json:"Hold,omitempty"`
	// Is Resume allowed in service
	Resume bool `json:"Resume,omitempty"`
	// Is View Orderable Service allowed in service
	ViewOrderableService bool `json:"ViewOrderableService,omitempty"`
}

type ServiceProviderInformation ¶

type ServiceProviderInformation struct {
	SingleSignOnUrl    string `json:"singleSignOnUrl,omitempty"`
	EntityID           string `json:"entityID,omitempty"`
	SigningCertificate string `json:"signingCertificate,omitempty"`
}

type SessionApiService ¶

type SessionApiService service

func (*SessionApiService) DoLogin ¶

func (a *SessionApiService) DoLogin(ctx context.Context, body LoginCredentials) (LoginResult, *http.Response, error)

SessionApiService login user to Control-M Authenticate the user with the specified password and return a token that can be used later in subsequent requests to access Control-M.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body The credentials to use for login.

@return LoginResult

func (*SessionApiService) DoLogout ¶

func (a *SessionApiService) DoLogout(ctx context.Context) (SuccessData, *http.Response, error)

SessionApiService logout user from Control-M Disconnects the user session specified by the request authentication token, and removes it from the server memory.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return SuccessData

func (*SessionApiService) UpdateMyPassword ¶

func (a *SessionApiService) UpdateMyPassword(ctx context.Context, body PasswordsObject) (SuccessData, *http.Response, error)

SessionApiService Change my password Change my password

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param body The new password.

@return SuccessData

type SetAgentParams ¶

type SetAgentParams struct {
	// parameter name
	Name string `json:"name,omitempty"`
	// parameter value
	Value string `json:"value,omitempty"`
	// parameter type
	Type_ string `json:"type,omitempty"`
}

type SetAgentParamsList ¶

type SetAgentParamsList struct {
	Parameters []SetAgentParams `json:"parameters,omitempty"`
}

type SettingKeyProperties ¶

type SettingKeyProperties struct {
	SettingCategory string `json:"settingCategory,omitempty"`
	SettingName     string `json:"settingName,omitempty"`
}

type SettingProperties ¶

type SettingProperties struct {
	// setting category property HIDDEN
	Category string `json:"category,omitempty"`
	// setting name property HIDDEN
	Name string `json:"name,omitempty"`
	// setting value property HIDDEN
	Value string `json:"value,omitempty"`
}

type SettingPropertiesObject ¶

type SettingPropertiesObject struct {
	Settings []SettingProperties `json:"settings,omitempty"`
}

type SettingsMetadataProperties ¶

type SettingsMetadataProperties struct {
	Components                        []ComponentMetaDataProperties `json:"components,omitempty"`
	Error_                            string                        `json:"error,omitempty"`
	SelectedComponentAfterActivation  string                        `json:"selectedComponentAfterActivation,omitempty"`
	SelectedComponentBeforeActivation string                        `json:"selectedComponentBeforeActivation,omitempty"`
}

type SettingsUpdateObject ¶

type SettingsUpdateObject struct {
	SettingsObj *SettingPropertiesObject `json:"SettingsObj,omitempty"`
	CompKeyType *ComponentMftKeyType     `json:"CompKeyType,omitempty"`
}

type SlaService ¶

type SlaService struct {
	// Service Name
	ServiceName string `json:"serviceName,omitempty"`
	// Status Code
	Status string `json:"status,omitempty"`
	// Status Reason
	StatusReason string `json:"statusReason,omitempty"`
	// Start Time
	StartTime string `json:"startTime,omitempty"`
	// End Time
	EndTime string `json:"endTime,omitempty"`
	// Due Time
	DueTime string `json:"dueTime,omitempty"`
	// Slack Time
	SlackTime string `json:"slackTime,omitempty"`
	// Service Order DateTime
	ServiceOrderDateTime string `json:"serviceOrderDateTime,omitempty"`
	// Control-M Order Date
	ScheduledOrderDate string `json:"scheduledOrderDate,omitempty"`
	// Service Key
	ServiceJob string `json:"serviceJob,omitempty"`
	// Service Control-M
	ServiceControlM string `json:"serviceControlM,omitempty"`
	// Priority
	Priority string `json:"priority,omitempty"`
	// User note
	Note string `json:"note,omitempty"`
	// Number of Jobs
	TotalJobs string `json:"totalJobs,omitempty"`
	// Jobs Completed
	JobsCompleted string `json:"jobsCompleted,omitempty"`
	// Jobs without statistics
	JobsWithoutStatistics string `json:"jobsWithoutStatistics,omitempty"`
	// Completion Percentage
	CompletionPercentage string `json:"completionPercentage,omitempty"`
	// Average Completion Time
	AverageCompletionTime string `json:"averageCompletionTime,omitempty"`
	// Error details
	Errors       string                  `json:"errors,omitempty"`
	StatusByJobs *SlaServiceStatusByJobs `json:"statusByJobs,omitempty"`
}

type SlaServiceStatusByJobs ¶

type SlaServiceStatusByJobs struct {
	// Executed
	Executed string `json:"executed,omitempty"`
	// Wait Condition
	WaitCondition string `json:"waitCondition,omitempty"`
	// Wait Resource
	WaitResource string `json:"waitResource,omitempty"`
	// Wait User
	WaitUser string `json:"waitUser,omitempty"`
	// Wait Host
	WaitHost string `json:"waitHost,omitempty"`
	// Wait Workload
	WaitWorkload string `json:"waitWorkload,omitempty"`
	// Completed
	Completed string `json:"completed,omitempty"`
	// Error
	Error_ string `json:"error,omitempty"`
	// Unkwown
	Unknown string `json:"unknown,omitempty"`
}

type SshKeyProperties ¶

type SshKeyProperties struct {
	// External user data REQUIRED
	KeyName string `json:"keyName,omitempty"`
	// SSH Key passphrase REQUIRED
	KeyPassphrase string `json:"keyPassphrase,omitempty"`
	// SSH Key size (default 2048)
	KeySize int32 `json:"keySize,omitempty"`
}

type Statistics ¶

type Statistics struct {
	// Statistics calendar period
	CurrentPeriod string `json:"currentPeriod,omitempty"`
	// Statistics calendar Control-M
	CalendarControlm string `json:"calendarControlm,omitempty"`
	// Statistics calendar name
	CalendarName string             `json:"calendarName,omitempty"`
	Periods      []StatisticsPeriod `json:"periods,omitempty"`
}

type StatisticsAverageInfo ¶

type StatisticsAverageInfo struct {
	// Average start time
	StartTime string `json:"startTime,omitempty"`
	// Average CPU time
	CpuTime string `json:"cpuTime,omitempty"`
	// Average time
	RunTime string `json:"runTime,omitempty"`
}

type StatisticsPeriod ¶

type StatisticsPeriod struct {
	// Period tag
	PeriodTag string             `json:"periodTag,omitempty"`
	RunInfo   *StatisticsRunInfo `json:"runInfo,omitempty"`
}

type StatisticsRunInfo ¶

type StatisticsRunInfo struct {
	AverageInfo *StatisticsAverageInfo `json:"averageInfo,omitempty"`
	Runs        []StatisticsSingleRun  `json:"runs,omitempty"`
}

type StatisticsSingleRun ¶

type StatisticsSingleRun struct {
	// job run start time
	StartTime string `json:"startTime,omitempty"`
	// job run end time
	EndTime string `json:"endTime,omitempty"`
	// job run CPU time
	CpuTime string `json:"cpuTime,omitempty"`
	// jobs run time
	RunTime string `json:"runTime,omitempty"`
	// run job id
	JobId string `json:"jobId,omitempty"`
	// job order date
	OrderDate string `json:"orderDate,omitempty"`
}

type SuccessData ¶

type SuccessData struct {
	// The success message that describes the performed action.
	Message string `json:"message,omitempty"`
}

type Summary ¶

type Summary struct {
	TotalNumberOfJobs int32  `json:"totalNumberOfJobs,omitempty"`
	TotalDataSize     string `json:"totalDataSize,omitempty"`
	ActualDbSize      string `json:"actualDbSize,omitempty"`
	DiskUsage         string `json:"diskUsage,omitempty"`
}

type SystemParameter ¶

type SystemParameter struct {
	// System parameter name
	Name string `json:"name,omitempty"`
	// System parameter value
	Value string `json:"value,omitempty"`
	// System parameter type
	Type_ string `json:"type,omitempty"`
	// System parameter description
	Description string `json:"description,omitempty"`
}

type SystemSetting ¶

type SystemSetting struct {
	Saml2IdentityProvider  *Saml2IdentityProvider `json:"saml2IdentityProvider,omitempty"`
	NewDayTime             *SystemSettingProperty `json:"newDayTime,omitempty"`
	FirstDayOfTheWeek      *SystemSettingProperty `json:"firstDayOfTheWeek,omitempty"`
	EnvironmentBannerColor *SystemSettingProperty `json:"environmentBannerColor,omitempty"`
	EnvironmentTitle       *SystemSettingProperty `json:"environmentTitle,omitempty"`
	EnvironmentDescription *SystemSettingProperty `json:"environmentDescription,omitempty"`
	EnforceSiteStandards   *SystemSettingProperty `json:"enforceSiteStandards,omitempty"`
	Strictnesslevel        *SystemSettingProperty `json:"strictnesslevel,omitempty"`
	HistoryRetentionDays   *SystemSettingProperty `json:"historyRetentionDays,omitempty"`
	Annotations            *[]string              `json:"annotations,omitempty"`
	Errors                 []ErrorData            `json:"errors,omitempty"`
}

type SystemSettingKeyValue ¶

type SystemSettingKeyValue struct {
	// Unique key
	Name string `json:"name"`
	// Any value in string form.
	Value string `json:"value"`
}

type SystemSettingProperty ¶

type SystemSettingProperty struct {
	// Any value in string form.
	Value string `json:"value"`
}

type TokenDataRequest ¶

type TokenDataRequest struct {
	// required field. HIDDEN.
	TokenName string `json:"tokenName"`
	// required field when creates token for User. HIDDEN.
	Roles []string `json:"roles,omitempty"`
	// optional field. HIDDEN.
	ExpirationDate string `json:"expirationDate,omitempty"`
	// optional field. HIDDEN.
	TokenType string `json:"tokenType,omitempty"`
}

type TokenDataResponse ¶

type TokenDataResponse struct {
	// required field. HIDDEN.
	TokenName string `json:"tokenName"`
	// required field. HIDDEN.
	TokenType string `json:"tokenType"`
	// required field. HIDDEN.
	TokenValue string `json:"tokenValue"`
	// is not provided in API Token for Agent. HIDDEN.
	User string `json:"user,omitempty"`
	// is not provided in API Token for Agent. HIDDEN.
	Roles []string `json:"roles,omitempty"`
	// optional field. HIDDEN.
	ExpirationDate string `json:"expirationDate,omitempty"`
	// transient field. HIDDEN.
	CreatedDate string `json:"createdDate,omitempty"`
	// transient field. HIDDEN.
	LastUpdatedDate string `json:"lastUpdatedDate,omitempty"`
}

type TokenList ¶

type TokenList struct {
	Tokens *[]TokenDataResponse `json:"tokens"`
}

type ToolsPrivilegeCategory ¶

type ToolsPrivilegeCategory struct {
	// CLI access level (None, Browse, Update, Full)
	Cli string `json:"Cli,omitempty"`
	// BIM Reports access level (None, Browse, Update, Full)
	BatchImpactManagerReport string `json:"BatchImpactManagerReport,omitempty"`
	// Forecast Reports access level (None, Browse, Update, Full)
	ForecastReport string `json:"ForecastReport,omitempty"`
}

type Topology ¶

type Topology struct {
	Clusters []Cluster `json:"clusters,omitempty"`
}

type UpgradeAgentInfo ¶

type UpgradeAgentInfo struct {
	// Agent name.
	Agent string `json:"agent,omitempty"`
	// Control-M name.
	Ctm string `json:"ctm,omitempty"`
	// Agent type (Agent, MFT, AppPack).
	Type_ string `json:"type,omitempty"`
	// Platform.
	Platform string `json:"platform,omitempty"`
	// From version.
	FromVersion string `json:"fromVersion,omitempty"`
	// To version.
	ToVersion string `json:"toVersion,omitempty"`
}

type UpgradeInfo ¶

type UpgradeInfo struct {
	// product type (Agent, MFT, AppPack).
	Type_ string `json:"type,omitempty"`
	// upgrade version
	Version string `json:"version,omitempty"`
}

type UpgradeNotification ¶

type UpgradeNotification struct {
	Message string `json:"message,omitempty"`
}

type UpgradeRecord ¶

type UpgradeRecord struct {
	// upgrade id
	UpgradeId string `json:"upgradeId,omitempty"`
	// Control-M name
	Ctm string `json:"ctm,omitempty"`
	// agnet name
	Agent string `json:"agent,omitempty"`
	// upgrade package type
	Package_ string `json:"package,omitempty"`
	// upgrade from version
	FromVersion string `json:"fromVersion,omitempty"`
	// upgrade to version
	ToVersion string `json:"toVersion,omitempty"`
	// activity type (Transfer, Install, Rollback)
	Activity string `json:"activity,omitempty"`
	// status tyoe (Cancel, Running Complete,TransferCompleted, Failed,Unavailable)
	Status string `json:"status,omitempty"`
	// massage
	Message string `json:"message,omitempty"`
	// creation time
	CreationTime string `json:"creationTime,omitempty"`
	// transfer start time
	TransferStartTime string `json:"transferStartTime,omitempty"`
	// transfer end time
	TransferEndTime string `json:"transferEndTime,omitempty"`
	// installation start time
	InstallStartTime string `json:"installStartTime,omitempty"`
	// installation end time
	InstallEndTime string `json:"installEndTime,omitempty"`
	// activity name
	ActivityName string `json:"activityName,omitempty"`
	// install user
	InstallUser string `json:"installUser,omitempty"`
	// notify address
	NotifyAddress string `json:"notifyAddress,omitempty"`
	// description
	Description string `json:"description,omitempty"`
}

type UpgradeRecordList ¶

type UpgradeRecordList struct {
	UpgradeRecords []UpgradeRecord `json:"upgradeRecords,omitempty"`
}

type UpgradeRequest ¶

type UpgradeRequest struct {
	// Control-M name. REQUIRED
	Ctm string `json:"ctm,omitempty"`
	// Agent name. REQUIRED
	Agent string `json:"agent,omitempty"`
	// Product type (Agent, MFT, AppPack). REQUIRED
	Type_ string `json:"type,omitempty"`
	// Target version to be installed or version that should be rollback REQUIRED
	Version string `json:"version,omitempty"`
	// Name of activity
	ActivityName string `json:"activityName,omitempty"`
	// User that will install, upgrade or uninstall HIDDEN
	InstallUser string `json:"installUser,omitempty"`
	// List of email addresses separated by semicolon HIDDEN
	NotifyAddress string `json:"notifyAddress,omitempty"`
	// Description of activity HIDDEN
	Description string `json:"description,omitempty"`
}

type UpgradeResponse ¶

type UpgradeResponse struct {
	// ID of upgrade activity
	UpgradeId string `json:"upgradeId,omitempty"`
}

type UserAdditionalProperties ¶

type UserAdditionalProperties struct {
	// List of role names
	MemberOfGroups []string            `json:"memberOfGroups,omitempty"`
	Authentication *AuthenticationData `json:"authentication,omitempty"`
	IsExternalUser bool                `json:"isExternalUser,omitempty"`
}

type UserAllowedFoldersProperties ¶

type UserAllowedFoldersProperties struct {
	AllowedFoldersNames       []string `json:"allowedFoldersNames,omitempty"`
	As2CertificateAlias       string   `json:"as2CertificateAlias,omitempty"`
	As2Id                     string   `json:"as2Id,omitempty"`
	As2PublicKeyCertificate   string   `json:"as2PublicKeyCertificate,omitempty"`
	As2TargetFolder           string   `json:"as2TargetFolder,omitempty"`
	Company                   string   `json:"company,omitempty"`
	Description               string   `json:"description,omitempty"`
	Email                     string   `json:"email,omitempty"`
	FullName                  string   `json:"fullName,omitempty"`
	HashedPassword            string   `json:"hashedPassword,omitempty"`
	IsLdapAuth                int32    `json:"isLdapAuth,omitempty"`
	Name                      string   `json:"name,omitempty"`
	PhoneNumber               string   `json:"phoneNumber,omitempty"`
	SshPublicKey              string   `json:"sshPublicKey,omitempty"`
	IsLocked                  bool     `json:"isLocked,omitempty"`
	LockReason                string   `json:"lockReason,omitempty"`
	ChangePasswordAtNextLogin bool     `json:"changePasswordAtNextLogin,omitempty"`
	PasswordNeverExpires      bool     `json:"passwordNeverExpires,omitempty"`
	LastSuccessfulLoginTime   string   `json:"lastSuccessfulLoginTime,omitempty"`
}

type UserData ¶

type UserData struct {
	// user name
	Name string `json:"Name,omitempty"`
	// user description
	Description string `json:"Description,omitempty"`
	// full user name
	FullName       string              `json:"FullName,omitempty"`
	Authentication *AuthenticationData `json:"Authentication,omitempty"`
	Roles          []string            `json:"Roles,omitempty"`
	Authorization  *RoleData           `json:"Authorization,omitempty"`
}

type UserGroupDetailsData ¶

type UserGroupDetailsData struct {
	// external users HIDDEN
	ExternalUsers []string `json:"externalUsers,omitempty"`
	// ldap groups HIDDEN
	LdapGroups []string `json:"ldapGroups,omitempty"`
}

type UserGroupPropertiesData ¶

type UserGroupPropertiesData struct {
	// user group name REQUIRED
	Name string `json:"name,omitempty"`
	// external users HIDDEN
	ExternalUsers []string `json:"externalUsers,omitempty"`
	// ldap groups HIDDEN
	LdapGroups []string `json:"ldapGroups,omitempty"`
}

type UserHeader ¶

type UserHeader struct {
	// user name
	Name string `json:"name,omitempty"`
	// full user name
	FullName string `json:"fullName,omitempty"`
	// user description
	Description string `json:"description,omitempty"`
	// user status (output only)
	Status string `json:"status,omitempty"`
	// updated date (output only)
	LastUpdated string `json:"lastUpdated,omitempty"`
	// create date (output only)
	Created string `json:"created,omitempty"`
	// list of groups user belongs to
	MemberOf []string `json:"memberOf,omitempty"`
}

type UserPassword ¶

type UserPassword struct {
	// new user password
	NewPassword string `json:"newPassword,omitempty"`
}

type UserPreferences ¶

type UserPreferences struct {
	UserPreferences []CtmNameValueSw `json:"userPreferences,omitempty"`
}

type ValidationProperties ¶

type ValidationProperties struct {
	Max                          int32                `json:"max,omitempty"`
	Min                          int32                `json:"min,omitempty"`
	RegexPattern                 string               `json:"regexPattern,omitempty"`
	RegexPatternJava             string               `json:"regexPatternJava,omitempty"`
	RegexPatternJavaScript       string               `json:"regexPatternJavaScript,omitempty"`
	RegexPatternNoMatchMessage   string               `json:"regexPatternNoMatchMessage,omitempty"`
	RegexPatternNoMatchMessageID string               `json:"regexPatternNoMatchMessageID,omitempty"`
	Required                     bool                 `json:"required,omitempty"`
	RequiredIf                   *ConditionProperties `json:"requiredIf,omitempty"`
}

type Value ¶

type Value struct {
	// The parameter value
	Value string `json:"value"`
}

type VariableNameValue ¶

type VariableNameValue struct {
	VariableName  string `json:"variable_name,omitempty"`
	VariableValue string `json:"variable_value,omitempty"`
}

type VariableNames ¶

type VariableNames struct {
	// Array of pool variables in format %%\\\\PoolName\\AUTOVarInPool. HIDDEN.
	Variables []string `json:"variables,omitempty"`
}

type Variables ¶

type Variables struct {
	// Key value map where key is pool variables in format %%\\\\PoolName\\AUTOVarInPool. HIDDEN.
	Variables []map[string]string `json:"variables,omitempty"`
}

type ViewpointManagerPrivilegeCategory ¶

type ViewpointManagerPrivilegeCategory struct {
	// Collections access level (None, Browse, Update, Full)
	Collections string `json:"Collections,omitempty"`
	// Hierarchies access level (None, Browse, Update, Full)
	Hierarchies string `json:"Hierarchies,omitempty"`
	// Filters access level (None, Browse, Update, Full)
	Filters string `json:"Filters,omitempty"`
	// Viewpoints access level (None, Browse, Update, Full)
	Viewpoints string `json:"Viewpoints,omitempty"`
}

type WarningData ¶

type WarningData struct {
	// The error message that describes the problem.
	Message string `json:"message,omitempty"`
	// An internal identifier of the error.
	Id string `json:"id,omitempty"`
	// Reference to the item this error is referring to.
	Item string `json:"item,omitempty"`
	// The file this error occurred in.
	File string `json:"file,omitempty"`
	// The number of line in the file this error occurred in.
	Line int32 `json:"line,omitempty"`
	// The number of column in the file this error occurred in.
	Col int32 `json:"col,omitempty"`
}

type WarningList ¶

type WarningList struct {
	Errors []WarningData `json:"errors,omitempty"`
}

type WarningsCollection ¶

type WarningsCollection struct {
	WarningList []string `json:"WarningList,omitempty"`
}

type WhyJobParameters ¶

type WhyJobParameters struct {
	OrderId string `json:"order_id,omitempty"`
}

type WhyJobResultItem ¶

type WhyJobResultItem struct {
	Line string `json:"line,omitempty"`
}

type WhyJobResults ¶

type WhyJobResults struct {
	CompletedStatus *ResultsStatus     `json:"completed_status,omitempty"`
	Error_          *ApiThrowable      `json:"error,omitempty"`
	From            int64              `json:"from,omitempty"`
	Results         []WhyJobResultItem `json:"results,omitempty"`
	To              int64              `json:"to,omitempty"`
}

type WorkflowInsightsStatus ¶

type WorkflowInsightsStatus struct {
	Topology         []Topology        `json:"Topology,omitempty"`
	SystemParameters []SystemParameter `json:"SystemParameters,omitempty"`
}

type WorkloadPolicy ¶

type WorkloadPolicy struct {
	// unique workload policy name
	Name string `json:"name,omitempty"`
	// workload policy state
	State string `json:"state,omitempty"`
	// workload policy order number
	OrderNo string `json:"orderNo,omitempty"`
	// workload policy update date
	LastUpdate string `json:"lastUpdate,omitempty"`
	// user which updated workload policy
	UpdatedBy string `json:"updatedBy,omitempty"`
	// workload policy description
	Description string `json:"description,omitempty"`
}

type WorkloadPolicyList ¶

type WorkloadPolicyList struct {
	WorkloadPolicies []WorkloadPolicy `json:"workloadPolicies,omitempty"`
}

type WorkloadPolicyState ¶

type WorkloadPolicyState struct {
	// unique workload policy name
	Name string `json:"name,omitempty"`
	// workload policy state
	State string `json:"state,omitempty"`
}

type WorkloadPolicyStateList ¶

type WorkloadPolicyStateList struct {
	WorkloadPolicies []WorkloadPolicyState `json:"workloadPolicies,omitempty"`
}

type WorkspaceFolder ¶

type WorkspaceFolder struct {
	FolderData string   `json:"folderData,omitempty"`
	JobsData   []string `json:"jobsData,omitempty"`
}

type WorkspaceFolders ¶

type WorkspaceFolders struct {
	Folders []WorkspaceFolder `json:"folders,omitempty"`
}

Object containing Folders for workspace

type ZooKeeper ¶

type ZooKeeper struct {
	// zookeeper Id
	ZookeeperId int32 `json:"zookeeperId,omitempty"`
	// zookeeper Server Host
	ZookeeperServerHost string `json:"zookeeperServerHost,omitempty"`
	// zookeeper Admin Server Port
	ZookeeperAdminServerPort int32 `json:"zookeeperAdminServerPort,omitempty"`
	// zookeeper Client Port
	ZookeeperClientPort int32 `json:"zookeeperClientPort,omitempty"`
	// zookeeper Leader Port
	ZookeeperLeaderPort int32 `json:"zookeeperLeaderPort,omitempty"`
	// zookeeper Leader Election Port
	ZookeeperLeaderElectionPort int32 `json:"zookeeperLeaderElectionPort,omitempty"`
}

type ZosTemplateData ¶

type ZosTemplateData struct {
	// Template name HIDDEN
	Name string `json:"name,omitempty"`
	// Record format HIDDEN
	RecordFormat string `json:"recordFormat,omitempty"`
	// Logical record length HIDDEN
	LogicalRecordLength int32 `json:"logicalRecordLength,omitempty"`
	// Block Size HIDDEN
	BlockSize int32 `json:"blockSize,omitempty"`
	// Translation table HIDDEN
	TranslationTable string `json:"translationTable,omitempty"`
	// Transfer mode HIDDEN
	TransferMode string `json:"transferMode,omitempty"`
	// Management class HIDDEN
	SmsManagmentClass string `json:"smsManagmentClass,omitempty"`
	// Allocation units HIDDEN
	AllocationUnits string `json:"allocationUnits,omitempty"`
	// Volume HIDDEN
	Volume string `json:"volume,omitempty"`
	// Unit HIDDEN
	Unit string `json:"unit,omitempty"`
	// Primary Allocation HIDDEN
	PrimaryAllocation int32 `json:"primaryAllocation,omitempty"`
	// Secondary allocation HIDDEN
	SecondaryAllocation int32 `json:"secondaryAllocation,omitempty"`
	// Data class HIDDEN
	SmsDataClass string `json:"smsDataClass,omitempty"`
	// DBCS name HIDDEN
	DbcsEncoding string `json:"dbcsEncoding,omitempty"`
	// Transfer to unique file HIDDEN
	TransferToUniqueFile bool `json:"transferToUniqueFile,omitempty"`
	// Additional options host 1 HIDDEN
	AdditionalOptionsHost1 string `json:"additionalOptionsHost1,omitempty"`
	// Additional options host 1 HIDDEN
	AdditionalOptionsHost2 string `json:"additionalOptionsHost2,omitempty"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL