SharePoint Server agent attribute definitions
Prev Introducing the VCS agent for SharePoint Server 2013 Next

SharePoint Server agent attribute definitions

Review the tables of required and optional attributes to familiarize yourself with the agent attributes for a SharePointServer resource type. This information will assist you during the agent configuration.

Table: SharePoint Server agent required attributes

Required Attributes

Definition

AppType

Defines whether the agent is configured to monitor a SharePoint Web Application, Service Application, or service.

This attribute can take one of the following values:

  • WebApp

  • ServiceApp

  • SPSService

The default value is WebApp.

If this attribute value is set to WebApp or ServiceApp, then you must specify a value for the AppName attribute.

If this attribute value is set to SPSService, the AppName attribute value is ignored.

Type and Dimension: string-scalar

AppPoolMon

Defines the monitoring modes for the application pool associated with the Web site being monitored.

Configure this attribute only if AppType attribute value is set to WebApp and IIS is configured to run in the Worker Process Isolation mode.

The attribute can take one of the following values:

  • NONE: Indicates that the agent does not monitor the application pool associated with the Web site.

  • DEFAULT: Indicates that the agent monitors the root application pool associated with the Web site. If this attribute is set, the agent starts, stops, and monitors the root application pool associated with the Web site. If the root application pool is stopped externally, the service group faults; the agent then attempts to restart the root application pool.

  • ALL: Indicates that the agent starts all the application pools associated with the Web site, but monitors and stops the root application pool only. If any application pool is stopped externally, the service group faults; the agent then attempts to restart the application pool.

The default value is NONE.

Type and Dimension: string-scalar

ServiceIDList

Defines the service IDs of the SharePoint services that are managed by the agent. This attribute is always local.

This attribute can take the following values:

  • If AppType attribute value is set to WebApp, specify the service ID of the Microsoft SharePoint Foundation Web Application service.

  • If AppType attribute value is set to ServiceApp, specify the service ID of the service on which the Service Application depends.

  • If AppType attribute value is set to SPSService, specify the service IDs of the SharePoint services.

Note:

If you are configuring this attribute manually, use the VCS hadiscover command or the SharePoint server cmdlets to retrieve the service IDs.

Type and Dimension: string-vector

Table: SharePoint Server agent optional attributes

Optional Attribute

Definition

AppName

The name of the SharePoint Web Application or Service Application that is managed by the agent. The value of this attribute depends on the value of the AppType attribute.

This attribute can take the following values:

  • If AppType attribute value is set as WebApp, specify the Web Application name.

  • If AppType attribute value is set as ServiceApp, specify the application pool ID for the SharePoint Service Application.

Note:

This attribute is ignored if AppType attribute value is set as SPSService.

Type and Dimension: string-scalar

Description

The display name of the service ID specified in the ServiceIDList attribute

Type and Dimension: string-scalar

FarmAdminAccount

A user account that has the SharePoint Server Farm Admin privileges.

User name can be of the form

username@domain.com, domain\username, or

domain.com\username.

The agent uses the Farm Admin user account context to manage the services specified in the ServiceIDList attribute value.

Type and Dimension: string-scalar

FarmAdminPassword

The password of the user specified in the FarmAdminAccount attribute value.

The password is stored in the VCS configuration in an encrypted form.

Type and Dimension: string-scalar

StopSPSService

When a resource in the VCS cluster is taken offline:

  • If the value of this attribute is set to true, the agent stops all the SharePoint services in its ServiceIDList.

  • If the value of this attribute is set to false, the agent does not change the state of the SharePoint services in its ServiceIDList, but it stops monitoring the services.

The default value of this attribute is false.

Type and Dimension: boolean
Prev Up Next
SharePoint Server agent resource type definition Home Where to get more information