Resource Type: mcx

NOTE: This page was generated from the Puppet source code on 2018-08-28 06:48:02 -0700

mcx

Description

MCX object management using DirectoryService on OS X.

The default provider of this type merely manages the XML plist as reported by the dscl -mcxexport command. This is similar to the content property of the file type in Puppet.

The recommended method of using this type is to use Work Group Manager to manage users and groups on the local computer, record the resulting puppet manifest using the command puppet resource mcx, then deploy it to other machines.

Autorequires: If Puppet is managing the user, group, or computer that these MCX settings refer to, the MCX resource will autorequire that user, group, or computer.

Attributes

mcx { 'resource title':
  name     => # (namevar) The name of the resource being managed. The...
  ensure   => # Create or remove the MCX setting.  Valid values...
  content  => # The XML Plist used as the value of MCXSettings...
  ds_name  => # The name to attach the MCX Setting to. (For...
  ds_type  => # The DirectoryService type this MCX setting...
  provider => # The specific backend to use for this `mcx...
  # ...plus any applicable metaparameters.
}

name

(Namevar: If omitted, this attribute’s value defaults to the resource’s title.)

The name of the resource being managed. The default naming convention follows Directory Service paths:

/Computers/localhost
/Groups/admin
/Users/localadmin

The ds_type and ds_name type parameters are not necessary if the default naming convention is followed.

(↑ Back to mcx attributes)

ensure

(Property: This attribute represents concrete state on the target system.)

Create or remove the MCX setting.

Allowed values:

  • present
  • absent

(↑ Back to mcx attributes)

content

(Property: This attribute represents concrete state on the target system.)

The XML Plist used as the value of MCXSettings in DirectoryService. This is the standard output from the system command:

dscl localhost -mcxexport /Local/Default/<ds_type>/ds_name

Note that ds_type is capitalized and plural in the dscl command.

Requires features manages_content.

(↑ Back to mcx attributes)

ds_name

The name to attach the MCX Setting to. (For example, localhost when ds_type => computer.) This setting is not required, as it can be automatically discovered when the resource name is parseable. (For example, in /Groups/admin, group will be used as the dstype.)

(↑ Back to mcx attributes)

ds_type

The DirectoryService type this MCX setting attaches to.

Allowed values:

  • user
  • group
  • computer
  • computerlist

(↑ Back to mcx attributes)

provider

The specific backend to use for this mcx resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.

Available providers are:

(↑ Back to mcx attributes)

Providers

mcxcontent

MCX Settings management using DirectoryService on OS X.

This provider manages the entire MCXSettings attribute available to some directory services nodes. This management is ‘all or nothing’ in that discrete application domain key value pairs are not managed by this provider.

It is recommended to use WorkGroup Manager to configure Users, Groups, Computers, or ComputerLists, then use ‘ralsh mcx’ to generate a puppet manifest from the resulting configuration.

Original Author: Jeff McCune (mccune.jeff@gmail.com)

  • Required binaries: /usr/bin/dscl
  • Confined to: operatingsystem == darwin
  • Default for: operatingsystem == darwin
  • Supported features: manages_content

Provider Features

Available features:

  • manages_content — The provider can manage MCXSettings as a string.

Provider support:

Provider manages content
mcxcontent X

NOTE: This page was generated from the Puppet source code on 2018-08-28 06:48:02 -0700