Updating A staged director's properties
Updating a staged director's properties
Set director, IaaS, and security properties.
Note: Once a director is deployed, in the s3_blobstore_options section, only access_key and secret_key are
editable. If you do modify these, make sure to set bosh_recreate_on_next_deploy to true during the deploy of
the credentials change. You can unset this once the deploy is complete.
Request
URI
PUT
https://{opsmanager-installation}/api/v0/staged/director/properties
COPY
Request Body
PutDirectorProperties
of type(s)
application/json
Required
{
"iaas_configuration": {
"guid": "string",
"name": "string",
"additional_cloud_properties": {},
"iam_instance_profile": "string",
"security_group": "string",
"key_pair_name": "string",
"region": "string",
"disk_type": "string",
"encrypted": false,
"kms_key_arn": "string",
"require_imds_v2": false,
"vm_type_catalog_name": "string",
"secret_access_key": "string"
},
"director_configuration": {
"ntp_servers_string": "string",
"resurrector_enabled": false,
"system_metrics_runtime_enabled": false,
"director_metrics_server_enabled": false,
"director_hostname": "string",
"max_threads": 0,
"nats_max_payload_mb": 0,
"duration_overrides_enabled": false,
"ca_certificate_duration": 0,
"leaf_certificate_duration": 0,
"automatic_certificate_rotation_enabled": false,
"custom_ssh_banner": "string",
"opentsdb_ip": "string",
"director_worker_count": 0,
"post_deploy_enabled": false,
"bosh_recreate_on_next_deploy": false,
"bosh_director_recreate_on_next_deploy": false,
"bosh_recreate_persistent_disks_on_next_deploy": false,
"bosh_log_level": "string",
"blobstore_type": "string",
"local_blobstore_options": {
"enable_signed_urls": false
},
"s3_blobstore_options": {
"enable_signed_urls": false,
"credentials_source": "string",
"bucket_name": "string",
"endpoint": "string",
"access_key": "string",
"secret_key": "string",
"signature_version": "string",
"region": "string",
"backup_strategy": "string",
"backup_bucket_name": "string",
"backup_bucket_region": "string",
"url_style": "string",
"ca_cert": "string"
},
"gcs_blobstore_options": {
"bucket_name": "string",
"service_account_key": "string",
"storage_class": "string",
"backup_strategy": "string",
"backup_bucket_name": "string"
},
"retry_bosh_deploys": false,
"keep_unreachable_vms": false,
"skip_director_drain": false,
"job_configuration_on_tmpfs": false,
"database_type": "string",
"encryption": {
"keys": [
{
"provider_name": "string",
"encryption_key_name": "string",
"active": false
}
],
"providers": [
{
"name": "string",
"type": "string",
"partition": "string",
"partition_password": "string",
"client_certificate": "string",
"client_key": "string",
"servers": [
{
"host": "string",
"port": "string",
"partition_serial_number": "string",
"certificate": "string"
}
]
}
]
},
"identification_tags": {},
"external_database_options": {
"host": "string",
"port": 0,
"user": "string",
"database": "string",
"tls_enabled": false,
"tls_ca": "string",
"tls_certificate": "string",
"tls_private_key": "string"
},
"hm_pager_duty_options": {
"enabled": false,
"http_proxy": "string"
},
"hm_emailer_options": {
"enabled": false,
"port": "string",
"domain": "string",
"host": "string",
"from": "string",
"tls": false,
"smtp_user": "string"
},
"additional_ssh_users": [
{
"name": "string",
"public_key": "string",
"crypted_password": "string",
"shell": "string",
"sudo": false
}
],
"short_lived_nats_bootstrap_credentials_enabled": false
},
"dns_configuration": {
"excluded_recursors": [
"string"
],
"recursor_selection": "string",
"recursor_timeout": "string",
"handlers": [
{}
]
},
"security_configuration": {
"trusted_certificates": "string",
"generate_vm_passwords": false,
"opsmanager_root_ca_trusted_certs": false,
"clear_default_trusted_certificates_store": false
},
"syslog_configuration": {
"enabled": false,
"address": "string",
"port": "string",
"transport_protocol": "string",
"queue_size": 0,
"tls_enabled": false,
"permitted_peer": "string",
"ssl_ca_certificate": "string",
"environment": "string",
"forward_debug_logs": false,
"custom_rsyslog_configuration": "string"
}
}
iaas_configuration
Optional
iaas_configuration
director_configuration
Optional
director_configuration
dns_configuration
Optional
dns_configuration
security_configuration
Optional
security_configuration
syslog_configuration
Optional
syslog_configuration
Responses
200
OK
Returns
VerificationErrors
of type(s)
application/json
{
"status": "string",
"verification_errors": {}
}
string
status
Optional
status
object
verification_errors
Optional
verification_errors
207
Multi-Status. The action succeeded and data was persisted, but errors were returned from verifiers. The configuration may not work when deployed.
This response body class contains all of the following:
VerifierErrors ,
VerificationErrors
{
"0": "V",
"1": "e",
"2": "r",
"3": "i",
"4": "f",
"5": "i",
"6": "c",
"7": "a",
"8": "t",
"9": "i",
"10": "o",
"11": "n",
"12": "E",
"13": "r",
"14": "r",
"15": "o",
"16": "r",
"17": "s",
"18": " ",
"19": "O",
"20": "b",
"21": "j",
"22": "e",
"23": "c",
"24": "t",
"verifier_errors": [
"string"
]
}
400
Setup is not completed
Returns
RequireSetupCompleted
of type(s)
application/json
{
"errors": {
"errors": [
"string"
]
}
}
401
Unauthorized
Returns
UnauthorizedResponse
of type(s)
application/json
{
"errors": {
"errors": [
"string"
]
}
}
403
Forbidden
Returns
ForbiddenResponse
of type(s)
application/json
{
"errors": {
"errors": [
"string"
]
}
}
404
BOSH Director is staged for deletion
Returns
RequiresBoshProduct
of type(s)
application/json
{
"errors": [
"string"
]
}
422
Unprocessable Content
Returns
NestedErrorsResponseVariant
of type(s)
application/json
{
"errors": {
"errors": [
"string"
]
}
}
object
errors
Optional
errors
Code Samples
COPY
curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/api/v0/staged/director/properties