pacemaker  2.1.4-dc6eb4362
Scalable High-Availability cluster resource manager
Data Fields
svc_action_s Struct Reference

Object for executing external actions. More...

#include <include/crm/services.h>

Collaboration diagram for svc_action_s:
Collaboration graph
[legend]

Data Fields

char * id
 
char * rsc
 XML ID of resource being executed for resource actions, otherwise NULL. More...
 
char * action
 Name of action being executed for resource actions, otherwise NULL. More...
 
guint interval_ms
 Action interval for recurring resource actions, otherwise 0. More...
 
char * standard
 Resource standard for resource actions, otherwise NULL. More...
 
char * provider
 Resource provider for resource actions that require it, otherwise NULL. More...
 
char * agent
 Resource agent name for resource actions, otherwise NULL. More...
 
int timeout
 Action timeout (in milliseconds) More...
 
GHashTable * params
 
int rc
 Exit status of action (set by library upon completion) More...
 
int status
 Execution status (enum pcmk_exec_status set by library) More...
 
int sequence
 
enum svc_action_flags flags
 Flag group of enum svc_action_flags. More...
 
char * stderr_data
 Action stderr (set by library) More...
 
char * stdout_data
 Action stdout (set by library) More...
 
void * cb_data
 For caller's use (not used by library) More...
 
svc_action_private_topaque
 This field should be treated as internal to Pacemaker. More...
 
int pid
 
int cancel
 
int expected_rc
 
int synchronous
 

Detailed Description

Object for executing external actions.

Note
This object should never be instantiated directly, but instead created using one of the constructor functions (resources_action_create() for resource agents, services_alert_create() for alert agents, or services_action_create_generic() for generic executables). Similarly, do not use sizeof() on this struct.

Definition at line 121 of file services.h.

Field Documentation

◆ action

char* svc_action_s::action

Name of action being executed for resource actions, otherwise NULL.

Definition at line 131 of file services.h.

◆ agent

char* svc_action_s::agent

Resource agent name for resource actions, otherwise NULL.

Definition at line 143 of file services.h.

◆ cancel

int svc_action_s::cancel

This field should be treated as internal to Pacemaker

Definition at line 159 of file services.h.

◆ cb_data

void* svc_action_s::cb_data

For caller's use (not used by library)

Definition at line 178 of file services.h.

◆ expected_rc

int svc_action_s::expected_rc

This field should be treated as internal to Pacemaker

Definition at line 171 of file services.h.

◆ flags

enum svc_action_flags svc_action_s::flags

Flag group of enum svc_action_flags.

Definition at line 175 of file services.h.

◆ id

char* svc_action_s::id

Operation key (<resource>_<action>_<interval>) for resource actions, XML ID for alert actions, or NULL for generic actions

Definition at line 125 of file services.h.

◆ interval_ms

guint svc_action_s::interval_ms

Action interval for recurring resource actions, otherwise 0.

Definition at line 134 of file services.h.

◆ opaque

svc_action_private_t* svc_action_s::opaque

This field should be treated as internal to Pacemaker.

Definition at line 181 of file services.h.

◆ params

GHashTable* svc_action_s::params

A hash table of name/value pairs to use as parameters for resource and alert actions, otherwise NULL. These will be used to set environment variables for non-fencing resource agents and alert agents, and to send stdin to fence agents.

Definition at line 152 of file services.h.

◆ pid

int svc_action_s::pid

This field should be treated as internal to Pacemaker

Definition at line 158 of file services.h.

◆ provider

char* svc_action_s::provider

Resource provider for resource actions that require it, otherwise NULL.

Definition at line 140 of file services.h.

◆ rc

int svc_action_s::rc

Exit status of action (set by library upon completion)

Definition at line 154 of file services.h.

◆ rsc

char* svc_action_s::rsc

XML ID of resource being executed for resource actions, otherwise NULL.

Definition at line 128 of file services.h.

◆ sequence

int svc_action_s::sequence

Action counter (set by library for resource actions, or by caller otherwise)

Definition at line 167 of file services.h.

◆ standard

char* svc_action_s::standard

Resource standard for resource actions, otherwise NULL.

Definition at line 137 of file services.h.

◆ status

int svc_action_s::status

Execution status (enum pcmk_exec_status set by library)

Definition at line 162 of file services.h.

◆ stderr_data

char* svc_action_s::stderr_data

Action stderr (set by library)

Definition at line 176 of file services.h.

◆ stdout_data

char* svc_action_s::stdout_data

Action stdout (set by library)

Definition at line 177 of file services.h.

◆ synchronous

int svc_action_s::synchronous

This field should be treated as internal to Pacemaker

Definition at line 172 of file services.h.

◆ timeout

int svc_action_s::timeout

Action timeout (in milliseconds)

Definition at line 145 of file services.h.


The documentation for this struct was generated from the following file: