polyspace-access -delete-project

Delete specified project or folder

collapse all in page

    Syntax

    polyspace-access -delete-project <projectPath> -host <hostname> [login options] [output options]

    Description

    The system command polyspace-access -delete-project deletes the specified project or folder from the Polyspace® Access™ database.

    polyspace-access -delete-project <projectPath> -host <hostname> [login options] [output options] deletes specified project or folder from the Polyspace Access Project Explorer. The project or folder is moved to the ProjectsWaitingForDeletion folder, which is visible only to users with a role of administrator. If the project is already in the ProjectsWaitingForDeletion folder, the command deletes the project entirely from the Polyspace Access database. See Delete Project Runs or Entire Projects.

    example

    Examples

    collapse all

    If you are a Polyspace Access user with a role of owner or administrator, you can delete a project without removing it permanently from the Polyspace Access database by moving the project to the ProjectsWaitingForDeletion folder. If you have the role of administrator, you can permanently delete a project and all its runs by deleting the project from the ProjectsWaitingForDeletion folder.

    From the command line, use the polyspace-access -move-project command to relocate the project.

    polyspace-access -move-project public/restrictedProject ^
-to-project-path ProjectsWaitingForDeletion/restrictedProject ^
-host example-access-server:9443

login: jsmith
password:

    Connecting to https://example-access-server:9443
Connecting as jsmith
PROJECT_MOVED public/restrictedProject TO ProjectsWaitingForDeletion/restrictedProject
Command Completed

    Use the absolute path to the project for both the source and destination. You can also move a project from the ProjectsWaitingForDeletion to restore the deleted project.

    Permanently delete a project from Polyspace Access.

    polyspace-access -delete-project ProjectsWaitingForDeletion/restrictedProject -host example-access-server:9443
login: jsmith
password:

    Connecting to https://example-access-server:9443
Connecting as jsmith
Deletion requested for project "ProjectsWaitingForDeletion/restrictedProject"
PROJECT_DELETED ProjectsWaitingForDeletion/restrictedProject
Command Completed

    Once a project is deleted from the database, you can restore the project only if you have a backup copy of the database.

    Input Arguments

    collapse all

    Manage and View Projects

    Absolute path of the project or folder, specified as a string. If the path name includes spaces, use double quotes. Specify the full path to the project or folder starting from the parent folder within Polyspace Access.

    Example: public/Folder/projectName

    Example: "topFolder/subFolder/Folder has spaces"

    Connection Configuration

    Polyspace Access machine hostname that you specify in the URL of the Polyspace Access interface, such as https://hostname:portNumber/metrics/index.html. If you are unsure about which hostname to use, contact your Polyspace Access administrator.

    You must specify a hostname with all polyspace-access commands, except the -generate-migration-commands and -encrypt-password commands.

    Example: -host myAccessServer

    Port number that you specify in the URL of the Polyspace Access interface, such as https://hostname:portNumber/metrics/index.html. If you are unsure about which port number to use, contact your Polyspace Access administrator.

    HTTP protocol used to access Polyspace Access, specified as http or https.

    Full path to the text file where you store your login credentials. Use this option if you use a command that requires your Polyspace Access credentials in a script but you do not want to store your credentials in that script. While the script runs, someone inspecting currently running processes cannot see your credentials.

    You can store only one set of credentials in the file, either as -login and -encrypted-password entries on separate lines, for instance: 

    -login jsmith
-encrypted-password LAMMMEACDMKEFELKMNDCONEAPECEEKPL
    You can also store credentials as an -api-key entry:
    -api-key keyValue123
    Make sure that the file where you store your credentials is UTF-8 encoded and that you restrict the read and write permissions on the file. For example, to restrict read and write permissions on file login.txt in Linux®, use this command:
    chmod go-rwx login.txt

    API key you use as a login credential instead of providing your login and encrypted password. To assign an API key to a user, see Configure User Manager or contact your Polyspace Access administrator.

    Use the API key if you use a command that requires your Polyspace Access login credentials as part of an automation script with a CI tool such as Jenkins®. If a user updates their password, you do not need to update the API key associated with that user in your scripts.

    It is recommended that you store the API key in a text file and pass that file to the command by using the -credentials-file option.

    Login username that you use to interact with Polyspace Access.

    Use the options -login and -encryped-password together. If you do not use these two options together, you are prompted to enter your credentials at the command line, unless you use -api-key.

    Login password you use to interact with Polyspace Access. <ENCRYPTED_PASSWORD> is the output of the polyspace-access -encrypt-password command.

    Use the options -login and -encryped-password together. If you do not use these two options together, you are prompted to enter your credentials at the command line, unless you use the -api-key option.

    Number of times the polyspace-access command retries to upload results when you upload from a client machine to the server machine that hosts Polyspace Access before failing. Specify this option to retry the upload command in the event of sporadic network outages. The command waits 10 seconds between retries.

    Full path to command outputs.

    Path to the folder for storing temporary files generated by polyspace-access commands. The default folder path depends on your platform:

    • Windows — C:\Users\%username%\AppData\Local\Temp\ps_results_server

    • Linux — tmp/ps_results_server

    File path where you store the command output log. By default the command does not generate a log file.

    Version History

    Introduced in R2019a