Plugin Documentation

Goals available for this plugin:

Goal Description
neo-java-web:add-custom-domain Adds a custom domain to an application URL. Maps to console client command application-domains:add-custom-domain.
neo-java-web:add-ecm-tenant Adds a new tenant to a repository. Maps to console client command document-service:add-ecm-tenant.
neo-java-web:add-platform-domain Adds a platform domain (under hana.ondemand.com) on which the application will be accessed. Maps to console client command application-domains:add-platform-domain.
neo-java-web:bind-db Binds a database to a Java application via a data source. Maps to console client command persistence:bind-db.
neo-java-web:bind-domain-certificate Binds a certificate to an SSL host. The certificate must already be uploaded. Maps to console client command custom-ssl:bind-domain-certificate.
neo-java-web:bind-hana-dbms Binds a productive HANA instance to a Java application via a data source. Maps to console client command persistence:bind-hana-dbms.
neo-java-web:bind-schema Binds a schema to a Java application via a data source. Maps to console client command persistence:bind-schema.
neo-java-web:change-domain-certificate Changes a certificate of an SSL host. The certificate must already be uploaded. Maps to console client command custom-ssl:change-domain-certificate.
neo-java-web:clear-alert-recipients Clears configured alert recipients. Maps to console client command monitoring:clear-alert-recipients.
neo-java-web:clear-downtime-app Deregister downtime page from application. Maps to console client command deploy:clear-downtime-app.
neo-java-web:close-db-tunnel Closes one or all database tunnel sessions that have been opened in the background process. Maps to console client command database tunnel:close-db-tunnel.
neo-java-web:close-ssh-tunnel Closes the ssh-tunnel to the specified virtual machine. If no virtual machine ID is specified, closes all tunnels. Maps to console client command virtual machines:close-ssh-tunnel.
neo-java-web:create-account Creates a new account for the customer associated with the given account. The user you specify must belong to this account and is assigned as a member of the newly created account. Maps to console client command account:create-account.
neo-java-web:create-availability-check Creates an application availability check. Maps to console client command monitoring:create-availability-check.
neo-java-web:create-db-ase Creates an ASE database with the specified ID and settings on an ASE database system. Maps to console client command persistence:create-db-ase.
neo-java-web:create-db-hana BETA: Creates a HANA database with the specified ID and settings on a HANA database system. Maps to console client command persistence:create-db-hana.
neo-java-web:create-db-user-ase Creates a user for an ASE database. Maps to console client command persistence:create-db-user-ase.
neo-java-web:create-ecm-repository Creates a new repository. Maps to console client command document-service:create-ecm-repository.
neo-java-web:create-jmx-check Creates a JMX check and assigns it to a subaccount or application. Maps to console client command monitoring:create-jmx-check.
neo-java-web:create-schema Creates a database schema with the specified ID on a shared or dedicated database system. Maps to console client command persistence:create-schema.
neo-java-web:create-security-rule Creates security group rule. Maps to console client command virtual machines:create-security-rule.
neo-java-web:create-ssl-host Creates an SSL host for configuration of custom domains. Maps to console client command custom-ssl:create-ssl-host.
neo-java-web:create-vm Creates a new virtual machine and starts it. Maps to console client command virtual machines:create-vm.
neo-java-web:create-volume-snapshot Takes a snapshot of the file system of the specified VM volume. The operation is asynchronous. Maps to console client command virtual machines:create-volume-snapshot.
neo-java-web:delete-account Deletes the account specified by the user. Only the user who has created the account is allowed to delete it. Maps to console client command account:delete-account.
neo-java-web:delete-availability-check Deletes an application availability check. Maps to console client command monitoring:delete-availability-check.
neo-java-web:delete-db-ase Deletes the ASE database with the specified ID. Maps to console client command persistence:delete-db-ase.
neo-java-web:delete-db-hana BETA: Deletes the HANA database with the specified ID. Maps to console client command persistence:delete-db-hana.
neo-java-web:delete-db-user-ase Deletes a user from an ASE database. Maps to console client command persistence:delete-db-user-ase.
neo-java-web:delete-destination Deletes destination or keystore file from SAP Cloud Platform. Maps to console client command connectivity:delete-destination.
neo-java-web:delete-domain-certificate Deletes a certificate. Caution: cannot be undone. If the certificate is mapped to an SSL host, the certificate will be removed from the SSL host too. Maps to console client command custom-ssl:delete-domain-certificate.
neo-java-web:delete-ecm-repository Deletes a repository including the data of any tenants in the repository. Maps to console client command document-service:delete-ecm-repository.
neo-java-web:delete-hanaxs-certificates Deletes certificates that contain a specified string in the CN. Maps to console client command hanaxs-certificates:delete-hanaxs-certificates.
neo-java-web:delete-jmx-check Deletes the specified JMX check, or all JMX checks. Maps to console client command monitoring:delete-jmx-check.
neo-java-web:delete-keystore Delete keystore. Maps to console client command keystore:delete-keystore.
neo-java-web:delete-mta Deletes deployed Multi-Target Applications. Maps to console client command mta:delete-mta.
neo-java-web:delete-schema Deletes the schema with the specified ID and all related database artifacts (tables, indexes, DB user, etc.). Maps to console client command persistence:delete-schema.
neo-java-web:delete-security-rule Deletes security group rule. Maps to console client command virtual machines:delete-security-rule.
neo-java-web:delete-ssl-host Deletes an SSL host. Maps to console client command custom-ssl:delete-ssl-host.
neo-java-web:delete-vm Stops and deletes virtual machine by name or by vm-id. Maps to console client command virtual machines:delete-vm.
neo-java-web:delete-volume Deletes a specified vm volume. Maps to console client command virtual machines:delete-volume.
neo-java-web:delete-volume-snapshot Deletes a specified VM volume snapshot. Maps to console client command virtual machines:delete-volume-snapshot.
neo-java-web:deploy Deploys WARs or installable units. Maps to console client command deploy:deploy.
neo-java-web:deploy-local Deploys WAR files on a local server instance. Maps to console client command local-server:deploy-local.
neo-java-web:deploy-mta Deploys Multi-Target Application (MTA) archives. Maps to console client command mta:deploy-mta.
neo-java-web:disable Disable an application or application process for new connection requests, all active connections will be still handled. Maps to console client command deploy:disable.
neo-java-web:display-application-properties Display deployment application properties. Maps to console client command deploy:display-application-properties.
neo-java-web:display-csr Returns the certificate signing request of the given certificate. Maps to console client command custom-ssl:display-csr.
neo-java-web:display-db-info Retrieves detailed information about the database. Maps to console client command persistence:display-db-info.
neo-java-web:display-ecm-repository Returns details and settings of one repository, including tenant details. Maps to console client command document-service:display-ecm-repository.
neo-java-web:display-mta Display deployed Multi-Target Application artefacts. Maps to console client command mta:display-mta.
neo-java-web:display-schema-info Retrieves detailed information about the schema. Maps to console client command persistence:display-schema-info.
neo-java-web:display-volume-snapshot Shows details about the specified VM volume snapshot. Maps to console client command virtual machines:display-volume-snapshot.
neo-java-web:download-keystore Download keystore to a local file. Maps to console client command keystore:download-keystore.
neo-java-web:edit-ecm-repository Changes the name, key or virus scan settings of a repository. Maps to console client command document-service:edit-ecm-repository.
neo-java-web:edit-hanaxs-destination BETA: Set or clear trust store for a destination. Maps to console client command hanaxs-development:edit-hanaxs-destination.
neo-java-web:enable Enable application for new connection requests. Maps to console client command deploy:enable.
neo-java-web:generate-csr Generates and returns a certificate signing request. Maps to console client command custom-ssl:generate-csr.
neo-java-web:get-destination Downloads destination or keystore file to local file system. Maps to console client command connectivity:get-destination.
neo-java-web:get-log Downloads a particular log file. Maps to console client command logging:get-log.
neo-java-web:grant-db-access Provides another subaccount with permissions to access a database. The subaccount providing the permissions and the subaccount receiving the permissions must both be part of the same global account. Maps to console client command persistence:grant-db-access.
neo-java-web:grant-db-tunnel-access Generates a token that grants the members of another subaccount access to a database using a database tunnel. Instead of the database ID, the token is used to open the database tunnel. Maps to console client command database tunnel:grant-db-tunnel-access.
neo-java-web:grant-schema-access Grants an application in another subaccount access to a schema based on a one-time access token. The access token is used to bind the schema to the application. Maps to console client command persistence:grant-schema-access.
neo-java-web:hcmcloud-create-connection Creates and configures a connection between a Java application and the SAP SuccessFactors instance that the application extends. Maps to console client command extensions:hcmcloud-create-connection.
neo-java-web:hcmcloud-delete-connection Removes the connection between a Java application and the extended SAP SuccessFactors instance. Maps to console client command extensions:hcmcloud-delete-connection.
neo-java-web:hcmcloud-disable-application-access Disables an extension application to use SAP SuccessFactors Identity Provider for authentication by removing the application URL from Assertion Consumer Services whitelist. If an entry for the extension application does not exist in the whitelist, the command fails to execute. Maps to console client command extensions:hcmcloud-disable-application-access.
neo-java-web:hcmcloud-display-application-access-status Returns the status of the extension application's access to SAP SuccessFactors. Status is given for all extension application access point URLs. Maps to console client command extensions:hcmcloud-display-application-access-status.
neo-java-web:hcmcloud-enable-application-access Enables an extension application to use the SAP SuccessFactors Identity Provider for authentication by whitelisting the application URL in the Assertion Consumer Services. Maps to console client command extensions:hcmcloud-enable-application-access.
neo-java-web:hcmcloud-enable-role-provider Enables the SAP SuccessFactors role provider for the specified Java application. Maps to console client command extensions:hcmcloud-enable-role-provider.
neo-java-web:hcmcloud-get-registered-home-page-tiles BETA: Lists the registered SAP SuccessFactors Home Page tiles served by a specified Java or HTML5 Application. Maps to console client command extensions:hcmcloud-get-registered-home-page-tiles.
neo-java-web:hcmcloud-import-roles Imports SAP SuccessFactors HCM suite roles into the SAP SuccessFactors customer instance linked to an extension subaccount. Maps to console client command extensions:hcmcloud-import-roles.
neo-java-web:hcmcloud-list-connections Returns a list of configured connections for a specified application. Maps to console client command extensions:hcmcloud-list-connections.
neo-java-web:hcmcloud-register-home-page-tiles BETA: Registers home page tiles from a file containing tile definitions, into an SAP SuccessFactors instance linked to the specified subaccount. Maps to console client command extensions:hcmcloud-register-home-page-tiles.
neo-java-web:hcmcloud-unregister-home-page-tiles BETA: Unregisters all previously registered SAP SuccessFactors home page tiles served by the specified Java or HTML5 application. Maps to console client command extensions:hcmcloud-unregister-home-page-tiles.
neo-java-web:help Show list of available goals or an individual goal with its available parameters.
neo-java-web:hot-update Redeploys and updates the binaries of an application started on one process Caution: NOT recommended for productive applications. Maps to console client command deploy:hot-update.
neo-java-web:install-local Installs a server runtime into a local folder. Maps to console client command local-server:install-local.
neo-java-web:install-sdk Installs the SAP Cloud Platform SDK for Neo environment. By default the SDK matching this plugin version will be installed.
neo-java-web:list-accounts Lists all accounts for the customer associated with the given account. The user you specify must be a member of this account. Maps to console client command account:list-accounts.
neo-java-web:list-alert-recipients Lists configured alert recipients. Maps to console client command monitoring:list-alert-recipients.
neo-java-web:list-application-datasources Lists the data sources and their bindings to schemas and database instances for an application. Maps to console client command persistence:list-application-datasources.
neo-java-web:list-application-domains Lists all domain names on which an application can be accessed. Maps to console client command application-domains:list-application-domains.
neo-java-web:list-application-schemas Lists the data sources and their bindings to schemas and productive HANA instances for an application (deprecated: use 'list-application-datasources' instead). Maps to console client command persistence:list-application-schemas.
neo-java-web:list-applications Lists applications. Maps to console client command deploy:list-applications.
neo-java-web:list-availability-check Lists configured availability checks. Maps to console client command monitoring:list-availability-check.
neo-java-web:list-components Lists components. Maps to console client command deploy:list-components.
neo-java-web:list-custom-domain-mappings Lists custom domains configured as access points for applications in a subaccount. Maps to console client command custom-ssl:list-custom-domain-mappings.
neo-java-web:list-db-access-permissions Lists the permissions that other subaccounts have for accessing databases in the specified subaccount. Maps to console client command persistence:list-db-access-permissions.
neo-java-web:list-db-tunnel-access-grants Lists all currently active grants for database tunnel access for a specified subaccount. Maps to console client command database tunnel:list-db-tunnel-access-grants.
neo-java-web:list-dbms Lists dedicated and shared database management systems available for a subaccount. Maps to console client command persistence:list-dbms.
neo-java-web:list-dbs Lists all databases for the specified subaccount. Maps to console client command persistence:list-dbs.
neo-java-web:list-domain-certificates Lists custom domain certificates. Maps to console client command custom-ssl:list-domain-certificates.
neo-java-web:list-ecm-repositories Returns details and settings of all repositories in the specified account. Maps to console client command document-service:list-ecm-repositories.
neo-java-web:list-hanaxs-certificates List current certificates. Maps to console client command hanaxs-certificates:list-hanaxs-certificates.
neo-java-web:list-jmx-checks Lists the configured JMX checks per subaccount/application. Maps to console client command monitoring:list-jmx-checks.
neo-java-web:list-keystores List available keystores. Maps to console client command keystore:list-keystores.
neo-java-web:list-loggers Lists all available loggers with their log levels for your application. Maps to console client command logging:list-loggers.
neo-java-web:list-logs Lists all log files of your application sorted by date in a table format, starting with the latest modified. Maps to console client command logging:list-logs.
neo-java-web:list-mta-operations Shows all MTA operations started in an subaccount within the last 24 hours. Maps to console client command mta:list-mta-operations.
neo-java-web:list-mtas List all deployed Multi-Target Applications in a subaccount. Maps to console client command mta:list-mtas.
neo-java-web:list-proxy-host-mappings Lists the proxy hosts to which the specified application hostname is mapped in the specified subaccount. Maps to console client command reverse-proxy:list-proxy-host-mappings.
neo-java-web:list-runtime-versions View the application runtime versions applications can use in SAP Cloud Platform. Only recommended versions are shown by default. Maps to console client command deploy:list-runtime-versions.
neo-java-web:list-runtimes Lists supported runtimes. Maps to console client command deploy:list-runtimes.
neo-java-web:list-schema-access-grants Lists all current schema access grants for a specified subaccount. Maps to console client command persistence:list-schema-access-grants.
neo-java-web:list-schemas Lists schemas of a subaccount. Maps to console client command persistence:list-schemas.
neo-java-web:list-security-rules Lists virtual machine security group rules. Maps to console client command virtual machines:list-security-rules.
neo-java-web:list-ssh-tunnels List SSH tunnels. Maps to console client command virtual machines:list-ssh-tunnels.
neo-java-web:list-ssl-hosts Lists SSL hosts for a given subaccount. Maps to console client command custom-ssl:list-ssl-hosts.
neo-java-web:list-subscribed-accounts Lists the subscribed accounts for the given application. Maps to console client command subscriptions:list-subscribed-accounts.
neo-java-web:list-subscribed-applications Lists the subscribed applications for the given account. Maps to console client command subscriptions:list-subscribed-applications.
neo-java-web:list-vms Lists all virtual machines in the specified subaccount. You can get information for a specific virtual machine by name or vm-id. Maps to console client command virtual machines:list-vms.
neo-java-web:list-volume-snapshots Lists all VM volume snapshots in the specified subaccount. Use 'display-volume-snapshot' to get information about a specific volume snapshot. Maps to console client command virtual machines:list-volume-snapshots.
neo-java-web:list-volumes Lists all vm volumes in the specified subaccount. Maps to console client command virtual machines:list-volumes.
neo-java-web:map-proxy-host Maps an application host to an on-premise reverse proxy host and port. Maps to console client command reverse-proxy:map-proxy-host.
neo-java-web:open-db-tunnel Opens a database tunnel to the database system for the specified schema/database. Maps to console client command database tunnel:open-db-tunnel.
neo-java-web:open-ssh-tunnel Opens a secure tunnel to a specific virtual machine. Maps to console client command virtual machines:open-ssh-tunnel.
neo-java-web:put-destination Uploads destination or keystore file to SAP Cloud Platform. Maps to console client command connectivity:put-destination.
neo-java-web:reconcile-hanaxs-certificates Re-applies all already uploaded certificates to all HANA instances. Maps to console client command hanaxs-certificates:reconcile-hanaxs-certificates.
neo-java-web:register-access-point Registers an access point URL for the virtual machine specified by name or id. Maps to console client command virtual machines:register-access-point.
neo-java-web:remove-custom-domain Removes a custom domain as an access point of an application. Maps to console client command application-domains:remove-custom-domain.
neo-java-web:remove-platform-domain Removes platform domain (under hana.ondemand.com) for accessing an application. Maps to console client command application-domains:remove-platform-domain.
neo-java-web:reset-ecm-key Generates a new repository key that replaces the current one. Use this command in case you have forgotten the current repository key. Maps to console client command document-service:reset-ecm-key.
neo-java-web:reset-log-levels Resets all logger levels to their initial state. The change takes effect after application restart. Maps to console client command logging:reset-log-levels.
neo-java-web:restart Restarts an application. Maps to console client command deploy:restart.
neo-java-web:restart-hana Restarts a HANA Instance or HANA Service. Applicable for dedicated database systems only. Maps to console client command persistence:restart-hana.
neo-java-web:revoke-db-access Revokes the database access permissions given to another subaccount. Maps to console client command persistence:revoke-db-access.
neo-java-web:revoke-db-tunnel-access Revokes the database tunnel access granted to another subaccount. Maps to console client command database tunnel:revoke-db-tunnel-access.
neo-java-web:revoke-schema-access Revokes the schema access granted to an application in another subaccount. Maps to console client command persistence:revoke-schema-access.
neo-java-web:rolling-update Perform a rolling update of an application. Maps to console client command deploy:rolling-update.
neo-java-web:run-console-command Call single console client command.
neo-java-web:run-console-commands Call multiple console client commands.
neo-java-web:set-alert-recipients Sets alert recipients. Maps to console client command monitoring:set-alert-recipients.
neo-java-web:set-application-property Sets a new value for an application property. Execute the command once for each property that you want to set. Maps to console client command deploy:set-application-property.
neo-java-web:set-db-properties-ase Changes the properties for an ASE database. Maps to console client command persistence:set-db-properties-ase.
neo-java-web:set-db-properties-hana BETA: Changes HANA database properties. Maps to console client command persistence:set-db-properties-hana.
neo-java-web:set-downtime-app Set downtime page for application. Maps to console client command deploy:set-downtime-app.
neo-java-web:set-log-level Sets a log level for one or multiple loggers. Maps to console client command logging:set-log-level.
neo-java-web:set-quota Sets compute unit quotas for a given account. Maps to console client command account:set-quota.
neo-java-web:set-ssl-host Configures an SSL host. Maps to console client command custom-ssl:set-ssl-host.
neo-java-web:start Starts an application. Maps to console client command deploy:start.
neo-java-web:start-db-hana BETA: Starts the specified HANA database. Maps to console client command persistence:start-db-hana.
neo-java-web:start-local Starts a local server instance. Maps to console client command local-server:start-local.
neo-java-web:start-maintenance Start maintenance for an application. Maps to console client command deploy:start-maintenance.
neo-java-web:status Provides the status of an application. Maps to console client command deploy:status.
neo-java-web:stop Stops an application. Maps to console client command deploy:stop.
neo-java-web:stop-db-hana BETA: Stops the specified HANA database. Maps to console client command persistence:stop-db-hana.
neo-java-web:stop-local Stops a local server instance. Maps to console client command local-server:stop-local.
neo-java-web:stop-maintenance Stop maintenance for an application. Maps to console client command deploy:stop-maintenance.
neo-java-web:subscribe Subscribes an application to the given account. Maps to console client command subscriptions:subscribe.
neo-java-web:subscribe-mta Subscribes to deployed Multi-Target Applications (MTAs) available for subscription. Maps to console client command mta:subscribe-mta.
neo-java-web:unbind-db Unbinds a database from an application for a particular data source. Maps to console client command persistence:unbind-db.
neo-java-web:unbind-domain-certificate Unbinds a certificate from an SSL host. The certificate will not be deleted from SAP Cloud Platform storage. Maps to console client command custom-ssl:unbind-domain-certificate.
neo-java-web:unbind-hana-dbms Unbinds a productive HANA instance from an application for a particular data source. Maps to console client command persistence:unbind-hana-dbms.
neo-java-web:unbind-schema Unbinds a schema from an application for a particular data source. Maps to console client command persistence:unbind-schema.
neo-java-web:undeploy Undeploys an application. Maps to console client command deploy:undeploy.
neo-java-web:unmap-proxy-host Deletes the mapping between an application host and an on-premise reverse proxy host and port. Maps to console client command reverse-proxy:unmap-proxy-host.
neo-java-web:unregister-access-point Unregisters all access point URLs registered for the virtual machine specified by name or id. Maps to console client command virtual machines:unregister-access-point.
neo-java-web:unsubscribe Unsubscribes an application from the given account. Maps to console client command subscriptions:unsubscribe.
neo-java-web:upload-domain-certificate Uploads a *.pub file containing a certificate for a custom domain. The certificate must be signed using the previously generated CSR via the generate-csr command. Maps to console client command custom-ssl:upload-domain-certificate.
neo-java-web:upload-hanaxs-certificates Uploads and applies X.509 certificates to productive HANA instances. Maps to console client command hanaxs-certificates:upload-hanaxs-certificates.
neo-java-web:upload-keystore Upload keystore file. The name of the uploaded keystore will be the name of the file without the file extension. Maps to console client command keystore:upload-keystore.
neo-java-web:version Shows SDK version, runtime, JAR files, and command versions and checks for SDK updates. Maps to console client command system:version.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven 3.0.3
JDK 1.6
Memory No minimum requirement.
Disk Space No minimum requirement.

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>com.sap.cloud</groupId>
          <artifactId>neo-java-web-maven-plugin</artifactId>
          <version>1.151.13</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>com.sap.cloud</groupId>
        <artifactId>neo-java-web-maven-plugin</artifactId>
        <version>1.151.13</version>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"