Create a Fortinet FortiADC machine¶
Create a Fortinet FortiADC machine so Certificate Manager - SaaS can find the Transport Layer Security (TLS) certificates your virtual servers present to clients and install renewed certificates on the appliance. Certificate Manager - SaaS connects to the FortiADC REST API through a VSatellite by using an API key.
Before you begin¶
- The System Administrator, PKI Administrator, or Resource Owner role. If you have the Resource Owner role, you must own or belong to at least one team.
- An active VSatellite that can reach the FortiADC management interface on the HTTPS management port, and the address and port of every virtual server whose certificates you want to discover. Certificate Manager - SaaS reads each certificate from the TLS connection to the virtual server that serves it.
- A FortiADC appliance running version 7.2 or later.
- The hostname or IP address of the FortiADC management interface.
- The HTTPS management port, if it isn't 443. The REST API uses the same port as the web interface.
- The API key of a FortiADC REST API administrator account. See Prepare the FortiADC.
Note
Certificate Manager - SaaS doesn't verify the certificate that the FortiADC management interface presents. The connection is still encrypted.
To prepare the FortiADC¶
Do these steps once on the FortiADC. Creating the REST API administrator account requires full administrator (super-admin) rights. The account itself needs only the access profile you create in the first step.
-
Create an access profile with these permissions:
- System: read-write. FortiADC manages certificates under this category.
- Server Load Balance: read-only. Certificate Manager - SaaS reads client SSL profiles and virtual servers but doesn't change them.
-
In System > Administrator, create a REST API administrator account, and select the access profile as its Administrator profile. When you save the account, copy the API key. The appliance doesn't show it again. For details, see Create REST API administrator users in the FortiADC documentation.
- If you turn on Restrict to trusted hosts for the account, enter the address of each VSatellite that connects to the appliance in Trusted Hosts, separated by spaces, for example
192.0.2.1/32 192.0.2.2/32. If a VSatellite address is missing, the appliance rejects the API key and Test Access fails.
If virtual domains are turned on, only a global administrator account can list them. For least privilege, create one machine for each virtual domain:
- Create a REST API administrator account for the virtual domain. Set Global Admin to No, assign the account to the virtual domain, and use the access profile from the first step.
- When you configure discovery for the machine, list the virtual domain in Virtual Domains.
A global administrator account can discover every virtual domain from one machine, but it has full administrator rights.
Note
If you regenerate the API key on the FortiADC, the previous key stops working. Update the machine's API Key in Certificate Manager - SaaS with the new key.
To create a Fortinet FortiADC machine¶
- Sign in to Certificate Manager - SaaS.
- Click Installations > Machines.
- Click New, and then select Fortinet FortiADC.
- On the Properties step, in Name, enter a name for the machine.
- For Owning Team, choose the team that owns the machine. System Administrators and PKI Administrators can choose any team. Resource Owners can choose only a team they own or belong to.
-
For VSatellite, choose a VSatellite that can reach the machine. A VSatellite that's the primary of a high availability group shows its number of active replicas, and Certificate Manager - SaaS can run the machine's operations on any healthy VSatellite in the group.
-
In Server Hostname, enter the hostname or IP address of the FortiADC management interface.
- (Optional) In Port, replace the default, 443, if the appliance's HTTPS management port was changed.
-
In API Key, enter the API key of the REST API administrator account.
Note
Certificate Manager - SaaS encrypts the credentials you enter and doesn't display them again. On the machine's Properties tab, they appear masked. To keep a stored credential when you edit the machine, leave its masked value unchanged. Keep your own secure record of the credentials in case you need them again.
-
Click Test Access. After the connection succeeds, click Continue. The Discovery step opens.
Note
A successful test confirms that the VSatellite can reach the management interface and that the appliance accepts the API key. It doesn't prove that the account can provision, because the test needs only read access to System. If the access profile is missing a write permission, the first provisioning fails with "Permission denied."
If the test fails, Certificate Manager - SaaS doesn't show the reason. The connector log on the VSatellite records it, for example that the appliance rejected the API key or that the connection timed out. Check that the hostname and port are correct, that the API key is current, that the VSatellite can reach the management interface, and, if the account is restricted to trusted hosts, that the VSatellite address is one of them. The first test after you create the machine can time out while the connector starts, with a message that the VSatellite exceeded the time limit. Click Test Access again.
-
(Optional) In Virtual Domains, enter the virtual domains to discover. If you leave it empty, discovery covers every virtual domain, which requires a global administrator account when virtual domains are turned on. If virtual domains are turned off, you can enter only
global.Note
Don't enter both
globalandroot. Therootvirtual domain also lists the global certificates, so they'd be discovered twice. -
(Optional) To skip certificates that have already expired, enable Exclude Expired Certificates. It's disabled by default.
Discovery finds only certificates that a virtual server serves
The FortiADC API doesn't return certificate content, so Certificate Manager - SaaS reads each certificate from a TLS connection to an enabled virtual server that serves it. Certificate Manager - SaaS skips certificates that no enabled virtual server serves, and certificates whose virtual server the VSatellite can't reach. It lists skipped certificates by name in the connector log on the VSatellite.
-
(Optional) To discover certificates on a schedule, enable Schedule. For Repeat every, choose Day, Week, or Month, and then in At, enter the time. For Week, select the days of the week. For Month, enter the days in Day of month. Times are in Coordinated Universal Time (UTC).
- Click Continue. The Provisioning step opens.
-
(Optional) To provision certificates on a schedule, enable Schedule. For Repeat every, choose Day, Week, or Month, and then in At, enter the time. For Week, select the days of the week. For Month, enter the days in Day of month. Times are in Coordinated Universal Time (UTC).
Scheduled provisioning pushes only certificates that are queued for deployment, such as renewed certificates, so renewals install during the window you choose.
-
Click Finish.
How discovery works¶
Each discovered installation records the certificate's virtual domain, local certificate group, intermediate CA group, client SSL profile, virtual server, and port. If a virtual server listens on more than one port, the installation records the first port it lists.
If you move a certificate to a different virtual server or client SSL profile on the appliance, the next discovery creates a new installation and marks the old one as Missing. Discovery also marks installations as Missing when:
- You turn on virtual domains on the appliance. The FortiADC moves the global objects into the
rootvirtual domain, so discovery creates new installations for them. - You limit Virtual Domains. Installations in the virtual domains you don't list are marked Missing.
Certificate Manager - SaaS doesn't remove Missing installations. Delete them in Certificate Manager - SaaS when you no longer need them.
What's next?¶
After you create the machine, provision a certificate to it. You can also run discovery on the machine at any time to track the certificates your virtual servers serve.