Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 2 additions & 0 deletions content/_index.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: Home
sorting: 1
categories: ["index"]
alias: index.html
aliases:
- "/index.html"
---

<div class="home">
Expand Down
2 changes: 2 additions & 0 deletions content/api/_index.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
layout: default
title: API
sorting: 50
aliases:
- "/api.html"
---

The CFEngine Enterprise API allows HTTP clients to interact with the
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-examples/_index.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
layout: default
title: Enterprise API examples
sorting: 6
aliases:
- "/api-enterprise-api-examples.html"
---

- [Check installation status][Checking status]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
layout: default
title: Browsing host information
sorting: 50
aliases:
- "/api-enterprise-api-examples-browsing-host-information.html"
---

A resource [/api/host][Host REST API#List hosts] is added as an alternative interface for browsing host
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
layout: default
title: Tracking changes
sorting: 50
aliases:
- "/api-enterprise-api-examples-changes-api-usage.html"
---

Changes REST API allows to track the changes made by cf-agent in the infrastructure.
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-examples/checking-status.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
layout: default
title: Checking status
sorting: 20
aliases:
- "/api-enterprise-api-examples-checking-status.html"
---

You can get basic info about the API by issuing [/api][Status and settings REST API#Get server status]. This status
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
layout: default
title: Managing settings
sorting: 30
aliases:
- "/api-enterprise-api-examples-managing-settings.html"
---

Settings support two operations, **GET** (view settings) and **POST**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
layout: default
title: Managing users and roles
sorting: 40
aliases:
- "/api-enterprise-api-examples-managing-users-and-roles.html"
---

Users and Roles determine who has access to what data from the API.
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-examples/sql-queries.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: SQL query examples
aliases:
- "/api-enterprise-api-examples-sql-queries.html"
---

### Synchronous Example: Listing hostname and IP for Ubuntu hosts
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-ref/_index.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
layout: default
title: Enterprise API reference
sorting: 70
aliases:
- "/api-enterprise-api-ref.html"
---

The Enterprise API is a conventional REST API in the sense that it has a
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-ref/actions-api.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: Actions API
aliases:
- "/api-enterprise-api-ref-actions-api.html"
---

Actions API enables you to perform specific actions such a requesting report collection.
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-ref/audit-logs-api.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: Audit log API
aliases:
- "/api-enterprise-api-ref-audit-logs-api.html"
---

Audit log API provides access to system audit logs that track user actions across the platform made to critical parts
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-ref/build-api.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: Build API
aliases:
- "/api-enterprise-api-ref-build-api.html"
---

The Build API enables you to easily manage policy projects and their respective CFEngine Build modules.
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-ref/changes.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: Changes REST API
aliases:
- "/api-enterprise-api-ref-changes.html"
---

**Changes API** allows to track changes performed by CFEngine agent in the infrastructure.
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-ref/cmdb-api.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: CMDB API
aliases:
- "/api-enterprise-api-ref-cmdb-api.html"
---

The configuration management database (CMDB) API enables you to manage classes and variables for specific hosts.
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-ref/export-import-api.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: Import & export API
aliases:
- "/api-enterprise-api-ref-export-import-api.html"
---

Import & export API provides users the ability to transfer Mission Portal data between hubs.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: Import & export compliance report API
aliases:
- "/api-enterprise-api-ref-export-import-compliance-report-api.html"
---

This provides users the ability to transfer compliance reports between hubs or create reports from a JSON definition file.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: Federated reporting configuration API
aliases:
- "/api-enterprise-api-ref-federated-reporting-api.html"
---

This API is used for configuring hubs so that a single hub can be used to report on any host connected to participating feeder hubs.
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-ref/file-changes.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: File changes API
aliases:
- "/api-enterprise-api-ref-file-changes.html"
---

## File changes statistics
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-ref/first-time-setup.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: Fist time setup API
aliases:
- "/api-enterprise-api-ref-first-time-setup.html"
---

The First time setup API enables creation of the initial administrator user.
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-ref/health-diagnostic.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: Health diagnostic API
aliases:
- "/api-enterprise-api-ref-health-diagnostic.html"
---

This API provides access to health diagnostic information.
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-ref/host.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: Host REST API
aliases:
- "/api-enterprise-api-ref-host.html"
---

Host API allows to access host specific information.
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-ref/inventory.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: Inventory API
aliases:
- "/api-enterprise-api-ref-inventory.html"
---

Inventory API allows to access inventory reports and attributes dictionary.
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-ref/ldap-api.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: LDAP authentication API
aliases:
- "/api-enterprise-api-ref-ldap-api.html"
---

LDAP authentication API allows to check ldap user credentials and change LDAP settings.
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-ref/personal-groups.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: Personal groups API
aliases:
- "/api-enterprise-api-ref-personal-groups.html"
---

The personal groups API enables creating host groups based on host filters (the same ones used in inventory reports).
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-ref/query.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: Query REST API
aliases:
- "/api-enterprise-api-ref-query.html"
---

In case of a need for full flexibility, Query API allow users to execute SQL queries on CFEngine Database.
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-ref/reset-password.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: Reset password API
aliases:
- "/api-enterprise-api-ref-reset-password.html"
---

## Request reset password link and token
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-ref/shared-groups.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: Shared groups API
aliases:
- "/api-enterprise-api-ref-shared-groups.html"
---

The shared groups API enables creating host groups based on host filters (the same ones used in inventory) and assigning CMDB data to them.
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-ref/sql-schema/_index.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: SQL schema
aliases:
- "/api-enterprise-api-ref-sql-schema.html"
---

CFEngine Enterprise uses multiple databases.
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-ref/sql-schema/cfdb.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: cfdb
aliases:
- "/api-enterprise-api-ref-sql-schema-cfdb.html"
---

CFEngine allows standardized SQL `SELECT` queries to be used with [REST API][Query REST API#Execute SQL query].
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-ref/sql-schema/cfmp.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: cfmp
aliases:
- "/api-enterprise-api-ref-sql-schema-cfmp.html"
---

This database contains Mission Portal related settings not processed by the API.
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-ref/sql-schema/cfsettings.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: cfsettings
aliases:
- "/api-enterprise-api-ref-sql-schema-cfsettings.html"
---

Settings used by Mission Portal APIs, no reported data.
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-ref/ssh-keys-api.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: SSH keys API
aliases:
- "/api-enterprise-api-ref-ssh-keys-api.html"
---

The SSH keys API enables you to generate a key pair that can be used for authorization.
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-ref/status-settings.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: Status and settings REST API
aliases:
- "/api-enterprise-api-ref-status-settings.html"
---

REST API for managing settings, checking hub status.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: Two-factor authentication API
aliases:
- "/api-enterprise-api-ref-two-factor-authentication.html"
---

The Two-factor authentication API enables users to add an extra layer of security to their accounts
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-ref/users-rbac.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: Users and access-control REST API
aliases:
- "/api-enterprise-api-ref-users-rbac.html"
---

This REST API allows to manage users allowed to use Mission Portal as also Role Based Access Control settings.
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-ref/vcs-settings.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: VCS settings API
aliases:
- "/api-enterprise-api-ref-vcs-settings.html"
---

VCS API for managing version control repository settings.
Expand Down
2 changes: 2 additions & 0 deletions content/api/enterprise-api-ref/web-rbac.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
layout: default
title: Web RBAC API
aliases:
- "/api-enterprise-api-ref-web-rbac.html"
---

Web RBAC API for managing role based access control settings.
Expand Down
2 changes: 2 additions & 0 deletions content/enterprise-cfengine-guide/_index.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ layout: default
title: CFEngine Enterprise
published: false
sorting: 3
aliases:
- "/enterprise-cfengine-guide.html"
---

CFEngine Enterprise is an IT automation platform that uses a model-based approach to manage your infrastructure, and applications at WebScale while providing best-in-class scalability, security, enterprise-wide visibility and control.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ layout: default
title: Install and get started
published: false
sorting: 10
aliases:
- "/enterprise-cfengine-guide-install-get-started.html"
---

<!--
Expand Down
2 changes: 2 additions & 0 deletions content/examples/_index.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
layout: default
title: Examples and tutorials
sorting: 60
aliases:
- "/examples.html"
---

## Links to examples
Expand Down
2 changes: 2 additions & 0 deletions content/examples/example-snippets/_index.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
layout: default
title: Example snippets
sorting: 1
aliases:
- "/examples-example-snippets.html"
---

- [General examples][General examples]
Expand Down
2 changes: 2 additions & 0 deletions content/examples/example-snippets/active_directory.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
layout: default
title: Interacting with directory services
sorting: 7
aliases:
- "/examples-example-snippets-active_directory.html"
---

## Active directory example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
layout: default
title: File and directory examples
sorting: 6
aliases:
- "/examples-example-snippets-basic-file-directory.html"
---

- [Create files and directories][File and directory examples#Create files and directories]
Expand Down
Loading