Skip to content

dcompane/controlm_go

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages