'\" t
.\"     Title: ocf_heartbeat_gcp-vpc-move-vip
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 03/13/2024
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.13.0-1+b1
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_GCP\-V" "7" "03/13/2024" "resource-agents 4.13.0-1+b1" "OCF resource agents"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ocf_heartbeat_gcp-vpc-move-vip \- Floating IP Address or Range on Google Cloud Platform
.SH "SYNOPSIS"
.HP \w'\fBgcp\-vpc\-move\-vip\fR\ 'u
\fBgcp\-vpc\-move\-vip\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
Floating IP Address or Range on Google Cloud Platform \- Using Alias IP address functionality to attach a secondary IP range to a running instance
.SH "SUPPORTED PARAMETERS"
.PP
\fBalias_ip\fR
.RS 4
IP range to be added including CIDR netmask (e\&.g\&., 192\&.168\&.0\&.1/32)
.sp
(unique, required, string, no default)
.RE
.PP
\fBalias_range_name\fR
.RS 4
Subnet name for the Alias IP
.sp
(optional, string, no default)
.RE
.PP
\fBhostlist\fR
.RS 4
List of hosts in the cluster, separated by spaces
.sp
(optional, string, no default)
.RE
.PP
\fBproject\fR
.RS 4
Project ID of the instance\&. It can be useful to set this attribute if the instance is in a shared service project\&. Otherwise, the agent should be able to determine the project ID automatically\&.
.sp
(optional, string, default "default")
.RE
.PP
\fBserviceaccount\fR
.RS 4
Path to Service account JSON file
.sp
(optional, string, no default)
.RE
.PP
\fBstackdriver_logging\fR
.RS 4
If enabled (set to true), IP failover logs will be posted to stackdriver logging
.sp
(optional, boolean, default
false)
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 300s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 15s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 15s\&. Suggested interval: 60s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 15s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 15s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a gcp\-vpc\-move\-vip resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_gcp\-vpc\-move\-vip ocf:heartbeat:gcp\-vpc\-move\-vip \e
  params \e
    alias_ip=\fIstring\fR \e
  op monitor timeout="15s" interval="60s" depth="0" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a gcp\-vpc\-move\-vip resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_gcp\-vpc\-move\-vip ocf:heartbeat:gcp\-vpc\-move\-vip \e
  alias_ip=\fIstring\fR \e
  op monitor timeout="15s" interval="60s" OCF_CHECK_LEVEL="0" 
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\m[blue]\fB\%http://clusterlabs.org/\fR\m[]
.SH "AUTHOR"
.PP
\fBClusterLabs contributors (see the resource agent source for information about individual authors)\fR