blob: 1ca42f04b67c802474ce872a86cfda3de759cc88 [file]
{
"apiBase": "/client/api",
"servers": [
{
"name": "Local-Server",
"apiHost": "",
"apiBase": "/client/api"
}
],
"docBase": "http://docs.cloudstack.apache.org/en/latest",
"appTitle": "CloudStack",
"footer": "Licensed under the <a href='http://www.apache.org/licenses/' target='_blank'>Apache License</a>, Version 2.0.",
"loginTitle": "CloudStack",
"loginFavicon": "assets/logo.svg",
"loginFooter": "",
"resetPasswordFooter": "",
"logo": "assets/logo.svg",
"minilogo": "assets/mini-logo.svg",
"banner": "assets/banner.svg",
"favicon": "cloud.ico",
"error": {
"403": "assets/403.png",
"404": "assets/404.png",
"500": "assets/500.png"
},
"theme": {
"@layout-mode": "light",
"@logo-background-color": "#ffffff",
"@mini-logo-background-color": "#ffffff",
"@navigation-background-color": "#ffffff",
"@project-nav-background-color": "#001529",
"@project-nav-text-color": "rgba(255, 255, 255, 0.65)",
"@navigation-text-color": "rgba(0, 0, 0, 0.65)",
"@primary-color": "#1890ff",
"@link-color": "#1890ff",
"@link-hover-color": "#40a9ff",
"@loading-color": "#1890ff",
"@processing-color": "#1890ff",
"@success-color": "#52c41a",
"@warning-color": "#faad14",
"@error-color": "#f5222d",
"@font-size-base": "14px",
"@heading-color": "rgba(0, 0, 0, 0.85)",
"@text-color": "rgba(0, 0, 0, 0.65)",
"@text-color-secondary": "rgba(0, 0, 0, 0.45)",
"@disabled-color": "rgba(0, 0, 0, 0.25)",
"@border-color-base": "#d9d9d9",
"@border-radius-base": "4px",
"@box-shadow-base": "0 2px 8px rgba(0, 0, 0, 0.15)",
"@logo-width": "256px",
"@logo-height": "64px",
"@mini-logo-width": "80px",
"@mini-logo-height": "64px",
"@banner-width": "700px",
"@banner-height": "110px",
"@error-width": "256px",
"@error-height": "256px"
},
"keyboardOptions": {
"us": "label.standard.us.keyboard",
"uk": "label.uk.keyboard",
"fr": "label.french.azerty.keyboard",
"jp": "label.japanese.keyboard",
"sc": "label.simplified.chinese.keyboard",
"es-latam": "Spanish Latin American Keyboard"
},
"userCard": {
"enabled": true,
"title": "label.help",
"icon": "question-circle-outlined",
"links": [
{
"title": "Documentation",
"text": "CloudStack documentation website",
"link": "https://docs.cloudstack.apache.org/en/latest/",
"icon": "read-outlined"
},
{
"title": "API Documentation",
"text": "Refer to API documentation",
"link": "https://cloudstack.apache.org/api.html",
"icon": "api-outlined"
},
{
"title": "Email Support",
"text": "Join CloudStack users mailing list to seek and provide support",
"link": "mailto:users-subscribe@cloudstack.apache.org",
"icon": "mail-outlined"
},
{
"title": "Report Issue",
"text": "Submit a bug or improvement request",
"link": "https://github.com/apache/cloudstack/issues/new",
"icon": "bug-outlined"
}
]
},
"plugins": [],
"allowMakingRouterRedundant": false,
"apidocs": true,
"basicZoneEnabled": true,
"multipleServer": false,
"allowSettingTheme": true,
"displayProjectFieldOnLogin": false,
"imageSelectionInterface": "modern",
"showUserCategoryForModernImageSelection": true,
"showAllCategoryForModernImageSelection": false,
"docHelpMappings": {
"adminguide/accounts.html": "adminguide/accounts.html",
"adminguide/accounts.html#domains": "adminguide/accounts.html#domains",
"adminguide/accounts.html#keypairs": "adminguide/accounts.html#keypairs",
"adminguide/accounts.html#roles": "adminguide/accounts.html#roles",
"adminguide/accounts.html#users": "adminguide/accounts.html#users",
"adminguide/accounts.html#using-an-ldap-server-for-user-authentication": "adminguide/accounts.html#using-an-ldap-server-for-user-authentication",
"adminguide/autoscale_with_virtual_router.html": "adminguide/autoscale_with_virtual_router.html",
"adminguide/events.html": "adminguide/events.html",
"adminguide/events.html#creating-webhooks": "adminguide/events.html#creating-webhooks",
"adminguide/events.html#deleting-and-archiving-events-and-alerts": "adminguide/events.html#deleting-and-archiving-events-and-alerts",
"adminguide/extensions.html": "adminguide/extensions.html",
"adminguide/extensions.html#custom-actions": "adminguide/extensions.html#custom-actions",
"adminguide/guest_os.html#guest-os": "adminguide/guest_os.html#guest-os",
"adminguide/guest_os.html#guest-os-categories": "adminguide/guest_os.html#guest-os-categories",
"adminguide/guest_os.html#guest-os-hypervisor-mapping": "adminguide/guest_os.html#guest-os-hypervisor-mapping",
"adminguide/hosts.html#disabling-and-enabling-zones-pods-and-clusters": "adminguide/hosts.html#disabling-and-enabling-zones-pods-and-clusters",
"adminguide/hosts.html?highlight=Hypervisor%20capabilities#hypervisor-capabilities": "adminguide/hosts.html?highlight=Hypervisor%20capabilities#hypervisor-capabilities",
"adminguide/hosts.html#kvm-rolling-maintenance": "adminguide/hosts.html#kvm-rolling-maintenance",
"adminguide/hosts.html#maintaining-hypervisors-on-hosts": "adminguide/hosts.html#maintaining-hypervisors-on-hosts",
"adminguide/hosts.html#out-of-band-management": "adminguide/hosts.html#out-of-band-management",
"adminguide/hosts.html#removing-hosts": "adminguide/hosts.html#removing-hosts",
"adminguide/index.html#tuning": "adminguide/index.html#tuning",
"adminguide/kms.html#adding-an-hsm-profile": "adminguide/kms.html#adding-an-hsm-profile",
"adminguide/kms.html#creating-a-kms-key": "adminguide/kms.html#creating-a-kms-key",
"adminguide/kms.html#migrating-existing-volumes-to-kms": "adminguide/kms.html#migrating-existing-volumes-to-kms",
"adminguide/kms.html#rotating-a-kms-key": "adminguide/kms.html#rotating-a-kms-key",
"adminguide/management.html#administrator-alerts": "adminguide/management.html#administrator-alerts",
"adminguide/management.html#metrics": "adminguide/management.html#metrics",
"adminguide/management.html#reporting-cpu-sockets": "adminguide/management.html#reporting-cpu-sockets",
"adminguide/nas_plugin.html": "adminguide/nas_plugin.html",
"adminguide/networking_and_traffic.html#acl-on-private-gateway": "adminguide/networking_and_traffic.html#acl-on-private-gateway",
"adminguide/networking_and_traffic.html#adding-an-additional-guest-network": "adminguide/networking_and_traffic.html#adding-an-additional-guest-network",
"adminguide/networking_and_traffic.html#adding-a-private-gateway-to-a-vpc": "adminguide/networking_and_traffic.html#adding-a-private-gateway-to-a-vpc",
"adminguide/networking_and_traffic.html#adding-a-security-group": "adminguide/networking_and_traffic.html#adding-a-security-group",
"adminguide/networking_and_traffic.html#adding-a-virtual-private-cloud": "adminguide/networking_and_traffic.html#adding-a-virtual-private-cloud",
"adminguide/networking_and_traffic.html#advanced-zone-physical-network-configuration": "adminguide/networking_and_traffic.html#advanced-zone-physical-network-configuration",
"adminguide/networking_and_traffic.html#basic-zone-physical-network-configuration": "adminguide/networking_and_traffic.html#basic-zone-physical-network-configuration",
"adminguide/networking_and_traffic.html#configure-guest-traffic-in-an-advanced-zone": "adminguide/networking_and_traffic.html#configure-guest-traffic-in-an-advanced-zone",
"adminguide/networking_and_traffic.html#configuring-a-virtual-private-cloud": "adminguide/networking_and_traffic.html#configuring-a-virtual-private-cloud",
"adminguide/networking_and_traffic.html#configuring-network-access-control-list": "adminguide/networking_and_traffic.html#configuring-network-access-control-list",
"adminguide/networking_and_traffic.html#creating-acl-lists": "adminguide/networking_and_traffic.html#creating-acl-lists",
"adminguide/networking_and_traffic.html#creating-and-updating-a-vpn-customer-gateway": "adminguide/networking_and_traffic.html#creating-and-updating-a-vpn-customer-gateway",
"adminguide/networking_and_traffic.html#creating-an-internal-lb-rule": "adminguide/networking_and_traffic.html#creating-an-internal-lb-rule",
"adminguide/networking_and_traffic.html#creating-a-vpn-connection": "adminguide/networking_and_traffic.html#creating-a-vpn-connection",
"adminguide/networking_and_traffic.html#creating-a-vpn-gateway-for-the-vpc": "adminguide/networking_and_traffic.html#creating-a-vpn-gateway-for-the-vpc",
"adminguide/networking_and_traffic.html#enabling-or-disabling-static-nat": "adminguide/networking_and_traffic.html#enabling-or-disabling-static-nat",
"adminguide/networking_and_traffic.html#load-balancing-across-tiers": "adminguide/networking_and_traffic.html#load-balancing-across-tiers",
"adminguide/networking_and_traffic.html#releasing-an-ip-address-alloted-to-a-vpc": "adminguide/networking_and_traffic.html#releasing-an-ip-address-alloted-to-a-vpc",
"adminguide/networking_and_traffic.html#reserving-public-ip-addresses-and-vlans-for-accounts": "adminguide/networking_and_traffic.html#reserving-public-ip-addresses-and-vlans-for-accounts",
"adminguide/networking_and_traffic.html#restarting-and-removing-a-vpn-connection": "adminguide/networking_and_traffic.html#restarting-and-removing-a-vpn-connection",
"adminguide/networking_and_traffic.html#security-groups": "adminguide/networking_and_traffic.html#security-groups",
"adminguide/networking_and_traffic.html#setting-up-a-site-to-site-vpn-connection": "adminguide/networking_and_traffic.html#setting-up-a-site-to-site-vpn-connection",
"adminguide/networking_and_traffic.html#updating-and-removing-a-vpn-customer-gateway": "adminguide/networking_and_traffic.html#updating-and-removing-a-vpn-customer-gateway",
"adminguide/networking.html#creating-a-new-network-offering": "adminguide/networking.html#creating-a-new-network-offering",
"adminguide/networking.html#network-offerings": "adminguide/networking.html#network-offerings",
"adminguide/networking.html#network-service-providers": "adminguide/networking.html#network-service-providers",
"adminguide/networking/vnf_templates_appliances.html#deploying-vnf-appliances": "adminguide/networking/vnf_templates_appliances.html#deploying-vnf-appliances",
"adminguide/object_storage.html#update-bucket": "adminguide/object_storage.html#update-bucket",
"adminguide/projects.html": "adminguide/projects.html",
"adminguide/projects.html#accepting-a-membership-invitation": "adminguide/projects.html#accepting-a-membership-invitation",
"adminguide/projects.html#adding-project-members-from-the-ui": "adminguide/projects.html#adding-project-members-from-the-ui",
"adminguide/projects.html#creating-a-new-project": "adminguide/projects.html#creating-a-new-project",
"adminguide/projects.html#sending-project-membership-invitations": "adminguide/projects.html#sending-project-membership-invitations",
"adminguide/projects.html#suspending-or-deleting-a-project": "adminguide/projects.html#suspending-or-deleting-a-project",
"adminguide/reliability.html#ha-for-hosts": "adminguide/reliability.html#ha-for-hosts",
"adminguide/service_offerings.html#compute-and-disk-service-offerings": "adminguide/service_offerings.html#compute-and-disk-service-offerings",
"adminguide/service_offerings.html#creating-a-new-compute-offering": "adminguide/service_offerings.html#creating-a-new-compute-offering",
"adminguide/service_offerings.html#creating-a-new-disk-offering": "adminguide/service_offerings.html#creating-a-new-disk-offering",
"adminguide/service_offerings.html#creating-a-new-system-service-offering": "adminguide/service_offerings.html#creating-a-new-system-service-offering",
"adminguide/service_offerings.html#modifying-or-deleting-a-service-offering": "adminguide/service_offerings.html#modifying-or-deleting-a-service-offering",
"adminguide/service_offerings.html#system-service-offerings": "adminguide/service_offerings.html#system-service-offerings",
"adminguide/storage.html#creating-a-new-file-share": "adminguide/storage.html#creating-a-new-file-share",
"adminguide/storage.html#creating-a-new-volume": "adminguide/storage.html#creating-a-new-volume",
"adminguide/storage.html#id2": "adminguide/storage.html#id2",
"adminguide/storage.html#lifecycle-operations": "adminguide/storage.html#lifecycle-operations",
"adminguide/storage.html#object-storage": "adminguide/storage.html#object-storage",
"adminguide/storage.html#primary-storage": "adminguide/storage.html#primary-storage",
"adminguide/storage.html#resizing-volumes": "adminguide/storage.html#resizing-volumes",
"adminguide/storage.html#secondary-storage": "adminguide/storage.html#secondary-storage",
"adminguide/storage.html#uploading-an-existing-volume-to-a-virtual-machine": "adminguide/storage.html#uploading-an-existing-volume-to-a-virtual-machine",
"adminguide/storage.html#working-with-volumes": "adminguide/storage.html#working-with-volumes",
"adminguide/storage.html#working-with-volume-snapshots": "adminguide/storage.html#working-with-volume-snapshots",
"adminguide/systemvm.html": "adminguide/systemvm.html",
"adminguide/systemvm.html#upgrading-virtual-routers": "adminguide/systemvm.html#upgrading-virtual-routers",
"adminguide/systemvm.html#virtual-router": "adminguide/systemvm.html#virtual-router",
"adminguide/templates.html": "adminguide/templates.html",
"adminguide/templates.html#attaching-an-iso-to-a-vm": "adminguide/templates.html#attaching-an-iso-to-a-vm",
"adminguide/templates.html#exporting-templates": "adminguide/templates.html#exporting-templates",
"adminguide/templates.html#id10": "adminguide/templates.html#id10",
"adminguide/templates.html#sharing-templates-with-other-accounts-projects": "adminguide/templates.html#sharing-templates-with-other-accounts-projects",
"adminguide/templates.html#uploading-templates-and-isos-from-a-local-computer": "adminguide/templates.html#uploading-templates-and-isos-from-a-local-computer",
"adminguide/templates.html#uploading-templates-from-a-remote-http-server": "adminguide/templates.html#uploading-templates-from-a-remote-http-server",
"adminguide/templates.html#working-with-isos": "adminguide/templates.html#working-with-isos",
"adminguide/virtual_machines.html": "adminguide/virtual_machines.html",
"adminguide/virtual_machines.html#affinity-groups": "adminguide/virtual_machines.html#affinity-groups",
"adminguide/virtual_machines.html#backup-offerings": "adminguide/virtual_machines.html#backup-offerings",
"adminguide/virtual_machines.html#change-affinity-group-for-an-existing-vm": "adminguide/virtual_machines.html#change-affinity-group-for-an-existing-vm",
"adminguide/virtual_machines.html#changing-the-vm-name-os-or-group": "adminguide/virtual_machines.html#changing-the-vm-name-os-or-group",
"adminguide/virtual_machines.html#creating-a-new-affinity-group": "adminguide/virtual_machines.html#creating-a-new-affinity-group",
"adminguide/virtual_machines.html#creating-a-new-instance-from-backup": "adminguide/virtual_machines.html#creating-a-new-instance-from-backup",
"adminguide/virtual_machines.html#creating-the-ssh-keypair": "adminguide/virtual_machines.html#creating-the-ssh-keypair",
"adminguide/virtual_machines.html#creating-vm-backups": "adminguide/virtual_machines.html#creating-vm-backups",
"adminguide/virtual_machines.html#creating-vms": "adminguide/virtual_machines.html#creating-vms",
"adminguide/virtual_machines.html#delete-an-affinity-group": "adminguide/virtual_machines.html#delete-an-affinity-group",
"adminguide/virtual_machines.html#deleting-vms": "adminguide/virtual_machines.html#deleting-vms",
"adminguide/virtual_machines.html#how-to-dynamically-scale-cpu-and-ram": "adminguide/virtual_machines.html#how-to-dynamically-scale-cpu-and-ram",
"adminguide/virtual_machines.html#importing-and-unmanaging-virtual-machine": "adminguide/virtual_machines.html#importing-and-unmanaging-virtual-machine",
"adminguide/virtual_machines.html#importing-and-unmanaging-volume": "adminguide/virtual_machines.html#importing-and-unmanaging-volume",
"adminguide/virtual_machines.html#importing-backup-offerings": "adminguide/virtual_machines.html#importing-backup-offerings",
"adminguide/virtual_machines.html#moving-vms-between-hosts-manual-live-migration": "adminguide/virtual_machines.html#moving-vms-between-hosts-manual-live-migration",
"adminguide/virtual_machines.html#resetting-ssh-keys": "adminguide/virtual_machines.html#resetting-ssh-keys",
"adminguide/virtual_machines.html#resetting-userdata": "adminguide/virtual_machines.html#resetting-userdata",
"adminguide/virtual_machines.html#restoring-instance-backups": "adminguide/virtual_machines.html#restoring-instance-backups",
"adminguide/virtual_machines.html#restoring-vm-backups": "adminguide/virtual_machines.html#restoring-vm-backups",
"adminguide/virtual_machines.html#stopping-and-starting-vms": "adminguide/virtual_machines.html#stopping-and-starting-vms",
"adminguide/virtual_machines.html#user-data-and-meta-data": "adminguide/virtual_machines.html#user-data-and-meta-data",
"adminguide/virtual_machines.html#using-ssh-keys-for-authentication": "adminguide/virtual_machines.html#using-ssh-keys-for-authentication",
"adminguide/virtual_machines.html#virtual-machine-snapshots": "adminguide/virtual_machines.html#virtual-machine-snapshots",
"adminguide/webhooks.html": "adminguide/webhooks.html",
"conceptsandterminology/concepts.html#about-clusters": "conceptsandterminology/concepts.html#about-clusters",
"conceptsandterminology/concepts.html#about-hosts": "conceptsandterminology/concepts.html#about-hosts",
"conceptsandterminology/concepts.html#about-pods": "conceptsandterminology/concepts.html#about-pods",
"conceptsandterminology/concepts.html#about-zones": "conceptsandterminology/concepts.html#about-zones",
"conceptsandterminology/concepts.html#management-server-overview": "conceptsandterminology/concepts.html#management-server-overview",
"conceptsandterminology/network_setup.html#vlan-allocation-example": "conceptsandterminology/network_setup.html#vlan-allocation-example",
"installguide/configuration.html#adding-a-cluster": "installguide/configuration.html#adding-a-cluster",
"installguide/configuration.html#adding-a-host": "installguide/configuration.html#adding-a-host",
"installguide/configuration.html#adding-a-pod": "installguide/configuration.html#adding-a-pod",
"installguide/configuration.html#adding-a-zone": "installguide/configuration.html#adding-a-zone",
"installguide/configuration.html#add-object-storage": "installguide/configuration.html#add-object-storage",
"installguide/configuration.html#add-primary-storage": "installguide/configuration.html#add-primary-storage",
"installguide/configuration.html#add-secondary-storage": "installguide/configuration.html#add-secondary-storage",
"installguide/configuration.html#create-bucket": "installguide/configuration.html#create-bucket",
"plugins/cloudian-connector.html": "plugins/cloudian-connector.html",
"plugins/cloudstack-kubernetes-service.html": "plugins/cloudstack-kubernetes-service.html",
"plugins/cloudstack-kubernetes-service.html#creating-a-new-kubernetes-cluster": "plugins/cloudstack-kubernetes-service.html#creating-a-new-kubernetes-cluster",
"plugins/cloudstack-kubernetes-service.html#deleting-kubernetes-cluster": "plugins/cloudstack-kubernetes-service.html#deleting-kubernetes-cluster",
"plugins/cloudstack-kubernetes-service.html#kubernetes-supported-versions": "plugins/cloudstack-kubernetes-service.html#kubernetes-supported-versions",
"plugins/cloudstack-kubernetes-service.html#scaling-kubernetes-cluster": "plugins/cloudstack-kubernetes-service.html#scaling-kubernetes-cluster",
"plugins/cloudstack-kubernetes-service.html#starting-a-stopped-kubernetes-cluster": "plugins/cloudstack-kubernetes-service.html#starting-a-stopped-kubernetes-cluster",
"plugins/cloudstack-kubernetes-service.html#stopping-kubernetes-cluster": "plugins/cloudstack-kubernetes-service.html#stopping-kubernetes-cluster",
"plugins/cloudstack-kubernetes-service.html#upgrading-kubernetes-cluster": "plugins/cloudstack-kubernetes-service.html#upgrading-kubernetes-cluster",
"plugins/nuage-plugin.html?#optional-create-and-enable-vpc-offering": "plugins/nuage-plugin.html?#optional-create-and-enable-vpc-offering",
"plugins/nuage-plugin.html?#vpc-offerings": "plugins/nuage-plugin.html?#vpc-offerings",
"plugins/quota.html": "plugins/quota.html",
"plugins/quota.html#quota-credits": "plugins/quota.html#quota-credits",
"plugins/quota.html#quota-tariff": "plugins/quota.html#quota-tariff"
},
"notifyLatestCSVersion": true,
"showSearchFilters": true,
"announcementBanner": {
"enabled": false,
"showIcon": false,
"closable": true,
"persistDismissal": true,
"type": "info",
"message": "🤔 <strong>Sample Announcement</strong>: New Feature Available: Check out our latest dashboard improvements! <a href='/features'>Learn more</a>",
"startDate": "2025-06-01T00:00:00Z",
"endDate": "2025-07-16T00:00:00Z"
},
"defaultLanguage": "en"
}