Cloud Foundry CLI Integration Reference 25.1.x

CI Reference

Configuration Item Overview

Deployables

CI	Description
cf.ManifestModuleSpec	Description unavailable (deployable)
cf.PushAppSpec	Description unavailable (deployable)
cf.RouteSpec	Specifications for creating Route for later use
cf.ServiceSpec	Create a service instance
cf.SpaceSpec	Specification for a Cloudfoundry Space.

Deployeds

CI	Description
cf.App	Description unavailable
cf.ManifestModule	Description unavailable
cf.Route	route for later use
cf.Service	Service instance
cf.Space	cf Space.

Containers

CI	Description
cf.Organization	Description unavailable
cf.Space	cf Space.

Other Configuration Items

CI	Description
cf.App_restart	Generated type for method restart.
cf.App_scaleApp	Generated type for method scaleApp.
cf.Route_mapRoute	Generated type for method mapRoute.
cf.Service_bindRouteService	Generated type for method bindRouteService.
cf.Service_bindService	Generated type for method bindService.
cf.Service_unbindRouteService	Generated type for method unbindRouteService.
cf.Service_unbindService	Generated type for method unbindService.

Configuration Item Details

cf.App

Type Hierarchy	udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer

Description unavailable

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		appName: STRING
		Application name to be used
		buildPack: STRING
		Custom buildpack by name (e.g. my-buildpack) or Git URL (e.g. 'https://github.com/cloudfoundry/java-buildpack.git') or Git URL with a branch or tag (e.g. 'https://github.com/cloudfoundry/java-buildpack.git#v3.3.0' for 'v3.3.0' tag)
		command: STRING
		Startup command
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		disk: STRING
		Disk limit (e.g. 256M, 1024M, 1G)
		dockerImage: STRING
		Docker image to be used: [REGISTRY_HOST:PORT/]IMAGE[:TAG]
		dockerUsername: STRING
		docker username
		domain: STRING
		Specify a custom domain (e.g. private-domain.example.com, apps.internal.com) to use instead of the default domain(only for CF CLI v6)
		endpoint: STRING
		Valid path on the app for an HTTP health check. Only used when specifying healthCheckType = http(Only for CF CLI v7)
		healthCheckType: ENUM [process, port, http]
		Application health check type (Default: port, none accepted for process, http implies endpoint /)
		healthTimeout: STRING
		Time (in seconds) allowed to elapse between starting up an app and the first healthy response from the app
		hostName: STRING
		Hostname (subdomain) to use in route, defaults to app name. Not applicable only if 'hostname' value is set in route(only for CF CLI v6)
		inputVariables: MAP_STRING_STRING
		Input variables to be used in Manifest file
		memory: STRING
		Memory limit (e.g. 256M, 1024M, 1G)
		noStart: BOOLEAN
		Do not start an app after pushing
		noWait: BOOLEAN
		When used, the command exits when the one instance one process becomes healthy(Only for CF CLI v7)
		numInstances: STRING
		Number of instances
		placeholders: MAP_STRING_STRING
		A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
		route: ENUM [no-route, random-route, no-hostname, hostname]
		Specify route(no-hostname values is for CF CLI v6)
		routePath: STRING
		Path for the route(only for CF CLI v6)
		secretInputVariables: MAP_STRING_STRING
		Secret input variables to be used in Manifest file
		stack: STRING
		Stack to use (a stack is a pre-built file system, including an operating system, that can run apps)
		strategy: ENUM [rolling]
		Deployment strategy(deploy an app without incurring downtime)(Only for CF CLI v7)

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

Control task	Parameter CI	Attributes	Description
restart	cf.App_restart	delegate = jythonScript, script = cf/app/restart-app.py	No description.
scaleApp	cf.App_scaleApp	delegate = jythonScript, script = cf/app/scale-app.py	No description.
startApp		delegate = jythonScript, script = cf/app/start-app.py	No description.
stopApp		delegate = jythonScript, script = cf/app/stop-app.py	No description.

---

cf.App_restart

Type Hierarchy	udm.Parameters >> udm.BaseConfigurationItem

Generated type for method restart.

		Public properties
		noWait: BOOLEAN
		Exit when the first instance of the web process is healthy(Only for CF CLI v7)
		strategy: ENUM [rolling]
		Deployment strategy(Only for CF CLI v7, do not select for null)

---

cf.App_scaleApp

