Using the Perl API
IntroductionAccess tokensACL managementApplication dependencyApplicationsApplication tier Artifact managementCatalogsChange historyCI build detailCI configurationCI jobsComponentsCredential managementCustom filtersDatabase configurationData retentionCloudBees AnalyticsDirectory provider managementDynamic environmentsEmail configuration managementEmail notifier managementEnvironmentEnvironment tierGateway and zone managementGet application environment inventoryInstalling or upgrading remote agentsJob managementMicroservicesObject tagsParameter managementPersonasPipelines and releasesPlugin managementPlugin configuration managementProcedure managementProcessProcess dependencyProcess stepProject managementProperty managementResource managementRolling deploySchedule managementService accounts for webhooksServer managementSingle sign on for SAMLSnapshotsTier mapTrigger managementUser and group managementUser profile email managementWait dependenciesWorkflow definition managementWorkflow managementWork itemsWorkspace managementMiscellaneous management
Perl API response and element glossary
IntroductionExamplesTroubleshooting
IntroductionaccesstokenaclaclentryactualparameterapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitionstringresulttagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

KerberosKeytab

2 minute readReference

createKerberosKeytab

[DEPRECATED] This API is deprecated. Create a new Kerberos keytab.

Arguments

Argument Name Type Description

kerberosKeytabName

String

The name of the kerberos keytab (Required)

content

String

The content of the kerberos keytab

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

type

String

The type of the kerberos keytab

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.createKerberosKeytab(
                kerberosKeytabName: 'test-kerberosKeytabName'
                /* optional arguments */)
▼

createKerberosKeytabEntry

[DEPRECATED] This API is deprecated. Create a new Kerberos keytab entry.

Arguments

Argument Name Type Description

kerberosKeytabName

String

The name of the kerberos keytab (Required)

domainServiceUserAccount

String

The domain service user account

encryptionKeyTypes

String array

The encryption key types

kvno

Integer

The key version number (kvno)

password

String

The user password

servicePrincipalName

String

The service principal name

validateKeytabEntry

Boolean

Validate keytab entry with directory server

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.createKerberosKeytabEntry(
                kerberosKeytabName: 'test-kerberosKeytabName'
                /* optional arguments */)
▼

deleteKerberosKeytab

[DEPRECATED] This API is deprecated. Delete a Kerberos keytab from the database.

Arguments

Argument Name Type Description

kerberosKeytabName

String

The name of the kerberos keytab (Required)

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteKerberosKeytab(
                kerberosKeytabName: 'test-kerberosKeytabName')
▼

deleteKerberosKeytabEntry

[DEPRECATED] This API is deprecated. Create a new Kerberos keytab entry.

Arguments

Argument Name Type Description

kerberosKeytabName

String

The name of the kerberos keytab (Required)

encryptionKeyTypes

String array

The encryption key types

kvno

Integer

The key version number (kvno)

servicePrincipalName

String

The service principal name

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteKerberosKeytabEntry(
                kerberosKeytabName: 'test-kerberosKeytabName'
                /* optional arguments */)
▼

getKerberosKeytab

[DEPRECATED] This API is deprecated. Retrieve a kerberos keytab by name.

Arguments

Argument Name Type Description

kerberosKeytabName

String

The name of the kerberos keytab (Required)

download

Boolean

Content file will be available to downloaded

keytabFile

String

The filename to which the keytab content will be loaded.

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.getKerberosKeytab(
                kerberosKeytabName: 'test-kerberosKeytabName'
                /* optional arguments */)
▼

getKerberosKeytabs

[DEPRECATED] This API is deprecated. Retrieve all Kerberos keytabs.

Arguments

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.getKerberosKeytabs()
▼

modifyKerberosKeytab

[DEPRECATED] This API is deprecated. Modify an existing Kerberos keytab.

Arguments

Argument Name Type Description

kerberosKeytabName

String

The name of the kerberos keytab (Required)

content

String

The content of the kerberos keytab

description

String

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

type

String

The type of the kerberos keytab

Usage

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyKerberosKeytab(
                kerberosKeytabName: 'test-kerberosKeytabName'
                /* optional arguments */)
▼
jobstep
license