saps

Creates, updates, deletes, gets or lists a saps resource.

Overview

Name	`saps`
Type	Resource
Id	`ovh.dedicated_cloud.saps`

Fields

The following fields are returned by SELECT queries:

get
list

successful operation

Name	Datatype	Description
`task_id`	`string (uuid)`	Uniquely identifies each set of pre-installation tasks. (wire: taskId)
`application_type`	`string`	Describes the type of SAP application that is being installed as part of the pre-installation tasks. (ABAP, JAVA) (wire: applicationType)
`application_version`	`string`	Describes the specific version of the SAP application that is being installed during the pre-installation process. (wire: applicationVersion)
`clean_status`	`string`	Provides the current status of the clean-up operations performed as part of the pre-installation tasks. (FAILURE, PENDING, RETRY, REVOKED, STARTED, SUCCESS) (wire: cleanStatus)
`deployment_type`	`string`	Describes the type of deployment strategy being used for the SAP installation during the pre-installation process. (Distributed, High-Availability, Standard) (wire: deploymentType)
`end_time`	`string`	Records the date and time when the pre-installation tasks were finished. (wire: endTime)
`error_message`	`string`	Contains a detailed error message if any issues or failures occurred during the execution of the pre-installation tasks. (wire: errorMessage)
`gateway_status`	`string`	Provides the current operational state of the Gateway component during the pre-installation process. (FAILURE, PENDING, RETRY, REVOKED, STARTED, SUCCESS) (wire: gatewayStatus)
`iam`	`object`	IAM resource metadata
`sap_hana_installation_status`	`string`	Provides the current operational state of the SAP HANA installation during the pre-installation process. (FAILURE, PENDING, RETRY, REVOKED, STARTED, SUCCESS) (wire: sapHanaInstallationStatus)
`sap_hana_sid`	`string`	Describes the System ID (SID) assigned to the SAP HANA instance being installed as part of the pre-installation tasks. (wire: sapHanaSid)
`sap_sid`	`string`	Describes the System ID (SID) assigned to the SAP system being installed as part of the pre-installation tasks. (wire: sapSid)
`sap_system_installation_status`	`string`	Provides the current operational state of the SAP system installation during the pre-installation process. (FAILURE, PENDING, RETRY, REVOKED, STARTED, SUCCESS) (wire: sapSystemInstallationStatus)
`start_time`	`string`	Records the date and time when the pre-installation tasks were initiated. (wire: startTime)
`status`	`string`	Provides an overview of the current overall status of the pre-installation tasks. (FAILURE, PENDING, RETRY, REVOKED, STARTED, SUCCESS)
`vm_deployment_status`	`string`	Provides the current operational state of virtual machines deployment during the pre-installation process. (FAILURE, PENDING, RETRY, REVOKED, STARTED, SUCCESS) (wire: vmDeploymentStatus)

This schema provides detailed information about the pre-installation tasks related to SAP deployments.

Name	Datatype	Description
`task_id`	`string (uuid)`	Uniquely identifies each set of pre-installation tasks. (wire: taskId)
`application_type`	`string`	Describes the type of SAP application that is being installed as part of the pre-installation tasks. (ABAP, JAVA) (wire: applicationType)
`application_version`	`string`	Describes the specific version of the SAP application that is being installed during the pre-installation process. (wire: applicationVersion)
`clean_status`	`string`	Provides the current status of the clean-up operations performed as part of the pre-installation tasks. (FAILURE, PENDING, RETRY, REVOKED, STARTED, SUCCESS) (wire: cleanStatus)
`deployment_type`	`string`	Describes the type of deployment strategy being used for the SAP installation during the pre-installation process. (Distributed, High-Availability, Standard) (wire: deploymentType)
`end_time`	`string`	Records the date and time when the pre-installation tasks were finished. (wire: endTime)
`error_message`	`string`	Contains a detailed error message if any issues or failures occurred during the execution of the pre-installation tasks. (wire: errorMessage)
`gateway_status`	`string`	Provides the current operational state of the Gateway component during the pre-installation process. (FAILURE, PENDING, RETRY, REVOKED, STARTED, SUCCESS) (wire: gatewayStatus)
`iam`	`object`	IAM resource metadata
`sap_hana_installation_status`	`string`	Provides the current operational state of the SAP HANA installation during the pre-installation process. (FAILURE, PENDING, RETRY, REVOKED, STARTED, SUCCESS) (wire: sapHanaInstallationStatus)
`sap_hana_sid`	`string`	Describes the System ID (SID) assigned to the SAP HANA instance being installed as part of the pre-installation tasks. (wire: sapHanaSid)
`sap_sid`	`string`	Describes the System ID (SID) assigned to the SAP system being installed as part of the pre-installation tasks. (wire: sapSid)
`sap_system_installation_status`	`string`	Provides the current operational state of the SAP system installation during the pre-installation process. (FAILURE, PENDING, RETRY, REVOKED, STARTED, SUCCESS) (wire: sapSystemInstallationStatus)
`start_time`	`string`	Records the date and time when the pre-installation tasks were initiated. (wire: startTime)
`status`	`string`	Provides an overview of the current overall status of the pre-installation tasks. (FAILURE, PENDING, RETRY, REVOKED, STARTED, SUCCESS)
`vm_deployment_status`	`string`	Provides the current operational state of virtual machines deployment during the pre-installation process. (FAILURE, PENDING, RETRY, REVOKED, STARTED, SUCCESS) (wire: vmDeploymentStatus)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`service_name`, `task_id`		Returns the status of the task and of each step, from virtual machine deployment to SAP installation, with an error message if a step fails.
`list`	`select`	`service_name`	`iam_tags`	Returns the pre-installation tasks of the service and their status.
`create`	`insert`	`service_name`, `application_servers`, `application_type`, `application_version`, `bucket_sources`, `cluster_name`, `datacenter_id`, `deployment_type`, `domain_name`, `firewall`, `hana_servers`, `os_update`, `passwords`, `sids`, `system_usage`		Starts a task that deploys the SAP HANA and application server virtual machines in a datacenter of the service, then installs SAP HANA and the SAP system. Only one task can run at a time on the service. To check the parameters without starting a task, use the validate endpoint.
`delete`	`delete`	`service_name`, `task_id`		Deletes the task. The virtual machines it deployed are kept.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`api_host`	`string`	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
`service_name`	`string`	Domain of the service (wire: serviceName)
`task_id`	`string (uuid)`	Task ID (wire: taskId)
`iam_tags`	`object`	Filter resources on IAM tags (wire: iamTags)

`SELECT` examples

get
list

Returns the status of the task and of each step, from virtual machine deployment to SAP installation, with an error message if a step fails.

SELECT
task_id,
application_type,
application_version,
clean_status,
deployment_type,
end_time,
error_message,
gateway_status,
iam,
sap_hana_installation_status,
sap_hana_sid,
sap_sid,
sap_system_installation_status,
start_time,
status,
vm_deployment_status
FROM ovh.dedicated_cloud.saps
WHERE service_name = '{{ service_name }}' -- required
AND task_id = '{{ task_id }}' -- required
;

Returns the pre-installation tasks of the service and their status.

SELECT
task_id,
application_type,
application_version,
clean_status,
deployment_type,
end_time,
error_message,
gateway_status,
iam,
sap_hana_installation_status,
sap_hana_sid,
sap_sid,
sap_system_installation_status,
start_time,
status,
vm_deployment_status
FROM ovh.dedicated_cloud.saps
WHERE service_name = '{{ service_name }}' -- required
AND iam_tags = '{{ iam_tags }}'
;

`INSERT` examples

create
Manifest

Starts a task that deploys the SAP HANA and application server virtual machines in a datacenter of the service, then installs SAP HANA and the SAP system. Only one task can run at a time on the service. To check the parameters without starting a task, use the validate endpoint.

INSERT INTO ovh.dedicated_cloud.saps (
application_servers,
application_type,
application_version,
bucket_backint,
bucket_sources,
cluster_name,
datacenter_id,
deployment_type,
domain_name,
firewall,
hana_servers,
logs_data_platform,
os_license,
os_update,
passwords,
service_name,
sids,
system_usage,
service_name
)
SELECT 
'{{ application_servers }}' /* required */,
'{{ application_type }}' /* required */,
'{{ application_version }}' /* required */,
'{{ bucket_backint }}',
'{{ bucket_sources }}' /* required */,
'{{ cluster_name }}' /* required */,
{{ datacenter_id }} /* required */,
'{{ deployment_type }}' /* required */,
'{{ domain_name }}' /* required */,
'{{ firewall }}' /* required */,
'{{ hana_servers }}' /* required */,
'{{ logs_data_platform }}',
'{{ os_license }}',
{{ os_update }} /* required */,
'{{ passwords }}' /* required */,
'{{ service_name }}',
'{{ sids }}' /* required */,
'{{ system_usage }}' /* required */,
'{{ service_name }}'
;