Type Hierarchy	udm.Parameters >> udm.BaseConfigurationItem

Generated type for method scaleApp.

		Public properties
		diskLim: STRING
		Disk limit (e.g. 256M, 1024M, 1G)
		instances: STRING
		Number of instances
		memLim: STRING
		Memory limit (e.g. 256M, 1024M, 1G)

---

cf.ManifestModule

Type Hierarchy	udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer

Description unavailable

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		inputVariables: MAP_STRING_STRING
		Input variables to be used in Manifest file
		manifestFileName: STRING = manifest.yml
		Either the manifest file name (if the manifest file is in the base directory of the package), or the path to the manifest file, such as 'package/app/manifest.yml'.
		placeholders: MAP_STRING_STRING
		A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
		secretInputVariables: MAP_STRING_STRING
		Secret input variables to be used in Manifest file

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

cf.ManifestModuleSpec

Type Hierarchy	udm.BaseDeployableFolderArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FolderArtifact, udm.SourceArtifact, udm.Taggable

Description unavailable (deployable)

		Public properties
		checksum: STRING
		The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
		credentials: CI<credentials.Credentials>
		Credentials of the URI.
		excludeFileNamesRegex: STRING
		Regular expression that matches file names that must be excluded from scanning
		excludeFileNamesRegexToTranscode: STRING
		A regex of file type that needs to be ignored for transcode
		fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
		Specifies file encodings in this artifact. Key: regular expression matching file names; value: character set. Character set encoding is used for placeholder replacement and transcoding files to z/OS.
		fileUri: STRING
		The URI pointing to the (remote) location of the file this artifact represents
		inputVariables: MAP_STRING_STRING
		Input variables to be used in Manifest file (map_string_string)
		isRescanned: BOOLEAN
		Indicates if the artifact has been rescanned
		manifestFileName: STRING
		Either the manifest file name (if the manifest file is in the base directory of the package), or the path to the manifest file, such as 'package/app/manifest.yml'. (string) default(manifest.yml)
		placeholders: SET_OF_STRING
		Placeholders detected in this artifact
		preScannedPlaceholders: BOOLEAN
		Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
		proxySettings: CI<credentials.ProxySettings>
		Proxy Settings for artifact location
		scanPlaceholders: BOOLEAN = true
		Whether to scan this artifact to replace placeholders when it is imported
		secretInputVariables: MAP_STRING_STRING
		Secret input variables to be used in Manifest file (map_string_string)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		textFileNamesRegexToTranscode: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
		Regular expression that matches file names of text files to transcode to EBCDIC

		Hidden properties
		textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
		Regular expression that matches file names of text files
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.
		delimiters: STRING = {{ }}
		The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter

---

cf.Organization

Type Hierarchy	udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces	udm.Container, udm.Taggable

Description unavailable

		Public properties
		apiEndpoint: STRING
		API endpoint of cloudFoundry server.
		cfHome: STRING = /usr/bin
		Location where the oc client can be found.
		cliVersion: ENUM [v6, v7] = v6
		CF CLI version
		defaultSpaceName: STRING
		Default space name use while login using cf cli
		organizationName: STRING
		Organization name on cloudFoundry server.
		password: STRING
		Password
		username: STRING
		Username
		ignoreSsl: BOOLEAN
		If true, self signed certificates will not be checked.
		tags: SET_OF_STRING
		If set, only deployables with the same tag will be automatically mapped to this container.

		Hidden properties
		inspectionScript: STRING = cf/discovery/discover-spaces.py
		Inspection Script

Control task	Parameter CI	Attributes	Description
checkConnection		delegate = jythonScript, script = cf/check-connection.py	Check connection.
showSpaces		delegate = jythonScript, script = cf/space/list_spaces.py	No description.

---

cf.PushAppSpec

Type Hierarchy	udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.ArchiveArtifact, udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable

Description unavailable (deployable)

		Public properties
		appName: STRING
		Application name to be used (string)
		buildPack: STRING
		Custom buildpack by name (e.g. my-buildpack) or Git URL (e.g. 'https://github.com/cloudfoundry/java-buildpack.git') or Git URL with a branch or tag (e.g. 'https://github.com/cloudfoundry/java-buildpack.git#v3.3.0' for 'v3.3.0' tag) (string)
		checksum: STRING
		The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
		command: STRING
		Startup command (string)
		credentials: CI<credentials.Credentials>
		Credentials of the URI.
		disk: STRING
		Disk limit (e.g. 256M, 1024M, 1G) (string)
		dockerImage: STRING
		Docker image to be used: [REGISTRY_HOST:PORT/]IMAGE[:TAG] (string)
		dockerUsername: STRING
		docker username (string)
		domain: STRING
		Specify a custom domain (e.g. private-domain.example.com, apps.internal.com) to use instead of the default domain(only for CF CLI v6) (string)
		endpoint: STRING
		Valid path on the app for an HTTP health check. Only used when specifying healthCheckType = http(Only for CF CLI v7) (string)
		excludeFileNamesRegex: STRING
		Regular expression that matches file names that must be excluded from scanning
		excludeFileNamesRegexToTranscode: STRING
		A regex of file type that needs to be ignored for transcode
		fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
		Specifies file encodings in this artifact. Key: regular expression matching file names; value: character set. Character set encoding is used for placeholder replacement and transcoding files to z/OS.
		fileUri: STRING
		The URI pointing to the (remote) location of the file this artifact represents
		healthCheckType: STRING
		Application health check type (Default: port, none accepted for process, http implies endpoint /) (enum) values(process, port, http)
		healthTimeout: STRING
		Time (in seconds) allowed to elapse between starting up an app and the first healthy response from the app (string)
		hostName: STRING
		Hostname (subdomain) to use in route, defaults to app name. Not applicable only if 'hostname' value is set in route(only for CF CLI v6) (string)
		inputVariables: MAP_STRING_STRING
		Input variables to be used in Manifest file (map_string_string)
		isRescanned: BOOLEAN
		Indicates if the artifact has been rescanned
		memory: STRING
		Memory limit (e.g. 256M, 1024M, 1G) (string)
		noStart: STRING
		Do not start an app after pushing (boolean) default(false)
		noWait: STRING
		When used, the command exits when the one instance one process becomes healthy(Only for CF CLI v7) (boolean)
		numInstances: STRING
		Number of instances (string)
		placeholders: SET_OF_STRING
		Placeholders detected in this artifact
		preScannedPlaceholders: BOOLEAN
		Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
		proxySettings: CI<credentials.ProxySettings>
		Proxy Settings for artifact location
		route: STRING
		Specify route(no-hostname values is for CF CLI v6) (enum) values(no-route, random-route, no-hostname, hostname)
		routePath: STRING
		Path for the route(only for CF CLI v6) (string)
		scanPlaceholders: BOOLEAN
		Whether to scan this artifact to replace placeholders when it is imported
		secretInputVariables: MAP_STRING_STRING
		Secret input variables to be used in Manifest file (map_string_string)
		stack: STRING
		Stack to use (a stack is a pre-built file system, including an operating system, that can run apps) (string)
		strategy: STRING
		Deployment strategy(deploy an app without incurring downtime)(Only for CF CLI v7) (enum) values(rolling)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		textFileNamesRegexToTranscode: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
		Regular expression that matches file names of text files to transcode to EBCDIC

		Hidden properties
		textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
		Regular expression that matches file names of text files
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.
		delimiters: STRING = {{ }}
		The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter

---

cf.Route

Type Hierarchy	udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

route for later use

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		routeDomain: STRING
		specify domain
		routeType: ENUM [http, tcp]
		Type of route
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		port: STRING
		Port for the TCP route (default: random port)
		routeHostname: STRING
		Hostname for the HTTP route (required for shared domains)
		routePath: STRING
		Path for the HTTP route

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

Control task	Parameter CI	Attributes	Description
mapRoute	cf.Route_mapRoute	delegate = jythonScript, script = cf/route/map-route.py	Map a route to a App

---

cf.RouteSpec

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

Specifications for creating Route for later use

		Public properties
		port: STRING
		Port for the TCP route (default: random port) (string)
		routeDomain: STRING
		specify domain (string)
		routeHostname: STRING
		Hostname for the HTTP route (required for shared domains) (string)
		routePath: STRING
		Path for the HTTP route (string)
		routeType: STRING
		Type of route (enum) values(http, tcp)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.

---

cf.Route_mapRoute

Type Hierarchy	udm.Parameters >> udm.BaseConfigurationItem

Generated type for method mapRoute.

		Public properties
		appName: STRING
		Name of the App

---

cf.Service

Type Hierarchy	udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

