shared_ssl.exe: Shared SSL Service Settings

The shared_ssl.exe utility is used to configure shared SSL. Using this utility, you can perform the following tasks:

  • configure master domain settings
  • display master domain settings
  • create a shared SSL link
  • display shared SSL link settings

 

Location

%plesk_cli%

 

Usage
shared_ssl command <command> [
[<param>] <option_1> [<param>]
[<option_2> [<param>]]
... [<option_N> [<param>]]
]

Example

The following command configures the master SSL Domain and enables shared SSL on the server:

shared_ssl.exe --set-master-domain on -domain example.com

Commands
Command Parameter Description Example

--set-master-domain or -sm

on|off

Enables/Disables shared SSL and sets shared SSL master domain.

With the on parameter specified, requires -domain option.

To create shared SSL on the domain example.com:

shared_ssl.exe -sm on -domain example.com

--master-domain-info or -mi

 

Displays master domain name and status of the shared SSL service.

To determine shared SSL configuration:

shared_ssl.exe -mi

--set-link or -sl

 

Creates shared SSL link.

Requires -domain, -enabled, -virtual-dir, -target-dir, and -require-ssl options.

To create the SSL link that maps contents of the /httpdocs directory on the example.net with URL http://master-domain.com/my_dir which is accessed only through SSL:

shared_ssl.exe -sl -domain example.net -enabled true -virtual-dir my_dir2

-target-dir /httpdocs -require-ssl true

--link-info or -li

 

Displays shared SSL link settings.

Requires -domain option.

To display settings of the SSL link on example.com:

shared_ssl.exe -li -domain example.com

--help or -h

 

Displays this help page

To view help on the use of this utility:

shared_ssl.exe --help

Options
Option Parameter Description Example

-reseller

<user name>

Reseller login for which set or get master domain

To retrieve master domain for jdoe:

shared_ssl.exe -mi -reseller jdoe

-client

<user name>

Client login for which set or get master domain

To retrieve master domain for jdoe:

shared_ssl.exe -mi -client jdoe

-domain

<domain name>

Name of master domain or domain for shared SSL link

To create shared SSL on the domain example.com:

shared_ssl.exe -sm on -domain example.com

-subdomain

<domain name>

Name of subdomain for shared ssl link

To create an SSL link on my.example.com:

shared_ssl.exe -sl -domain example.com -subdomain my -enabled true -virtual-dir my_example -target-dir /httpsdocs -require-ssl false

-enabled

true|false

Enables/Disables shared ssl master domain or shared ssl link

To create the SSL link that maps contents of the /httpsdocs directory on the example.net with URL http://master-domain.com/my_dir which is accessed only through SSL:

shared_ssl.exe -sl -domain example.net -enabled true -virtual-dir my_dir2

-target-dir /httpsdocs -require-ssl true

 

-virtual-dir

<string>

Sets virtual directory name for shared ssl link

-target-dir

<string>

Sets target directory for shared ssl link

-require-ssl

true|false

Defines if a resource accepts only SSL requests or all requests