# Description fields are for documentation purposes
- name: saps
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the saps resource.
  - name: application_servers
    description: |
      An array containing the configuration details for each SAP Application Server (such as SCS, ERS, PAS, AAS) virtual machine that will be deployed.
    value:
      - datastoreName: "{{ datastoreName }}"
        gateway: "{{ gateway }}"
        instanceNumber: "{{ instanceNumber }}"
        ipAddress: "{{ ipAddress }}"
        memory: {{ memory }}
        name: "{{ name }}"
        netmask: "{{ netmask }}"
        network: "{{ network }}"
        ovaTemplate: "{{ ovaTemplate }}"
        role: "{{ role }}"
        rootPassword: "{{ rootPassword }}"
        vcpus: {{ vcpus }}
  - name: application_type
    value: "{{ application_type }}"
    description: |
      Selects the type of SAP application that will be installed, such as NetWeaver 7.50 or S/4HANA.
    valid_values: ['ABAP', 'JAVA']
  - name: application_version
    value: "{{ application_version }}"
    description: |
      Selects the specific version of the SAP application that will be deployed.
    valid_values: ['NetWeaver 7.50', 'S/4HANA 2021', 'S/4HANA 2022', 'S/4HANA 2023']
  - name: bucket_backint
    description: |
      Configuration settings for the storage bucket used by the OVHcloud Backint Agent to store SAP HANA backup files.
    value:
      accessKey: "{{ accessKey }}"
      endpoint: "{{ endpoint }}"
      id: "{{ id }}"
      secretKey: "{{ secretKey }}"
  - name: bucket_sources
    description: |
      Configuration settings for the storage bucket that contains the necessary SAP installation sources.
    value:
      accessKey: "{{ accessKey }}"
      endpoint: "{{ endpoint }}"
      id: "{{ id }}"
      secretKey: "{{ secretKey }}"
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: |
      A user-defined name for the cluster that will host the SAP environment, usually 'Cluster1'.
  - name: datacenter_id
    value: {{ datacenter_id }}
    description: |
      The unique identifier for the datacenter where the SAP environment will be deployed.
  - name: deployment_type
    value: "{{ deployment_type }}"
    description: |
      Selects the type of SAP deployment, such as Standard, Distributed or High-Availability.
    valid_values: ['Distributed', 'High-Availability', 'Standard']
  - name: domain_name
    value: "{{ domain_name }}"
    description: |
      The fully qualified domain name (FQDN) that will be used for the SAP environment.
  - name: firewall
    description: |
      Configuration settings for the firewall to protect the SAP environment.
    value:
      applicationServers: {{ applicationServers }}
      centralServices: {{ centralServices }}
      hanaDatabase: {{ hanaDatabase }}
  - name: hana_servers
    description: |
      An array containing the configuration details for each SAP HANA virtual machine that will be deployed.
    value:
      - datastoreName: "{{ datastoreName }}"
        gateway: "{{ gateway }}"
        instanceNumber: "{{ instanceNumber }}"
        ipAddress: "{{ ipAddress }}"
        memory: {{ memory }}
        name: "{{ name }}"
        netmask: "{{ netmask }}"
        network: "{{ network }}"
        ovaTemplate: "{{ ovaTemplate }}"
        rootPassword: "{{ rootPassword }}"
        thickDatastorePolicy: "{{ thickDatastorePolicy }}"
        vcpus: {{ vcpus }}
  - name: logs_data_platform
    description: |
      Configuration settings for the Logs Data Platform that will be used to collect and externalize operating system and SAP logs.
    value:
      certificate: "{{ certificate }}"
      entrypoint: "{{ entrypoint }}"
  - name: os_license
    value: "{{ os_license }}"
    description: |
      The license key or identifier for the operating system that will be used for the SAP environment.
  - name: os_update
    value: {{ os_update }}
    description: |
      A boolean value indicating whether the operating system should be updated during the pre-installation process.
  - name: passwords
    description: |
      Configuration settings for the various passwords required for the SAP environment, including database, administrator, and service accounts.
    value:
      masterSap: "{{ masterSap }}"
      masterSapHana: "{{ masterSapHana }}"
      sidadm: "{{ sidadm }}"
      system: "{{ system }}"
  - name: service_name
    value: "{{ service_name }}"
    description: |
      The name of the Hosted Private Cloud service. This field is primarily used by the OVHcloud Manager during the import process.
  - name: sids
    description: |
      Configuration settings for the System IDs (SIDs) that will be used for the SAP environment.
    value:
      sapHanaSid: "{{ sapHanaSid }}"
      sapSid: "{{ sapSid }}"
  - name: system_usage
    value: "{{ system_usage }}"
    description: |
      Selects the intended usage of the SAP system, such as custom, development, production or test.
    valid_values: ['custom', 'development', 'production', 'test']

`DELETE` examples

delete

Deletes the task. The virtual machines it deployed are kept.

DELETE FROM ovh.dedicated_cloud.saps
WHERE service_name = '{{ service_name }}' --required
AND task_id = '{{ task_id }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

DELETE examples​