{
  "schema_version": 2,
  "id": "operate/rs/references/cli-utilities/rladmin/cluster/ocsp",
  "title": "rladmin cluster ocsp",
  "url": "https://redis.io/docs/latest/operate/rs/references/cli-utilities/rladmin/cluster/ocsp/",
  "summary": "Manages OCSP.",
  "tags": [
    "docs",
    "operate",
    "rs"
  ],
  "last_updated": "2023-12-14T15:27:49+01:00",
  "page_type": "content",
  "content_hash": "3c2529991cc5408f5328d43addaaa081d601027c6f05e25c6299fa36836bd357",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "Manages OCSP configuration and verifies the status of a server certificate maintained by a third-party [certificate authority (CA)](https://en.wikipedia.org/wiki/Certificate_authority)."
    },
    {
      "id": "ocsp-certificate_compatible",
      "title": "`ocsp certificate_compatible`",
      "role": "content",
      "text": "Checks if the proxy certificate contains an OCSP URI.\n\n[code example]"
    },
    {
      "id": "parameters",
      "title": "Parameters",
      "role": "parameters",
      "text": "None"
    },
    {
      "id": "returns",
      "title": "Returns",
      "role": "returns",
      "text": "Returns the OCSP URI if it exists. Otherwise, it returns an error."
    },
    {
      "id": "example",
      "title": "Example",
      "role": "example",
      "text": "[code example]"
    },
    {
      "id": "ocsp-config",
      "title": "`ocsp config`",
      "role": "content",
      "text": "Displays or updates OCSP configuration. Run the command without the `set` option to display the current configuration of a parameter.\n\n[code example]"
    },
    {
      "id": "parameters-1",
      "title": "Parameters",
      "role": "parameters",
      "text": "| Parameter | Type/Value | Description |\n|-----------|---------------|-------------|\n| ocsp_functionality | enabled<br></br>disabled | Enables or turns off OCSP for the cluster |\n| query_frequency | integer <nobr>(range: 60-86400)</nobr> <nobr>(default: 3600)</nobr> | The time interval in seconds between OCSP queries to check the certificate's status |\n| recovery_frequency | integer <nobr>(range: 60-86400)</nobr> <nobr>(default: 60)</nobr> | The time interval in seconds between retries after a failed query |\n| recovery_max_tries | integer <nobr>(range: 1-100)</nobr> <nobr>(default: 5)</nobr> | The number of retries before the validation query fails and invalidates the certificate |\n| responder_url | string | The OCSP server URL embedded in the proxy certificate (you cannot manually set this parameter) |\n| response_timeout | integer <nobr>(range: 1-60)</nobr> <nobr>(default: 1)</nobr> | The time interval in seconds to wait for a response before timing out |"
    },
    {
      "id": "returns-1",
      "title": "Returns",
      "role": "returns",
      "text": "If you run the `ocsp config` command without the `set` option, it displays the specified parameter's current configuration."
    },
    {
      "id": "example-1",
      "title": "Example",
      "role": "example",
      "text": "[code example]"
    },
    {
      "id": "ocsp-status",
      "title": "`ocsp status`",
      "role": "content",
      "text": "Returns the latest cached status of the certificate's OCSP response.\n\n[code example]"
    },
    {
      "id": "parameters-2",
      "title": "Parameters",
      "role": "parameters",
      "text": "None"
    },
    {
      "id": "returns-2",
      "title": "Returns",
      "role": "returns",
      "text": "Returns the latest cached status of the certificate's OCSP response."
    },
    {
      "id": "example-2",
      "title": "Example",
      "role": "example",
      "text": "[code example]"
    },
    {
      "id": "ocsp-test_certificate",
      "title": "`ocsp test_certificate`",
      "role": "content",
      "text": "Queries the OCSP server for the certificate's latest status, then caches and displays the response.\n\n[code example]"
    },
    {
      "id": "parameters-3",
      "title": "Parameters",
      "role": "parameters",
      "text": "None"
    },
    {
      "id": "returns-3",
      "title": "Returns",
      "role": "returns",
      "text": "Returns the latest status of the certificate's OCSP response."
    },
    {
      "id": "example-3",
      "title": "Example",
      "role": "example",
      "text": "[code example]"
    }
  ],
  "examples": [
    {
      "id": "ocsp-certificate_compatible-ex0",
      "language": "sh",
      "code": "rladmin cluster ocsp certificate_compatible",
      "section_id": "ocsp-certificate_compatible"
    },
    {
      "id": "example-ex0",
      "language": "sh",
      "code": "$ rladmin cluster ocsp certificate_compatible\nSuccess. OCSP URI is http://responder.ocsp.url.com",
      "section_id": "example"
    },
    {
      "id": "ocsp-config-ex0",
      "language": "sh",
      "code": "rladmin cluster ocsp config <OCSP parameter>\n        [set <value>]",
      "section_id": "ocsp-config"
    },
    {
      "id": "example-1-ex0",
      "language": "sh",
      "code": "$ rladmin cluster ocsp config recovery_frequency\nRecovery frequency of the OCSP server is 60 seconds\n$ rladmin cluster ocsp config recovery_frequency set 30\n$ rladmin cluster ocsp config recovery_frequency\nRecovery frequency of the OCSP server is 30 seconds",
      "section_id": "example-1"
    },
    {
      "id": "ocsp-status-ex0",
      "language": "sh",
      "code": "rladmin cluster ocsp status",
      "section_id": "ocsp-status"
    },
    {
      "id": "example-2-ex0",
      "language": "sh",
      "code": "$ rladmin cluster ocsp status\nOCSP certificate status is: REVOKED\nproduced_at: Wed, 22 Dec 2021 12:50:11 GMT\nresponder_url: http://responder.ocsp.url.com\nrevocation_time: Wed, 22 Dec 2021 12:50:04 GMT\nthis_update: Wed, 22 Dec 2021 12:50:11 GMT",
      "section_id": "example-2"
    },
    {
      "id": "ocsp-test_certificate-ex0",
      "language": "sh",
      "code": "rladmin cluster ocsp test_certificate",
      "section_id": "ocsp-test_certificate"
    },
    {
      "id": "example-3-ex0",
      "language": "sh",
      "code": "$ rladmin cluster ocsp test_certificate\nInitiating a query to OCSP server\n...OCSP certificate status is: REVOKED\nproduced_at: Wed, 22 Dec 2021 12:50:11 GMT\nresponder_url: http://responder.ocsp.url.com\nrevocation_time: Wed, 22 Dec 2021 12:50:04 GMT\nthis_update: Wed, 22 Dec 2021 12:50:11 GMT",
      "section_id": "example-3"
    }
  ]
}