Puppetclasses

>>>

GET /api/puppetclasses
Elenca tutti gli ID delle classi puppet

GET /api/hosts/:host_id/puppetclasses
Elenca tutte le classi puppet per un host

GET /api/hostgroups/:hostgroup_id/puppetclasses
Elenca tutte le classi puppet per un gruppo di host

GET /api/environments/:environment_id/puppetclasses
Elenca tutte le classi puppet per un ambiente

Esempi

GET /api/hosts/host636/puppetclasses
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": {
    "class19": [
      {
        "id": 1018350797,
        "name": "class19",
        "created_at": "2019-11-07T08:39:20.984Z",
        "updated_at": "2019-11-07T08:39:20.984Z"
      }
    ]
  }
}

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opzionale

Set the current organization context for the request

Validations:

  • Must be a Integer
host_id
opzionale

ID host

Validations:

  • Must be a String
hostgroup_id
opzionale

ID gruppo di host

Validations:

  • Must be a String
environment_id
opzionale

ID dell’ambiente

Validations:

  • Must be a String
search
opzionale

filtra i risultati

Validations:

  • Must be a String
order
opzionale

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
opzionale

Numero pagina, iniziando da 1

Validations:

  • Must be a number.
per_page
opzionale

Numero di risultati per pagina da ritornare

Validations:

  • Must be a number.

Search fields

Field name Tipo Possible values
config_group string
environment string
host string
hostgroup string
key string
location string
name string
organization string
>>>

GET /api/puppetclasses/:id
Mostra una classe puppet

GET /api/hosts/:host_id/puppetclasses/:id
Mostra una classe Puppet per un host

GET /api/hostgroups/:hostgroup_id/puppetclasses/:id
Mostra una classe Puppet per un gruppo di host

GET /api/environments/:environment_id/puppetclasses/:id
Mostra una classe puppet per un ambiente

Esempi

GET /api/environments/production/puppetclasses/980190962
200
{
  "created_at": "2019-11-07 08:39:06 UTC",
  "updated_at": "2019-11-07 08:39:06 UTC",
  "id": 980190962,
  "name": "base",
  "module_name": "base",
  "environments": [
    {
      "name": "production",
      "id": 334344675
    }
  ],
  "hostgroups": [
    {
      "id": 636252244,
      "name": "Common",
      "title": "Common",
      "description": null
    }
  ],
  "smart_variables": [
    {
      "variable": "bool_test",
      "id": 638205575
    },
    {
      "variable": "ssl_port",
      "id": 298486374
    }
  ],
  "smart_class_parameters": [
    {
      "parameter": "cluster",
      "id": 328495940
    }
  ]
}

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opzionale

Set the current organization context for the request

Validations:

  • Must be a Integer
host_id
opzionale

ID host

Validations:

  • Must be a String
hostgroup_id
opzionale

ID gruppo di host

Validations:

  • Must be a String
environment_id
opzionale

ID dell’ambiente

Validations:

  • Must be a String
id
richiesto

ID della classe del puppet

Validations:

  • Must be a String
>>>

POST /api/puppetclasses
Crea classe puppet

Esempi

POST /api/puppetclasses
{
  "puppetclass": {
    "name": "test_puppetclass",
    "lookup_keys_attributes": [
      {
        "key": "smart_variable1"
      }
    ]
  }
}
201
{
  "created_at": "2019-11-07 08:39:20 UTC",
  "updated_at": "2019-11-07 08:39:20 UTC",
  "id": 1018350796,
  "name": "test_puppetclass",
  "module_name": "test_puppetclass",
  "environments": [],
  "hostgroups": [],
  "smart_variables": [
    {
      "variable": "smart_variable1",
      "id": 1018350796
    }
  ],
  "smart_class_parameters": []
}

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opzionale

Set the current organization context for the request

Validations:

  • Must be a Integer
puppetclass
richiesto

Validations:

  • Must be a Hash
puppetclass[name]
richiesto

Validations:

  • Must be a String
>>>

PUT /api/puppetclasses/:id
Aggiorna una classe puppet

Esempi

PUT /api/puppetclasses/980190962-base
{
  "puppetclass": {
    "name": "test_puppetclass"
  }
}
200
{
  "created_at": "2019-11-07 08:39:06 UTC",
  "updated_at": "2019-11-07 08:39:21 UTC",
  "id": 980190962,
  "name": "test_puppetclass",
  "module_name": "test_puppetclass",
  "environments": [
    {
      "name": "production",
      "id": 334344675
    }
  ],
  "hostgroups": [
    {
      "id": 636252244,
      "name": "Common",
      "title": "Common",
      "description": null
    }
  ],
  "smart_variables": [
    {
      "variable": "bool_test",
      "id": 638205575
    },
    {
      "variable": "ssl_port",
      "id": 298486374
    }
  ],
  "smart_class_parameters": [
    {
      "parameter": "cluster",
      "id": 328495940
    }
  ]
}

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opzionale

Set the current organization context for the request

Validations:

  • Must be a Integer
id
richiesto

Validations:

  • Must be a String
puppetclass
richiesto

Validations:

  • Must be a Hash
puppetclass[name]
opzionale

Validations:

  • Must be a String
>>>

DELETE /api/puppetclasses/:id
Cancella una classe puppet

Esempi

DELETE /api/puppetclasses/980190962-base
{
  "puppetclass": {}
}
200
{
  "id": 980190962,
  "name": "base",
  "created_at": "2019-11-07T08:39:06.354Z",
  "updated_at": "2019-11-07T08:39:06.354Z"
}

Parametri

Nome parametro Descrizione
location_id
opzionale

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
opzionale

Set the current organization context for the request

Validations:

  • Must be a Integer
id
richiesto

Validations:

  • Must be a String