Service instance

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		serviceInstance: STRING
		Service instance
		broker: STRING
		Create a service instance from a particular broker. Required when service name is ambiguous
		configuration: STRING
		Valid JSON object containing service-specific configuration parameters. For a list of supported configuration parameters, see documentation for the particular service offering
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		force: BOOLEAN
		Force the upgrade to the latest available version of the service plan. It can only be used when Upgrade is true
		plan: STRING
		Plan to use
		service: STRING
		Service to use(eg. db-service)
		serviceTags: LIST_OF_STRING
		User provided tags
		upgrade: BOOLEAN
		Upgrade the service instance to the latest version of the service plan available. Cannot be given with Configuration, Plan and Tags

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

Control task	Parameter CI	Attributes	Description
bindRouteService	cf.Service_bindRouteService	delegate = jythonScript, script = cf/service/bind-route-service.py	Bind a service instance to an HTTP route
bindService	cf.Service_bindService	delegate = jythonScript, script = cf/service/bind-service.py	Bind a service instance to an app
unbindRouteService	cf.Service_unbindRouteService	delegate = jythonScript, script = cf/service/unbind-route-service.py	Unbind a service instance from an HTTP route
unbindService	cf.Service_unbindService	delegate = jythonScript, script = cf/service/unbind-service.py	Unbind a service instance from an app

---

cf.ServiceSpec

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

Create a service instance

		Public properties
		broker: STRING
		Create a service instance from a particular broker. Required when service name is ambiguous (string)
		configuration: STRING
		Valid JSON object containing service-specific configuration parameters. For a list of supported configuration parameters, see documentation for the particular service offering (string)
		force: STRING
		Force the upgrade to the latest available version of the service plan. It can only be used when Upgrade is true (boolean)
		plan: STRING
		Plan to use (string)
		service: STRING
		Service to use(eg. db-service) (string)
		serviceInstance: STRING
		Service instance (string)
		serviceTags: LIST_OF_STRING
		User provided tags (list_of_string)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		upgrade: STRING
		Upgrade the service instance to the latest version of the service plan available. Cannot be given with Configuration, Plan and Tags (boolean)

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.

---

cf.Service_bindRouteService

Type Hierarchy	udm.Parameters >> udm.BaseConfigurationItem

Generated type for method bindRouteService.

		Public properties
		domain: STRING
		domain name
		conf: STRING
		Valid JSON object containing service-specific configuration parameters. For a list of supported configuration parameters, see documentation for the particular service offering
		hostname: STRING
		Hostname used in combination with DOMAIN to specify the route to bind
		path: STRING
		Path used in combination with HOSTNAME and DOMAIN to specify the route to bind

---

cf.Service_bindService

Type Hierarchy	udm.Parameters >> udm.BaseConfigurationItem

Generated type for method bindService.

		Public properties
		appName: STRING
		Name of the App to which bind this service to
		bindingName: STRING
		Name to expose service instance to app process with (Default: service instance name)
		conf: STRING
		Valid JSON object containing service-specific configuration parameters. For a list of supported configuration parameters, see documentation for the particular service offering

---

cf.Service_unbindRouteService

Type Hierarchy	udm.Parameters >> udm.BaseConfigurationItem

Generated type for method unbindRouteService.

		Public properties
		domain: STRING
		Domain name
		hostname: STRING
		Hostname used in combination with DOMAIN to specify the route to unbind
		path: STRING
		Path used in combination with HOSTNAME and DOMAIN to specify the route to unbind

---

cf.Service_unbindService

Type Hierarchy	udm.Parameters >> udm.BaseConfigurationItem

Generated type for method unbindService.

		Public properties
		appName: STRING
		Name of the App to which bind this service to

---

cf.Space

Type Hierarchy	udm.BaseDeployedContainer >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Container, udm.Deployed, udm.EmbeddedDeployedContainer, udm.Taggable

cf Space.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		spaceName: STRING
		Space name
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		spaceQuota: STRING
		Quota to assign to the newly created space
		tags: SET_OF_STRING
		If set, only deployables with the same tag will be automatically mapped to this container.

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

cf.SpaceSpec

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

Specification for a Cloudfoundry Space.

		Public properties
		spaceName: STRING
		Space name (string)
		spaceQuota: STRING
		Quota to assign to the newly created space (string)
		tags: SET_OF_STRING
		If set, only deployables with the same tag will be automatically mapped to this container. (set_of_string)

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.

---